REFERENCE MANUAL
#include <hps.h>
Public Member Functions | |
bool | Equals (GlyphElement const &in_that) const |
GlyphElement () | |
GlyphElement (GlyphElement const &in_that) | |
GlyphElement (GlyphElement &&in_that) | |
Type | ObjectType () const |
bool | operator!= (GlyphElement const &in_that) const |
GlyphElement & | operator= (GlyphElement &&in_that) |
GlyphElement & | operator= (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 |
![]() | |
virtual bool | Empty () const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (Type in_mask) const |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
Type | Type () const |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
The GlyphElement class is a user space object. It is the base class for all glyph elements.
GlyphElement::GlyphElement | ( | ) |
The default constructor creates an empty GlyphElement object.
GlyphElement::GlyphElement | ( | GlyphElement const & | in_that | ) |
The copy constructor creates a new GlyphElement object that contains the same settings as the source GlyphElement.
in_that | The source GlyphElement to copy. |
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.
in_that | An rvalue reference to a GlyphElement to take the impl from. |
bool GlyphElement::Equals | ( | GlyphElement const & | in_that | ) | const |
Check if the source GlyphElement is equivalent to this GlyphElement.
in_that | The source GlyphElement to compare to this GlyphElement. |
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from Object.
Reimplemented in InfiniteLineGlyphElement, CircularArcGlyphElement, EllipseGlyphElement, DotGlyphElement, and LineGlyphElement.
bool GlyphElement::operator!= | ( | GlyphElement const & | in_that | ) | const |
Check if the source GlyphElement is not equivalent to this GlyphElement.
in_that | The source GlyphElement to compare to this GlyphElement. |
GlyphElement& GlyphElement::operator= | ( | GlyphElement && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this GlyphElement thereby avoiding a copy.
in_that | An rvalue reference to a GlyphElement to take the impl from. |
GlyphElement& GlyphElement::operator= | ( | GlyphElement const & | in_that | ) |
Copies the source GlyphElement into this GlyphElement.
in_that | The source GlyphElement to copy. |
bool GlyphElement::operator== | ( | GlyphElement const & | in_that | ) | const |
Check if the source GlyphElement is equivalent to this GlyphElement.
in_that | The source GlyphElement to compare to this GlyphElement. |
void GlyphElement::Set | ( | GlyphElement const & | in_that | ) |
Copies the source GlyphElement into this GlyphElement.
in_that | The source GlyphElement to copy. |
void GlyphElement::SetExplicitColor | ( | RGBAColor const & | in_color | ) |
Sets the RGBA color for this GlyphElement.
in_color | The color for this GlyphElement. |
void GlyphElement::SetFill | ( | Glyph::Fill | in_fill | ) |
Sets the fill mode for this GlyphElement.
in_fill | The fill mode for this GlyphElement. |
void GlyphElement::SetIndexedColor | ( | byte | in_index | ) |
Sets the color index for this GlyphElement.
in_index | The color index for this GlyphElement. |
void GlyphElement::SetNormalColor | ( | ) |
Sets that this GlyphElement should inherit the color of the owning geometry which uses the glyph.
bool GlyphElement::ShowColor | ( | Glyph::ColorSource & | out_source, |
byte & | out_index, | ||
RGBAColor & | out_color | ||
) | const |
Shows the color for this GlyphElement.
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. |
bool GlyphElement::ShowFill | ( | Glyph::Fill & | out_fill | ) | const |
Shows the fill mode for this GlyphElement.
out_fill | The fill mode for this GlyphElement. |