#include <hps.h>

Public Member Functions | |
AnchorShapeElement () | |
AnchorShapeElement (ShapeElement const &in_that) | |
AnchorShapeElement (AnchorShapeElement const &in_that) | |
AnchorShapeElement (ShapePoint const &in_anchor_point) | |
AnchorShapeElement (ShapePoint const &in_anchor_point, ShapePointArray const &in_intermediate_points, bool in_connection) | |
AnchorShapeElement (AnchorShapeElement &&in_that) | |
HPS::Type | ObjectType () const |
AnchorShapeElement & | operator= (AnchorShapeElement &&in_that) |
AnchorShapeElement & | SetAnchor (ShapePoint const &in_anchor) |
AnchorShapeElement & | SetConnection (bool in_connection) |
AnchorShapeElement & | SetIntermediatePoints (ShapePointArray const &in_intermediate_points) |
bool | ShowAnchor (ShapePoint &out_anchor) const |
bool | ShowConnection (bool &out_connection) const |
bool | ShowIntermediatePoints (ShapePointArray &out_intermediate_points) const |
AnchorShapeElement & | UnsetConnection () |
AnchorShapeElement & | UnsetIntermediatePoints () |
![]() | |
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 () |
HPS::Type | Type () const |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Detailed Description
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.
Constructor & Destructor Documentation
HPS::AnchorShapeElement::AnchorShapeElement | ( | ) |
The default constructor creates an empty AnchorShapeElement object.
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
-
in_that The source ShapeElement to copy.
HPS::AnchorShapeElement::AnchorShapeElement | ( | AnchorShapeElement const & | in_that | ) |
The copy constructor creates a AnchorShapeElement AnchorShapeElement object that contains the same settings as the source AnchorShapeElement.
- Parameters
-
in_that The source CircleShapeElement to copy.
|
explicit |
This constructor creates a AnchorShapeElement with the specified anchor point.
- Parameters
-
in_anchor_point The anchor point.
|
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.
HPS::AnchorShapeElement::AnchorShapeElement | ( | AnchorShapeElement && | in_that | ) |
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
-
in_that An rvalue reference to a AnchorShapeElement to take the impl from.
Member Function Documentation
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::ShapeElement.
AnchorShapeElement& HPS::AnchorShapeElement::operator= | ( | AnchorShapeElement && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this AnchorShapeElement thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to a AnchorShapeElement to take the impl from.
- Returns
- A reference to this AnchorShapeElement.
AnchorShapeElement& HPS::AnchorShapeElement::SetAnchor | ( | ShapePoint const & | in_anchor | ) |
Sets the anchor point for this AnchorShapeElement.
- Parameters
-
in_anchor The anchor point.
AnchorShapeElement& HPS::AnchorShapeElement::SetConnection | ( | bool | in_connection | ) |
Sets the connection setting for this AnchorShapeElement.
- Parameters
-
in_connection Whether the first intermediate point connects to the anchor point.
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.
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.
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.
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.
AnchorShapeElement& HPS::AnchorShapeElement::UnsetConnection | ( | ) |
Unsets the connection setting for this AnchorShapeElement.
AnchorShapeElement& HPS::AnchorShapeElement::UnsetIntermediatePoints | ( | ) |
Unsets the intermediate points for this AnchorShapeElement.
The documentation for this class was generated from the following file:
- include/hps.h