#include <hps.h>
Public Member Functions | |
SolidLinePatternElement () | |
SolidLinePatternElement (LinePatternElement const &in_that) | |
SolidLinePatternElement (SolidLinePatternElement const &in_that) | |
SolidLinePatternElement (float in_size, LinePattern::SizeUnits in_units) | |
SolidLinePatternElement (SolidLinePatternElement &&in_that) | |
SolidLinePatternElement & | operator= (SolidLinePatternElement &&in_that) |
HPS::Type | ObjectType () const |
void | SetColor (RGBAColor const &in_color) |
void | SetMaterialByIndex (float in_material_index) |
bool | ShowColor (Material::Type &out_type, RGBAColor &out_color, float &out_index) const |
![]() | |
LinePatternElement () | |
LinePatternElement (LinePatternElement const &in_that) | |
LinePatternElement (LinePatternElement &&in_that) | |
LinePatternElement & | operator= (LinePatternElement &&in_that) |
void | Set (LinePatternElement const &in_that) |
LinePatternElement & | operator= (LinePatternElement const &in_that) |
bool | Equals (LinePatternElement const &in_that) const |
bool | operator== (LinePatternElement const &in_that) const |
bool | operator!= (LinePatternElement const &in_that) const |
void | SetSize (float in_size, LinePattern::SizeUnits in_units) |
bool | ShowSize (float &out_size, LinePattern::SizeUnits &out_units) const |
![]() | |
Object & | operator= (Object const &other_object) |
Object (Object &&in_that) | |
Object & | operator= (Object &&in_that) |
HPS::Type | Type () const |
virtual bool | Empty () const |
virtual void | Reset () |
bool | HasType (HPS::Type in_mask) const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
The SolidLinePatternElement class is a user space object. It is used for specifying solid elements within a line pattern.
HPS::SolidLinePatternElement::SolidLinePatternElement | ( | ) |
The default constructor creates an empty SolidLinePatternElement object.
HPS::SolidLinePatternElement::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.
in_that | The source LinePatternElement to copy. |
HPS::SolidLinePatternElement::SolidLinePatternElement | ( | SolidLinePatternElement const & | in_that | ) |
The copy constructor creates a new SolidLinePatternElement object that contains the same settings as the source SolidLinePatternElement.
in_that | The source SolidLinePatternElement to copy. |
HPS::SolidLinePatternElement::SolidLinePatternElement | ( | float | in_size, |
LinePattern::SizeUnits | in_units | ||
) |
This constructor creates a SolidLinePatternElement with a given size.
in_size | The length of the SolidLinePatternElement. |
in_units | The units for the length of the SolidLinePatternElement. |
HPS::SolidLinePatternElement::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.
in_that | An rvalue reference to a SolidLinePatternElement to take the impl from. |
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS::LinePatternElement.
SolidLinePatternElement& HPS::SolidLinePatternElement::operator= | ( | SolidLinePatternElement && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this SolidLinePatternElement thereby avoiding a copy.
in_that | An rvalue reference to a SolidLinePatternElement to take the impl from. |
void HPS::SolidLinePatternElement::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.
in_color | The color for this SolidLinePatternElement. |
void HPS::SolidLinePatternElement::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.
in_color | The color for this SolidLinePatternElement. |
bool HPS::SolidLinePatternElement::ShowColor | ( | Material::Type & | out_type, |
RGBAColor & | out_color, | ||
float & | out_index | ||
) | const |
Shows the color for this SolidLinePatternElement.
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::ExplicitRGBAColor. |
out_index | The material index for this SolidLinePatternElement. This is only valid if out_type is Material::Type::MaterialIndex. |