HPS::DotGlyphElement Class Reference

#include <hps.h>

Inheritance diagram for HPS::DotGlyphElement:
HPS::GlyphElement HPS::Object

Public Member Functions

 DotGlyphElement ()
 
 DotGlyphElement (GlyphElement const &in_that)
 
 DotGlyphElement (DotGlyphElement const &in_that)
 
 DotGlyphElement (GlyphPoint const &in_point)
 
 DotGlyphElement (DotGlyphElement &&in_that)
 
HPS::Type ObjectType () const
 
DotGlyphElementoperator= (DotGlyphElement &&in_that)
 
void SetPoint (GlyphPoint const &in_point)
 
bool ShowPoint (GlyphPoint &out_point) const
 
- Public Member Functions inherited from HPS::GlyphElement
bool Equals (GlyphElement const &in_that) const
 
 GlyphElement ()
 
 GlyphElement (GlyphElement const &in_that)
 
 GlyphElement (GlyphElement &&in_that)
 
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::DotGlyphElement
 
- Static Public Attributes inherited from HPS::GlyphElement
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 DotGlyphElement class is a user space object. It is used to dot elements to glyphs.

Constructor & Destructor Documentation

◆ DotGlyphElement() [1/5]

HPS::DotGlyphElement::DotGlyphElement ( )

The default constructor creates an empty DotGlyphElement object.

◆ DotGlyphElement() [2/5]

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

This constructor creates a DotGlyphElement object that contains the same settings as the source GlyphElement. The copy will only be successful if the source glyph element is really an upcast of a dot glyph element. Otherwise the copy will fail and the resulting DotGlyphElement will be invalid.

Parameters
in_thatThe source GlyphElement to copy.

◆ DotGlyphElement() [3/5]

HPS::DotGlyphElement::DotGlyphElement ( DotGlyphElement const &  in_that)

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

Parameters
in_thatThe source DotGlyphElement to copy.

◆ DotGlyphElement() [4/5]

HPS::DotGlyphElement::DotGlyphElement ( GlyphPoint const &  in_point)
explicit

This constructor creates a DotGlyphElement with the specified point.

Parameters
in_pointThe point for the dot.

◆ DotGlyphElement() [5/5]

HPS::DotGlyphElement::DotGlyphElement ( DotGlyphElement &&  in_that)

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

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

Member Function Documentation

◆ ObjectType()

HPS::Type HPS::DotGlyphElement::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::GlyphElement.

◆ operator=()

DotGlyphElement& HPS::DotGlyphElement::operator= ( DotGlyphElement &&  in_that)

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

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

◆ SetPoint()

void HPS::DotGlyphElement::SetPoint ( GlyphPoint const &  in_point)

Sets the point for this DotGlyphElement.

Parameters
in_pointThe point for the dot.

◆ ShowPoint()

bool HPS::DotGlyphElement::ShowPoint ( GlyphPoint out_point) const

Shows the point for this DotGlyphElement.

Parameters
out_pointThe point for the dot.
Returns
true if a point was set, false otherwise.

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