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

inline virtual HPS::Type ObjectType() const

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).

Returns

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

SolidLinePatternElement &operator=(SolidLinePatternElement &&in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this SolidLinePatternElement thereby avoiding a copy.

Parameters

in_that – An rvalue reference to a SolidLinePatternElement to take the impl from.

Returns

A reference to this SolidLinePatternElement.

void SetColor(RGBAColor const &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.

Parameters

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.

Parameters

in_color – The color for this SolidLinePatternElement.

bool ShowColor(Material::Type &out_type, RGBAColor &out_color, float &out_index) const

Shows the color for this SolidLinePatternElement.

Parameters

  • out_type – Indicates which of the following arguments is valid.

  • out_color – The color of this SolidLinePatternElement. This is only valid if out_type is Material::Type::RGBAColor.

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

Returns

true if a color was set, false otherwise.

SolidLinePatternElement()

The default constructor creates an empty SolidLinePatternElement object.

SolidLinePatternElement(float in_size, LinePattern::SizeUnits in_units)

This constructor creates a SolidLinePatternElement with a given size.

Parameters
SolidLinePatternElement(LinePatternElement const &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.

Parameters

in_that – The source LinePatternElement to copy.

SolidLinePatternElement(SolidLinePatternElement &&in_that)

The move constructor creates a SolidLinePatternElement by transferring the underlying impl of the rvalue reference to this SolidLinePatternElement thereby avoiding a copy and allocation.

Parameters

in_that – An rvalue reference to a SolidLinePatternElement to take the impl from.

SolidLinePatternElement(SolidLinePatternElement const &in_that)

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

Parameters

in_that – The source SolidLinePatternElement to copy.

~SolidLinePatternElement()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::SolidLinePatternElement