GlyphElement

class HPS::GlyphElement : public HPS::Object

The GlyphElement class is a user space object. It is the base class for all glyph elements.

Subclassed by HPS::CircularArcGlyphElement, HPS::DotGlyphElement, HPS::EllipseGlyphElement, HPS::ImageGlyphElement, HPS::InfiniteLineGlyphElement, HPS::LineGlyphElement, HPS::SphereGlyphElement

Public Functions

bool Equals(GlyphElement const &in_that) const

Check if the source GlyphElement is equivalent to this GlyphElement.

Parameters

in_that – The source GlyphElement to compare to this GlyphElement.

Returns

true if the objects are equivalent, false otherwise.

GlyphElement()

The default constructor creates an empty GlyphElement object.

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_that – An rvalue reference to a GlyphElement to take the impl from.

GlyphElement(GlyphElement const &in_that)

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

Parameters

in_that – The source GlyphElement to copy.

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.

bool operator!=(GlyphElement const &in_that) const

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

Parameters

in_that – The source GlyphElement to compare to this GlyphElement.

Returns

true if the objects are not equivalent, false otherwise.

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_that – An rvalue reference to a GlyphElement to take the impl from.

Returns

A reference to this GlyphElement.

GlyphElement &operator=(GlyphElement const &in_that)

Copies the source GlyphElement into this GlyphElement.

Parameters

in_that – The source GlyphElement to copy.

Returns

A reference to this GlyphElement.

bool operator==(GlyphElement const &in_that) const

Check if the source GlyphElement is equivalent to this GlyphElement.

Parameters

in_that – The source GlyphElement to compare to this GlyphElement.

Returns

true if the objects are equivalent, false otherwise.

void Set(GlyphElement const &in_that)

Copies the source GlyphElement into this GlyphElement.

Parameters

in_that – The source GlyphElement to copy.

void SetExplicitColor(RGBAColor const &in_color)

Sets the RGBA color for this GlyphElement.

Parameters

in_color – The color for this GlyphElement.

void SetFill(Glyph::Fill in_fill)

Sets the fill mode for this GlyphElement.

Parameters

in_fill – The fill mode for this GlyphElement.

void SetIndexedColor(byte in_index)

Sets the color index for this GlyphElement.

Parameters

in_index – The color index for this GlyphElement.

void SetNormalColor()

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

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

Shows the color for this GlyphElement.

Parameters

• out_source – The color source for this GlyphElement.

• out_index – The color index for this GlyphElement. This is only valid if out_source is Glyph::ColorSource::Indexed.

• out_color – The 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 ShowFill(Glyph::Fill &out_fill) const

Shows the fill mode for this GlyphElement.

Parameters

out_fill – The fill mode for this GlyphElement.

Returns

true if a fill mode was set, false otherwise.

virtual ~GlyphElement()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::GlyphElement