HPS::EllipseGlyphElement Class Reference

#include <hps.h>

Inheritance diagram for HPS::EllipseGlyphElement:
HPS::GlyphElement HPS::Object

Public Member Functions

 EllipseGlyphElement ()
 
 EllipseGlyphElement (GlyphElement const &in_that)
 
 EllipseGlyphElement (EllipseGlyphElement const &in_that)
 
 EllipseGlyphElement (GlyphPoint const &in_lower_left, GlyphPoint const &in_upper_right)
 
 EllipseGlyphElement (EllipseGlyphElement &&in_that)
 
HPS::Type ObjectType () const
 
EllipseGlyphElementoperator= (EllipseGlyphElement &&in_that)
 
void SetLowerLeft (GlyphPoint const &in_point)
 
void SetPoints (GlyphPoint const &in_lower_left, GlyphPoint const &in_upper_right)
 
void SetUpperRight (GlyphPoint const &in_point)
 
bool ShowLowerLeft (GlyphPoint &out_point) const
 
bool ShowUpperRight (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::EllipseGlyphElement
 
- 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 EllipseGlyphElement class is a user space object. It is used to add ellipse elements to glyphs.

Constructor & Destructor Documentation

◆ EllipseGlyphElement() [1/5]

HPS::EllipseGlyphElement::EllipseGlyphElement ( )

The default constructor creates an empty EllipseGlyphElement object.

◆ EllipseGlyphElement() [2/5]

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

This constructor creates a EllipseGlyphElement 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 an ellipse glyph element. Otherwise the copy will fail and the resulting EllipseGlyphElement will be invalid.

Parameters
in_thatThe source GlyphElement to copy.

◆ EllipseGlyphElement() [3/5]

HPS::EllipseGlyphElement::EllipseGlyphElement ( EllipseGlyphElement const &  in_that)

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

Parameters
in_thatThe source EllipseGlyphElement to copy.

◆ EllipseGlyphElement() [4/5]

HPS::EllipseGlyphElement::EllipseGlyphElement ( GlyphPoint const &  in_lower_left,
GlyphPoint const &  in_upper_right 
)

This constructor creates a EllipseGlyphElement with the lower left and upper right points for the bounding box which circumscribes the ellipse.

Parameters
in_lower_leftThe lower left point for the bounding box which circumscribes the ellipse.
in_upper_rightThe upper right point for the bounding box which circumscribes the ellipse.

◆ EllipseGlyphElement() [5/5]

HPS::EllipseGlyphElement::EllipseGlyphElement ( EllipseGlyphElement &&  in_that)

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

Parameters
in_thatAn rvalue reference to an EllipseGlyphElement to take the impl from.

Member Function Documentation

◆ ObjectType()

HPS::Type HPS::EllipseGlyphElement::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=()

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

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

Parameters
in_thatAn rvalue reference to an EllipseGlyphElement to take the impl from.
Returns
A reference to this EllipseGlyphElement.

◆ SetLowerLeft()

void HPS::EllipseGlyphElement::SetLowerLeft ( GlyphPoint const &  in_point)

Sets the lower left point for the bounding box which circumscribes the ellipse for this EllipseGlyphElement.

Parameters
in_pointThe lower left point for the bounding box which circumscribes the ellipse.

◆ SetPoints()

void HPS::EllipseGlyphElement::SetPoints ( GlyphPoint const &  in_lower_left,
GlyphPoint const &  in_upper_right 
)

Sets the lower left and upper right points for the bounding box which circumscribes the ellipse for this EllipseGlyphElement.

Parameters
in_lower_leftThe lower left point for the bounding box which circumscribes the ellipse.
in_upper_rightThe upper right point for the bounding box which circumscribes the ellipse.

◆ SetUpperRight()

void HPS::EllipseGlyphElement::SetUpperRight ( GlyphPoint const &  in_point)

Sets the upper right point for the bounding box which circumscribes the ellipse for this EllipseGlyphElement.

Parameters
in_pointThe upper right point for the bounding box which circumscribes the ellipse.

◆ ShowLowerLeft()

bool HPS::EllipseGlyphElement::ShowLowerLeft ( GlyphPoint out_point) const

Shows the lower left point for the bounding box which circumscribes the ellipse for this EllipseGlyphElement.

Parameters
out_pointThe lower left point for the bounding box which circumscribes the ellipse.
Returns
true if a lower left point was set, false otherwise.

◆ ShowUpperRight()

bool HPS::EllipseGlyphElement::ShowUpperRight ( GlyphPoint out_point) const

Shows the upper right point for the bounding box which circumscribes the ellipse for this EllipseGlyphElement.

Parameters
out_pointThe upper right point for the bounding box which circumscribes the ellipse.
Returns
true if an upper right point was set, false otherwise.

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