#include <hps.h>
|
static const HPS::Type | staticType = HPS::Type::AnchorShapeElement |
|
static const HPS::Type | staticType = HPS::Type::ShapeElement |
|
static const HPS::Type | staticType = HPS::Type::None |
|
|
template<typename T > |
static intptr_t | ClassID () |
|
The AnchorShapeElement class is a user space object. It is used to define anchor elements to make up shapes for text backgrounds. Anchor points are point to which text leader lines connect. If no anchor elements are defined, all ShapePoints used to construct the shape will be used as anchor points. If at least one anchor point is defined, only explicitly defined anchor points will be used.
◆ AnchorShapeElement() [1/6]
HPS::AnchorShapeElement::AnchorShapeElement |
( |
| ) |
|
◆ AnchorShapeElement() [2/6]
HPS::AnchorShapeElement::AnchorShapeElement |
( |
ShapeElement const & |
in_that | ) |
|
This constructor creates a AnchorShapeElement 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 an anchor shape element. Otherwise the copy will fail and the resulting AnchorShapeElement will be invalid.
- Parameters
-
◆ AnchorShapeElement() [3/6]
◆ AnchorShapeElement() [4/6]
HPS::AnchorShapeElement::AnchorShapeElement |
( |
ShapePoint const & |
in_anchor_point | ) |
|
|
explicit |
This constructor creates a AnchorShapeElement with the specified anchor point.
- Parameters
-
in_anchor_point | The anchor point. |
◆ AnchorShapeElement() [5/6]
HPS::AnchorShapeElement::AnchorShapeElement |
( |
ShapePoint const & |
in_anchor_point, |
|
|
ShapePointArray const & |
in_intermediate_points, |
|
|
bool |
in_connection |
|
) |
| |
|
explicit |
This constructor creates a AnchorShapeElement with the specified parameters.
- Parameters
-
in_anchor_point | The anchor point. |
in_intermediate_points | Intermediate points between the leader line and the anchor point |
in_connection | Whether the first intermediate point is connected to the anchor point by a line. |
◆ AnchorShapeElement() [6/6]
The move constructor creates a AnchorShapeElement by transferring the underlying impl of the rvalue reference to this AnchorShapeElement thereby avoiding a copy and allocation.
- Parameters
-
◆ ObjectType()
HPS::Type HPS::AnchorShapeElement::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 AnchorShapeElement thereby avoiding a copy.
- Parameters
-
- Returns
- A reference to this AnchorShapeElement.
◆ SetAnchor()
◆ SetConnection()
Sets the connection setting for this AnchorShapeElement.
- Parameters
-
in_connection | Whether the first intermediate point connects to the anchor point. |
◆ SetIntermediatePoints()
AnchorShapeElement& HPS::AnchorShapeElement::SetIntermediatePoints |
( |
ShapePointArray const & |
in_intermediate_points | ) |
|
Sets the intermediate points for this AnchorShapeElement.
- Parameters
-
in_intermediate_points | The points between the anchor and the leader line. |
◆ ShowAnchor()
bool HPS::AnchorShapeElement::ShowAnchor |
( |
ShapePoint & |
out_anchor | ) |
const |
Shows the anchor for this AnchorShapeElement.
- Parameters
-
out_anchor | The anchor point. |
- Returns
- true if an anchor point was set, false otherwise.
◆ ShowConnection()
bool HPS::AnchorShapeElement::ShowConnection |
( |
bool & |
out_connection | ) |
const |
Shows the connection setting for this AnchorShapeElement.
- Parameters
-
out_connection | Whether the first intermediate point connects to the anchor point. |
- Returns
- true if a connection setting was set, false otherwise.
◆ ShowIntermediatePoints()
bool HPS::AnchorShapeElement::ShowIntermediatePoints |
( |
ShapePointArray & |
out_intermediate_points | ) |
const |
Shows the intermediate points for this AnchorShapeElement.
- Parameters
-
out_intermediate_points | The points between the anchor point and the leader line. |
- Returns
- true if intermediate points were set, false otherwise.
◆ UnsetConnection()
◆ UnsetIntermediatePoints()
The documentation for this class was generated from the following file: