#include <hps.h>
|
static const HPS::Type | staticType = HPS::Type::CircleShapeElement |
|
static const HPS::Type | staticType = HPS::Type::ShapeElement |
|
static const HPS::Type | staticType = HPS::Type::None |
|
|
template<typename T > |
static intptr_t | ClassID () |
|
The CircleShapeElement class is a user space object. It is used to define circle elements to make up shapes for text backgrounds.
◆ CircleShapeElement() [1/5]
HPS::CircleShapeElement::CircleShapeElement |
( |
| ) |
|
◆ CircleShapeElement() [2/5]
HPS::CircleShapeElement::CircleShapeElement |
( |
ShapeElement const & |
in_that | ) |
|
This constructor creates a CircleShapeElement 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 circle shape element. Otherwise the copy will fail and the resulting CircleShapeElement will be invalid.
- Parameters
-
◆ CircleShapeElement() [3/5]
◆ CircleShapeElement() [4/5]
HPS::CircleShapeElement::CircleShapeElement |
( |
ShapePoint const & |
in_center, |
|
|
ShapePoint const & |
in_radius |
|
) |
| |
|
explicit |
This constructor creates a CircleShapeElement with the specified center and radius points.
- Parameters
-
in_center | The center point of the circle. |
in_radius | The radius of the circle. |
◆ CircleShapeElement() [5/5]
The move constructor creates a CircleShapeElement by transferring the underlying impl of the rvalue reference to this CircleShapeElement thereby avoiding a copy and allocation.
- Parameters
-
◆ ObjectType()
HPS::Type HPS::CircleShapeElement::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=()
The move assignment operator transfers the underlying impl of the rvalue reference to this CircleShapeElement thereby avoiding a copy.
- Parameters
-
- Returns
- A reference to this CircleShapeElement.
◆ SetCenter()
Sets the center point for this CircleShapeElement.
- Parameters
-
in_center | The center point of the circle. |
◆ SetRadius()
Sets the radius point for this CircleShapeElement.
- Parameters
-
in_radius | The radius point of the circle. |
◆ ShowCenter()
bool HPS::CircleShapeElement::ShowCenter |
( |
ShapePoint & |
out_center | ) |
const |
Shows the center point for this CircleShapeElement.
- Parameters
-
out_center | The center point for the circle. |
- Returns
- true if a center point was set, false otherwise.
◆ ShowRadius()
bool HPS::CircleShapeElement::ShowRadius |
( |
ShapePoint & |
out_radius | ) |
const |
Shows the radius point for this CircleShapeElement.
- Parameters
-
out_radius | The radius point for the circle. |
- Returns
- true if a radius was set, false otherwise.
The documentation for this class was generated from the following file: