#include <hps.h>

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 |
CircularArcShapeElement & | operator= (CircularArcShapeElement &&in_that) |
CircularArcShapeElement & | SetEndPoint (ShapePoint const &in_end) |
CircularArcShapeElement & | SetMiddlePoint (ShapePoint const &in_middle) |
CircularArcShapeElement & | SetStartPoint (ShapePoint const &in_start) |
bool | ShowEndPoint (ShapePoint &out_end) const |
bool | ShowMiddlePoint (ShapePoint &out_middle) const |
bool | ShowStartPoint (ShapePoint &out_start) const |
![]() | |
bool | Equals (ShapeElement const &in_that) const |
bool | operator!= (ShapeElement const &in_that) const |
ShapeElement & | operator= (ShapeElement &&in_that) |
ShapeElement & | operator= (ShapeElement const &in_that) |
bool | operator== (ShapeElement const &in_that) const |
void | Set (ShapeElement const &in_that) |
ShapeElement & | SetDisjointed (bool in_state) |
ShapeElement & | SetFill (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 |
![]() | |
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) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
virtual HPS::Type | Type () const |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::CircularArcShapeElement |
![]() | |
static const HPS::Type | staticType = HPS::Type::ShapeElement |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
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
HPS::CircularArcShapeElement::CircularArcShapeElement | ( | ) |
The default constructor creates an empty CircularArcShapeElement object.
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_that The source ShapeElement to copy.
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_that The source CircularArcShapeElement to copy.
|
explicit |
This constructor creates a CircularArcShapeElement with the specified parameters.
- Parameters
-
in_start_point The start of the arc. in_middle_point A point between the start and the end point, where the arc passes through in_end_point The end of the arc.
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_that An rvalue reference to a CircularArcShapeElement to take the impl from.
Member Function Documentation
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_that An rvalue reference to a CircularArcShapeElement to take the impl from.
- Returns
- A reference to this CircularArcShapeElement.
CircularArcShapeElement& HPS::CircularArcShapeElement::SetEndPoint | ( | ShapePoint const & | in_end | ) |
Sets the end point for this CircularArcShapeElement.
- Parameters
-
in_end The end point of the arc.
CircularArcShapeElement& HPS::CircularArcShapeElement::SetMiddlePoint | ( | ShapePoint const & | in_middle | ) |
Sets the minor axis point for this CircularArcShapeElement.
- Parameters
-
in_middle A point between the start and the end point. The arc passes through this point.
CircularArcShapeElement& HPS::CircularArcShapeElement::SetStartPoint | ( | ShapePoint const & | in_start | ) |
Sets the center point for this CircularArcShapeElement.
- Parameters
-
in_start The start of the arc.
bool HPS::CircularArcShapeElement::ShowEndPoint | ( | ShapePoint & | out_end | ) | const |
Shows the end point for this CircularArcShapeElement.
- Parameters
-
out_end The end point of the arc
- Returns
- true if an end point was set, false otherwise.
bool HPS::CircularArcShapeElement::ShowMiddlePoint | ( | ShapePoint & | out_middle | ) | const |
Shows the middle point for this CircularArcShapeElement.
- Parameters
-
out_middle A point between the start and the end point. The arc passes through this point.
- Returns
- true if a middle point was set, false otherwise.
bool HPS::CircularArcShapeElement::ShowStartPoint | ( | ShapePoint & | out_start | ) | const |
Shows the center point for this CircularArcShapeElement.
- Parameters
-
out_start The 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:
- include/hps.h