API Search || Global Search

#include <hps.h>

Inheritance diagram for HPS::GlyphElement:
HPS::Object HPS::CircularArcGlyphElement HPS::DotGlyphElement HPS::EllipseGlyphElement HPS::InfiniteLineGlyphElement HPS::LineGlyphElement HPS::SphereGlyphElement

Public Member Functions

bool Equals (GlyphElement const &in_that) const
 
 GlyphElement ()
 
 GlyphElement (GlyphElement const &in_that)
 
 GlyphElement (GlyphElement &&in_that)
 
HPS::Type ObjectType () const
 
bool operator!= (GlyphElement const &in_that) const
 
GlyphElementoperator= (GlyphElement &&in_that)
 
GlyphElementoperator= (GlyphElement const &in_that)
 
bool operator== (GlyphElement const &in_that) const
 
void Set (GlyphElement const &in_that)
 
void SetExplicitColor (RGBAColor const &in_color)
 
void SetFill (Glyph::Fill in_fill)
 
void SetIndexedColor (byte in_index)
 
void SetNormalColor ()
 
bool ShowColor (Glyph::ColorSource &out_source, byte &out_index, RGBAColor &out_color) const
 
bool ShowFill (Glyph::Fill &out_fill) 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::GlyphElement
 
- 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 GlyphElement class is a user space object. It is the base class for all glyph elements.

Constructor & Destructor Documentation

HPS::GlyphElement::GlyphElement ( )

The default constructor creates an empty GlyphElement object.

HPS::GlyphElement::GlyphElement ( GlyphElement const &  in_that)

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

Parameters
in_thatThe source GlyphElement to copy.
HPS::GlyphElement::GlyphElement ( GlyphElement &&  in_that)

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

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

Member Function Documentation

bool HPS::GlyphElement::Equals ( GlyphElement const &  in_that) const

Check if the source GlyphElement is equivalent to this GlyphElement.

Parameters
in_thatThe source GlyphElement to compare to this GlyphElement.
Returns
true if the objects are equivalent, false otherwise.
bool HPS::GlyphElement::operator!= ( GlyphElement const &  in_that) const

Check if the source GlyphElement is not equivalent to this GlyphElement.

Parameters
in_thatThe source GlyphElement to compare to this GlyphElement.
Returns
true if the objects are not equivalent, false otherwise.
GlyphElement& HPS::GlyphElement::operator= ( GlyphElement &&  in_that)

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

Parameters
in_thatAn rvalue reference to a GlyphElement to take the impl from.
Returns
A reference to this GlyphElement.
GlyphElement& HPS::GlyphElement::operator= ( GlyphElement const &  in_that)

Copies the source GlyphElement into this GlyphElement.

Parameters
in_thatThe source GlyphElement to copy.
Returns
A reference to this GlyphElement.
bool HPS::GlyphElement::operator== ( GlyphElement const &  in_that) const

Check if the source GlyphElement is equivalent to this GlyphElement.

Parameters
in_thatThe source GlyphElement to compare to this GlyphElement.
Returns
true if the objects are equivalent, false otherwise.
void HPS::GlyphElement::Set ( GlyphElement const &  in_that)

Copies the source GlyphElement into this GlyphElement.

Parameters
in_thatThe source GlyphElement to copy.
void HPS::GlyphElement::SetExplicitColor ( RGBAColor const &  in_color)

Sets the RGBA color for this GlyphElement.

Parameters
in_colorThe color for this GlyphElement.
void HPS::GlyphElement::SetFill ( Glyph::Fill  in_fill)

Sets the fill mode for this GlyphElement.

Parameters
in_fillThe fill mode for this GlyphElement.
void HPS::GlyphElement::SetIndexedColor ( byte  in_index)

Sets the color index for this GlyphElement.

Parameters
in_indexThe color index for this GlyphElement.
void HPS::GlyphElement::SetNormalColor ( )

Sets that this GlyphElement should inherit the color of the owning geometry which uses the glyph.

bool HPS::GlyphElement::ShowColor ( Glyph::ColorSource out_source,
byte &  out_index,
RGBAColor out_color 
) const

Shows the color for this GlyphElement.

Parameters
out_sourceThe color source for this GlyphElement.
out_indexThe color index for this GlyphElement. This is only valid if out_source is Glyph::ColorSource::Indexed.
out_colorThe color for this GlyphElement. This is only valid if out_source is Glyph::ColorSource::Explicit.
Returns
true if a color was set, false otherwise.
bool HPS::GlyphElement::ShowFill ( Glyph::Fill out_fill) const

Shows the fill mode for this GlyphElement.

Parameters
out_fillThe fill mode for this GlyphElement.
Returns
true if a fill mode was set, false otherwise.

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