HPS::CircularArcShapeElement Class Reference

#include <hps.h>

Inheritance diagram for HPS::CircularArcShapeElement:
HPS::ShapeElement HPS::Object

Public Member Functions

 CircularArcShapeElement ()
 
 CircularArcShapeElement (ShapeElement const &in_that)
 
 CircularArcShapeElement (CircularArcShapeElement const &in_that)
 
 CircularArcShapeElement (ShapePoint const &in_start_point, ShapePoint const &in_middle_point, ShapePoint const &in_end_point)
 
 CircularArcShapeElement (CircularArcShapeElement &&in_that)
 
HPS::Type ObjectType () const
 
CircularArcShapeElementoperator= (CircularArcShapeElement &&in_that)
 
CircularArcShapeElementSetEndPoint (ShapePoint const &in_end)
 
CircularArcShapeElementSetMiddlePoint (ShapePoint const &in_middle)
 
CircularArcShapeElementSetStartPoint (ShapePoint const &in_start)
 
bool ShowEndPoint (ShapePoint &out_end) const
 
bool ShowMiddlePoint (ShapePoint &out_middle) const
 
bool ShowStartPoint (ShapePoint &out_start) 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::CircularArcShapeElement
 
- 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 CircularArcShapeElement class is a user space object. It is used to define circular arc elements to make up shapes for text backgrounds.

Constructor & Destructor Documentation

◆ CircularArcShapeElement() [1/5]

HPS::CircularArcShapeElement::CircularArcShapeElement ( )

The default constructor creates an empty CircularArcShapeElement object.

◆ CircularArcShapeElement() [2/5]

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

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

Parameters
in_thatThe source ShapeElement to copy.

◆ CircularArcShapeElement() [3/5]

HPS::CircularArcShapeElement::CircularArcShapeElement ( CircularArcShapeElement const &  in_that)

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

Parameters
in_thatThe source CircularArcShapeElement to copy.

◆ CircularArcShapeElement() [4/5]

HPS::CircularArcShapeElement::CircularArcShapeElement ( ShapePoint const &  in_start_point,
ShapePoint const &  in_middle_point,
ShapePoint const &  in_end_point 
)
explicit

This constructor creates a CircularArcShapeElement with the specified parameters.

Parameters
in_start_pointThe start of the arc.
in_middle_pointA point between the start and the end point, where the arc passes through
in_end_pointThe end of the arc.

◆ CircularArcShapeElement() [5/5]

HPS::CircularArcShapeElement::CircularArcShapeElement ( CircularArcShapeElement &&  in_that)

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

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

Member Function Documentation

◆ ObjectType()

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

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

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

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

◆ SetEndPoint()

CircularArcShapeElement& HPS::CircularArcShapeElement::SetEndPoint ( ShapePoint const &  in_end)

Sets the end point for this CircularArcShapeElement.

Parameters
in_endThe end point of the arc.

◆ SetMiddlePoint()

CircularArcShapeElement& HPS::CircularArcShapeElement::SetMiddlePoint ( ShapePoint const &  in_middle)

Sets the minor axis point for this CircularArcShapeElement.

Parameters
in_middleA point between the start and the end point. The arc passes through this point.

◆ SetStartPoint()

CircularArcShapeElement& HPS::CircularArcShapeElement::SetStartPoint ( ShapePoint const &  in_start)

Sets the center point for this CircularArcShapeElement.

Parameters
in_startThe start of the arc.

◆ ShowEndPoint()

bool HPS::CircularArcShapeElement::ShowEndPoint ( ShapePoint out_end) const

Shows the end point for this CircularArcShapeElement.

Parameters
out_endThe end point of the arc
Returns
true if an end point was set, false otherwise.

◆ ShowMiddlePoint()

bool HPS::CircularArcShapeElement::ShowMiddlePoint ( ShapePoint out_middle) const

Shows the middle point for this CircularArcShapeElement.

Parameters
out_middleA point between the start and the end point. The arc passes through this point.
Returns
true if a middle point was set, false otherwise.

◆ ShowStartPoint()

bool HPS::CircularArcShapeElement::ShowStartPoint ( ShapePoint out_start) const

Shows the center point for this CircularArcShapeElement.

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

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