HPS::CircularArcGlyphElement Class Reference

#include <hps.h>

Inheritance diagram for HPS::CircularArcGlyphElement:
HPS::GlyphElement HPS::Object

Public Member Functions

 CircularArcGlyphElement ()
 
 CircularArcGlyphElement (GlyphElement const &in_that)
 
 CircularArcGlyphElement (CircularArcGlyphElement const &in_that)
 
 CircularArcGlyphElement (GlyphPoint const &in_start, GlyphPoint const &in_intermediate, GlyphPoint const &in_end)
 
 CircularArcGlyphElement (CircularArcGlyphElement &&in_that)
 
HPS::Type ObjectType () const
 
CircularArcGlyphElementoperator= (CircularArcGlyphElement &&in_that)
 
void SetEndPoint (GlyphPoint const &in_point)
 
void SetIntermediatePoint (GlyphPoint const &in_point)
 
void SetPoints (GlyphPoint const &in_start, GlyphPoint const &in_intermediate, GlyphPoint const &in_end)
 
void SetStartPoint (GlyphPoint const &in_point)
 
bool ShowEndPoint (GlyphPoint &out_point) const
 
bool ShowIntermediatePoint (GlyphPoint &out_point) const
 
bool ShowStartPoint (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::CircularArcGlyphElement
 
- 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 CircularArcGlyphElement class is a user space object. It is used to add circular arc elements to a glyph.

Constructor & Destructor Documentation

◆ CircularArcGlyphElement() [1/5]

HPS::CircularArcGlyphElement::CircularArcGlyphElement ( )

The default constructor creates an empty CircularArcGlyphElement object.

◆ CircularArcGlyphElement() [2/5]

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

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

Parameters
in_thatThe source GlyphElement to copy.

◆ CircularArcGlyphElement() [3/5]

HPS::CircularArcGlyphElement::CircularArcGlyphElement ( CircularArcGlyphElement const &  in_that)

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

Parameters
in_thatThe source CircularArcGlyphElement to copy.

◆ CircularArcGlyphElement() [4/5]

HPS::CircularArcGlyphElement::CircularArcGlyphElement ( GlyphPoint const &  in_start,
GlyphPoint const &  in_intermediate,
GlyphPoint const &  in_end 
)

This constructor creates a CircularArcGlyphElement with the specified start, intermediate, and end points.

Parameters
in_startThe start point for the circular arc.
in_intermediateThe intermediate point for the circular arc.
in_endThe end point for the circular arc.

◆ CircularArcGlyphElement() [5/5]

HPS::CircularArcGlyphElement::CircularArcGlyphElement ( CircularArcGlyphElement &&  in_that)

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

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

Member Function Documentation

◆ ObjectType()

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

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

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

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

◆ SetEndPoint()

void HPS::CircularArcGlyphElement::SetEndPoint ( GlyphPoint const &  in_point)

Sets the end point for the circular arc for this CircularArcGlyphElement.

Parameters
in_pointThe end point for the circular arc.

◆ SetIntermediatePoint()

void HPS::CircularArcGlyphElement::SetIntermediatePoint ( GlyphPoint const &  in_point)

Sets the intermediate point for the circular arc for this CircularArcGlyphElement.

Parameters
in_pointThe intermediate point for the circular arc.

◆ SetPoints()

void HPS::CircularArcGlyphElement::SetPoints ( GlyphPoint const &  in_start,
GlyphPoint const &  in_intermediate,
GlyphPoint const &  in_end 
)

Sets the start, intermediate, and end points for the circular arc for this CircularArcGlyphElement.

Parameters
in_pointThe start point for the circular arc.
in_pointThe intermediate point for the circular arc.
in_pointThe end point for the circular arc.

◆ SetStartPoint()

void HPS::CircularArcGlyphElement::SetStartPoint ( GlyphPoint const &  in_point)

Sets the start point for the circular arc for this CircularArcGlyphElement.

Parameters
in_pointThe start point for the circular arc.

◆ ShowEndPoint()

bool HPS::CircularArcGlyphElement::ShowEndPoint ( GlyphPoint out_point) const

Shows the end point for the circular arc for this CircularArcGlyphElement.

Parameters
out_pointThe end point for the circular arc.
Returns
true if an end point was set, false otherwise.

◆ ShowIntermediatePoint()

bool HPS::CircularArcGlyphElement::ShowIntermediatePoint ( GlyphPoint out_point) const

Shows the intermediate point for the circular arc for this CircularArcGlyphElement.

Parameters
out_pointThe intermediate point for the circular arc.
Returns
true if an intermediate point was set, false otherwise.

◆ ShowStartPoint()

bool HPS::CircularArcGlyphElement::ShowStartPoint ( GlyphPoint out_point) const

Shows the start point for the circular arc for this CircularArcGlyphElement.

Parameters
out_pointThe start point for the circular arc.
Returns
true if a start point was set, false otherwise.

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