#include <hps.h>
|
static const HPS::Type | staticType = HPS::Type::LineShapeElement |
|
static const HPS::Type | staticType = HPS::Type::ShapeElement |
|
static const HPS::Type | staticType = HPS::Type::None |
|
|
template<typename T > |
static intptr_t | ClassID () |
|
The LineShapeElement class is a user space object. It is used to define line elements to make up shapes for text backgrounds.
◆ LineShapeElement() [1/7]
HPS::LineShapeElement::LineShapeElement |
( |
| ) |
|
◆ LineShapeElement() [2/7]
HPS::LineShapeElement::LineShapeElement |
( |
ShapeElement const & |
in_that | ) |
|
This constructor creates a LineShapeElement 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 line shape element. Otherwise the copy will fail and the resulting LineShapeElement will be invalid.
- Parameters
-
◆ LineShapeElement() [3/7]
◆ LineShapeElement() [4/7]
HPS::LineShapeElement::LineShapeElement |
( |
ShapePointArray const & |
in_points | ) |
|
|
explicit |
This constructor creates a LineShapeElement with the specified points.
- Parameters
-
in_points | The points making up the line. |
◆ LineShapeElement() [5/7]
HPS::LineShapeElement::LineShapeElement |
( |
size_t |
in_count, |
|
|
ShapePoint const |
in_points[] |
|
) |
| |
This constructor creates a LineShapeElement with the specified points.
- Parameters
-
in_count | Size of the following array. |
in_points | The points for the line. |
◆ LineShapeElement() [6/7]
This constructor creates a two-point LineShapeElement with the specified points.
- Parameters
-
in_start | The start of the line. |
in_end | The end of the line. |
◆ LineShapeElement() [7/7]
The move constructor creates a LineShapeElement by transferring the underlying impl of the rvalue reference to this LineShapeElement thereby avoiding a copy and allocation.
- Parameters
-
◆ ObjectType()
HPS::Type HPS::LineShapeElement::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 LineShapeElement thereby avoiding a copy.
- Parameters
-
- Returns
- A reference to this LineShapeElement.
◆ SetPoints() [1/2]
LineShapeElement& HPS::LineShapeElement::SetPoints |
( |
ShapePointArray const & |
in_points | ) |
|
Sets the points for this LineShapeElement.
- Parameters
-
in_points | The points making up the line. |
◆ SetPoints() [2/2]
Sets the points for this LineShapeElement.
- Parameters
-
in_count | The size of the following array. |
in_points | The points making up the line. |
◆ ShowPoints()
bool HPS::LineShapeElement::ShowPoints |
( |
ShapePointArray & |
out_points | ) |
const |
Shows the points for this LineShapeElement.
- Parameters
-
out_points | The points for this line |
- Returns
- true if points were set, false otherwise.
The documentation for this class was generated from the following file: