#include <hps.h>

Inheritance diagram for HPS::ShapeElement:
HPS::Object HPS::AnchorShapeElement HPS::CircleShapeElement HPS::CircularArcShapeElement HPS::EllipseShapeElement HPS::EllipticalArcShapeElement HPS::LeaderLineClippingElement HPS::LineShapeElement HPS::PolygonShapeElement

Public Member Functions

bool Equals (ShapeElement const &in_that) const
 
HPS::Type ObjectType () 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::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 ShapeElement class is a user space object. It is the base class for all shape elements.

Constructor & Destructor Documentation

◆ ShapeElement() [1/3]

HPS::ShapeElement::ShapeElement ( )

The default constructor creates an empty ShapeElement object.

◆ ShapeElement() [2/3]

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

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

Parameters
in_thatThe source ShapeElement to copy.

◆ ShapeElement() [3/3]

HPS::ShapeElement::ShapeElement ( ShapeElement &&  in_that)

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

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

Member Function Documentation

◆ Equals()

bool HPS::ShapeElement::Equals ( ShapeElement const &  in_that) const

Check if the source ShapeElement is equivalent to this ShapeElement.

Parameters
in_thatThe source ShapeElement to compare to this ShapeElement.
Returns
true if the objects are equivalent, false otherwise.

◆ ObjectType()

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

Reimplemented in HPS::LineShapeElement, HPS::AnchorShapeElement, HPS::LeaderLineClippingElement, HPS::CircularArcShapeElement, HPS::EllipticalArcShapeElement, HPS::CircleShapeElement, HPS::EllipseShapeElement, and HPS::PolygonShapeElement.

◆ operator!=()

bool HPS::ShapeElement::operator!= ( ShapeElement const &  in_that) const

Check if the source ShapeElement is not equivalent to this ShapeElement.

Parameters
in_thatThe source ShapeElement to compare to this ShapeElement.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

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

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

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

◆ operator=() [2/2]

ShapeElement& HPS::ShapeElement::operator= ( ShapeElement const &  in_that)

Copies the source ShapeElement into this ShapeElement.

Parameters
in_thatThe source ShapeElement to copy.
Returns
A reference to this ShapeElement.

◆ operator==()

bool HPS::ShapeElement::operator== ( ShapeElement const &  in_that) const

Check if the source ShapeElement is equivalent to this ShapeElement.

Parameters
in_thatThe source ShapeElement to compare to this ShapeElement.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

void HPS::ShapeElement::Set ( ShapeElement const &  in_that)

Copies the source ShapeElement into this ShapeElement.

Parameters
in_thatThe source ShapeElement to copy.

◆ SetDisjointed()

ShapeElement& HPS::ShapeElement::SetDisjointed ( bool  in_state)

Sets the disjointed state for this ShapeElement. Two shape elements of the same type are automatically joined together if they appear consecutively in the shape element array. LineShapeElement objects are always disjointed.

Parameters
in_stateThe disjointed state for this ShapeElement.

◆ SetFill()

ShapeElement& HPS::ShapeElement::SetFill ( bool  in_state)

Sets the fill mode for this ShapeElement. All shape elements default to being filled, except for Lines which cannot be filled.

Parameters
in_stateThe fill mode for this ShapeElement.

◆ ShowDisjointed()

bool HPS::ShapeElement::ShowDisjointed ( bool &  out_state) const

Shows the disjointed state for this ShapeElement. Two shape elements of the same type are automatically joined together if they appear consecutively in the shape element array. LineShapeElement objects are always disjointed.

Parameters
out_stateWhether this shape element will be disjointed from the previous one.
Returns
true if a disjointed state was set, false otherwise.

◆ ShowFill()

bool HPS::ShapeElement::ShowFill ( bool &  out_state) const

Shows the fill mode for this ShapeElement. All shape elements default to being filled, except for Lines which cannot be filled.

Parameters
out_stateWhether faces are drawn for this shape element.
Returns
true if a fill mode was set, false otherwise.

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