SolidLinePatternElement

class HPS.SolidLinePatternElement : public HPS.LinePatternElement

The SolidLinePatternElement class is a user space object. It is used for specifying solid elements within a line pattern.

Public Functions

override void Dispose ()

override HPS.Type ObjectType ()

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Return

The declared type of the object in question, which may differ from the true, underlying type.

void SetColor (HPS.RGBAColor in_color)

Sets the color for this SolidLinePatternElement. If this is not set, this SolidLinePatternElement will take the effective line (or edge) color in the segment where the line (or edge) pattern is used.

Param in_color

The color for this SolidLinePatternElement.

void SetMaterialByIndex (float in_material_index)

Sets the color (by material index) for this SolidLinePatternElement. If this is not set, this SolidLinePatternElement will take the effective line (or edge) color in the segment where the line (or edge) pattern is used.

bool ShowColor (out HPS.Material.Type out_type, out HPS.RGBAColor out_color, out float out_index)

Shows the color for this SolidLinePatternElement.

Param out_type

Indicates which of the following arguments is valid.

Param out_color

The color of this SolidLinePatternElement. This is only valid if out_type is Material.Type.RGBAColor.

Param out_index

The material index for this SolidLinePatternElement. This is only valid if out_type is Material.Type.MaterialIndex.

Return

true if a color was set, false otherwise.

SolidLinePatternElement ()

The default constructor creates an empty SolidLinePatternElement object.

SolidLinePatternElement (float in_size, HPS.LinePattern.SizeUnits in_units)

This constructor creates a SolidLinePatternElement with a given size.

Param in_size

The length of the SolidLinePatternElement.

Param in_units

The units for the length of the SolidLinePatternElement.

SolidLinePatternElement (HPS.LinePatternElement in_that)

This constructor creates a SolidLinePatternElement object that contains the same settings as the source LinePatternElement. The copy will only be successful if the source line pattern element is really an upcast of a solid line pattern element. Otherwise the copy will fail and the resulting SolidLinePatternElement will be invalid.

Param in_that

The source LinePatternElement to copy.

SolidLinePatternElement (HPS.SolidLinePatternElement in_that)

The copy constructor creates a new SolidLinePatternElement object that contains the same settings as the source SolidLinePatternElement.

Param in_that

The source SolidLinePatternElement to copy.