HPS::SolidLinePatternElement Class Reference

#include <hps.h>

Inheritance diagram for HPS::SolidLinePatternElement:
HPS::LinePatternElement HPS::Object

Public Member Functions

HPS::Type ObjectType () const
 
SolidLinePatternElementoperator= (SolidLinePatternElement &&in_that)
 
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
 
 SolidLinePatternElement ()
 
 SolidLinePatternElement (LinePatternElement const &in_that)
 
 SolidLinePatternElement (SolidLinePatternElement const &in_that)
 
 SolidLinePatternElement (float in_size, LinePattern::SizeUnits in_units)
 
 SolidLinePatternElement (SolidLinePatternElement &&in_that)
 
- Public Member Functions inherited from HPS::LinePatternElement
bool Equals (LinePatternElement const &in_that) const
 
 LinePatternElement ()
 
 LinePatternElement (LinePatternElement const &in_that)
 
 LinePatternElement (LinePatternElement &&in_that)
 
bool operator!= (LinePatternElement const &in_that) const
 
LinePatternElementoperator= (LinePatternElement &&in_that)
 
LinePatternElementoperator= (LinePatternElement const &in_that)
 
bool operator== (LinePatternElement const &in_that) const
 
void Set (LinePatternElement const &in_that)
 
void SetSize (float in_size, LinePattern::SizeUnits in_units)
 
bool ShowSize (float &out_size, LinePattern::SizeUnits &out_units) const
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::SolidLinePatternElement
 
- Static Public Attributes inherited from HPS::LinePatternElement
static const HPS::Type staticType = HPS::Type::LinePatternElement
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Detailed Description

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

Constructor & Destructor Documentation

◆ SolidLinePatternElement() [1/5]

HPS::SolidLinePatternElement::SolidLinePatternElement ( )

The default constructor creates an empty SolidLinePatternElement object.

◆ SolidLinePatternElement() [2/5]

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.

Parameters
in_thatThe source LinePatternElement to copy.

◆ SolidLinePatternElement() [3/5]

HPS::SolidLinePatternElement::SolidLinePatternElement ( SolidLinePatternElement const &  in_that)

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

Parameters
in_thatThe source SolidLinePatternElement to copy.

◆ SolidLinePatternElement() [4/5]

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

This constructor creates a SolidLinePatternElement with a given size.

Parameters
in_sizeThe length of the SolidLinePatternElement.
in_unitsThe units for the length of the SolidLinePatternElement.

◆ SolidLinePatternElement() [5/5]

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.

Parameters
in_thatAn rvalue reference to a SolidLinePatternElement to take the impl from.

Member Function Documentation

◆ ObjectType()

HPS::Type HPS::SolidLinePatternElement::ObjectType ( ) const
inlinevirtual

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.

Reimplemented from HPS::LinePatternElement.

◆ operator=()

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.

Parameters
in_thatAn rvalue reference to a SolidLinePatternElement to take the impl from.
Returns
A reference to this SolidLinePatternElement.

◆ SetColor()

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.

Parameters
in_colorThe color for this SolidLinePatternElement.

◆ SetMaterialByIndex()

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.

Parameters
in_colorThe color for this SolidLinePatternElement.

◆ ShowColor()

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

Shows the color for this SolidLinePatternElement.

Parameters
out_typeIndicates which of the following arguments is valid.
out_colorThe color of this SolidLinePatternElement. This is only valid if out_type is Material::Type::RGBAColor.
out_indexThe 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.

The documentation for this class was generated from the following file: