HPS::LineGlyphElement Class Reference

#include <hps.h>

Inheritance diagram for HPS::LineGlyphElement:
HPS::GlyphElement HPS::Object

Public Member Functions

 LineGlyphElement ()
 
 LineGlyphElement (GlyphElement const &in_that)
 
 LineGlyphElement (LineGlyphElement const &in_that)
 
 LineGlyphElement (GlyphPointArray const &in_points)
 
 LineGlyphElement (size_t in_count, GlyphPoint const in_points[])
 
 LineGlyphElement (LineGlyphElement &&in_that)
 
HPS::Type ObjectType () const
 
LineGlyphElementoperator= (LineGlyphElement &&in_that)
 
void SetPoints (GlyphPointArray const &in_points)
 
void SetPoints (size_t in_count, GlyphPoint const in_points[])
 
bool ShowPoints (GlyphPointArray &out_points) 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::LineGlyphElement
 
- 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 LineGlyphElement class is a user space object.

Constructor & Destructor Documentation

◆ LineGlyphElement() [1/6]

HPS::LineGlyphElement::LineGlyphElement ( )

The default constructor creates an empty LineGlyphElement object.

◆ LineGlyphElement() [2/6]

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

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

Parameters
in_thatThe source GlyphElement to copy.

◆ LineGlyphElement() [3/6]

HPS::LineGlyphElement::LineGlyphElement ( LineGlyphElement const &  in_that)

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

Parameters
in_thatThe source LineGlyphElement to copy.

◆ LineGlyphElement() [4/6]

HPS::LineGlyphElement::LineGlyphElement ( GlyphPointArray const &  in_points)
explicit

This constructor creates a LineGlyphElement with the specified point array.

Parameters
in_pointsThe points for the line.

◆ LineGlyphElement() [5/6]

HPS::LineGlyphElement::LineGlyphElement ( size_t  in_count,
GlyphPoint const  in_points[] 
)

This constructor creates a LineGlyphElement with the specified point array.

Parameters
in_countSize of the following array.
in_pointsThe points for the line.

◆ LineGlyphElement() [6/6]

HPS::LineGlyphElement::LineGlyphElement ( LineGlyphElement &&  in_that)

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

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

Member Function Documentation

◆ ObjectType()

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

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

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

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

◆ SetPoints() [1/2]

void HPS::LineGlyphElement::SetPoints ( GlyphPointArray const &  in_points)

Sets the points for this LineGlyphElement.

Parameters
in_pointsThe points for the line.

◆ SetPoints() [2/2]

void HPS::LineGlyphElement::SetPoints ( size_t  in_count,
GlyphPoint const  in_points[] 
)

Sets the points for this LineGlyphElement.

Parameters
in_countSize of the following array.
in_pointsThe points for the line.

◆ ShowPoints()

bool HPS::LineGlyphElement::ShowPoints ( GlyphPointArray out_points) const

Shows the points for this LineGlyphElement.

Parameters
out_pointsThe points for the line.
Returns
true if points were set, false otherwise.

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