HPS::PolygonShapeElement Class Reference

#include <hps.h>

Inheritance diagram for HPS::PolygonShapeElement:
HPS::ShapeElement HPS::Object

Public Member Functions

HPS::Type ObjectType () const
 
PolygonShapeElementoperator= (PolygonShapeElement &&in_that)
 
 PolygonShapeElement ()
 
 PolygonShapeElement (ShapeElement const &in_that)
 
 PolygonShapeElement (PolygonShapeElement const &in_that)
 
 PolygonShapeElement (ShapePointArray const &in_points)
 
 PolygonShapeElement (size_t in_count, ShapePoint const in_points[])
 
 PolygonShapeElement (PolygonShapeElement &&in_that)
 
PolygonShapeElementSetPoints (ShapePointArray const &in_points)
 
PolygonShapeElementSetPoints (size_t in_count, ShapePoint const in_points[])
 
bool ShowPoints (ShapePointArray &out_points) const
 
- Public Member Functions inherited from HPS::ShapeElement
bool Equals (ShapeElement const &in_that) const
 
bool operator!= (ShapeElement const &in_that) const
 
ShapeElementoperator= (ShapeElement &&in_that)
 
ShapeElementoperator= (ShapeElement const &in_that)
 
bool operator== (ShapeElement const &in_that) const
 
void Set (ShapeElement const &in_that)
 
ShapeElementSetDisjointed (bool in_state)
 
ShapeElementSetFill (bool in_state)
 
 ShapeElement ()
 
 ShapeElement (ShapeElement const &in_that)
 
 ShapeElement (ShapeElement &&in_that)
 
bool ShowDisjointed (bool &out_state) const
 
bool ShowFill (bool &out_state) 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::PolygonShapeElement
 
- Static Public Attributes inherited from HPS::ShapeElement
static const HPS::Type staticType = HPS::Type::ShapeElement
 
- 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 PolygonShapeElement class is a user space object. It is used to define polygon elements to make up shapes for text backgrounds.

Constructor & Destructor Documentation

◆ PolygonShapeElement() [1/6]

HPS::PolygonShapeElement::PolygonShapeElement ( )

The default constructor creates an empty PolygonShapeElement object.

◆ PolygonShapeElement() [2/6]

HPS::PolygonShapeElement::PolygonShapeElement ( ShapeElement const &  in_that)

This constructor creates a PolygonShapeElement object that contains the same settings as the source ShapeElement. The copy will only be successful if the source shape element is really an upcast of a polygon shape element. Otherwise the copy will fail and the resulting PolygonShapeElement will be invalid.

Parameters
in_thatThe source ShapeElement to copy.

◆ PolygonShapeElement() [3/6]

HPS::PolygonShapeElement::PolygonShapeElement ( PolygonShapeElement const &  in_that)

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

Parameters
in_thatThe source PolygonShapeElement to copy.

◆ PolygonShapeElement() [4/6]

HPS::PolygonShapeElement::PolygonShapeElement ( ShapePointArray const &  in_points)
explicit

This constructor creates a PolygonShapeElement with the specified point array.

Parameters
in_pointsThe points for the polygon.

◆ PolygonShapeElement() [5/6]

HPS::PolygonShapeElement::PolygonShapeElement ( size_t  in_count,
ShapePoint const  in_points[] 
)

This constructor creates a PolygonShapeElement with the specified point array.

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

◆ PolygonShapeElement() [6/6]

HPS::PolygonShapeElement::PolygonShapeElement ( PolygonShapeElement &&  in_that)

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

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

Member Function Documentation

◆ ObjectType()

HPS::Type HPS::PolygonShapeElement::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::ShapeElement.

◆ operator=()

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

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

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

◆ SetPoints() [1/2]

PolygonShapeElement& HPS::PolygonShapeElement::SetPoints ( ShapePointArray const &  in_points)

Sets the points for this PolygonShapeElement.

Parameters
in_pointsThe points for the polygon.

◆ SetPoints() [2/2]

PolygonShapeElement& HPS::PolygonShapeElement::SetPoints ( size_t  in_count,
ShapePoint const  in_points[] 
)

Sets the points for this PolygonShapeElement.

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

◆ ShowPoints()

bool HPS::PolygonShapeElement::ShowPoints ( ShapePointArray &  out_points) const

Shows the points for this PolygonShapeElement.

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

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