#include <hps.h>

Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::LeaderLineClippingElement |
![]() | |
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 LeaderLineClippingElement class is a user space object. It is used to define clipping of leader lines around a text background If LeaderLineClippingElement does not have another ShapeElement set for the clip region, it will use the background shape. If LeaderLineClippingElement has another ShapeElement set for the clip region, it will use that instead
Constructor & Destructor Documentation
HPS::LeaderLineClippingElement::LeaderLineClippingElement | ( | ) |
The default constructor creates an empty LeaderLineClippingElement object.
HPS::LeaderLineClippingElement::LeaderLineClippingElement | ( | ShapeElement const & | in_that | ) |
This constructor creates a LeaderLineClippingElement 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 clipping shape element. Otherwise the copy will fail and the resulting LeaderLineClippingElement will be invalid.
- Parameters
-
in_that The source ShapeElement to copy.
HPS::LeaderLineClippingElement::LeaderLineClippingElement | ( | LeaderLineClippingElement const & | in_that | ) |
The copy constructor creates a new LeaderLineClippingElement object that contains the same settings as the source LeaderLineClippingElement.
- Parameters
-
in_that The source LeaderLineClippingElement to copy.
HPS::LeaderLineClippingElement::LeaderLineClippingElement | ( | LeaderLineClippingElement && | in_that | ) |
The move constructor creates a LeaderLineClippingElement by transferring the underlying impl of the rvalue reference to this LeaderLineClippingElement thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to a LeaderLineClippingElement to take the impl from.
Member Function Documentation
|
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.
LeaderLineClippingElement& HPS::LeaderLineClippingElement::operator= | ( | LeaderLineClippingElement && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this LeaderLineClippingElement thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to a PolygonShapeElement to take the impl from.
- Returns
- A reference to this LeaderLineClippingElement.
LeaderLineClippingElement& HPS::LeaderLineClippingElement::SetShape | ( | const PolygonShapeElement & | in_shape | ) |
Sets the explicit Polygon clip shape for this LeaderLineClippingElement. if no explicit shape is set, the background shape will be used
- Parameters
-
in_shape The shape to clip leader lines with.
LeaderLineClippingElement& HPS::LeaderLineClippingElement::SetShape | ( | const EllipseShapeElement & | in_shape | ) |
Sets the explicit Ellipse clip shape for this LeaderLineClippingElement. if no explicit shape is set, the background shape will be used
- Parameters
-
in_shape The shape to clip leader lines with.
LeaderLineClippingElement& HPS::LeaderLineClippingElement::SetShape | ( | const EllipticalArcShapeElement & | in_shape | ) |
Sets the explicit Elliptical Arcclip shape for this LeaderLineClippingElement. if no explicit shape is set, the background shape will be used
- Parameters
-
in_shape The shape to clip leader lines with.
LeaderLineClippingElement& HPS::LeaderLineClippingElement::SetShape | ( | const CircleShapeElement & | in_shape | ) |
Sets the explicit Circle clip shape for this LeaderLineClippingElement. if no explicit shape is set, the background shape will be used
- Parameters
-
in_shape The shape to clip leader lines with.
LeaderLineClippingElement& HPS::LeaderLineClippingElement::SetShape | ( | const CircularArcShapeElement & | in_shape | ) |
Sets the explicit Circular Arc clip shape for this LeaderLineClippingElement. if no explicit shape is set, the background shape will be used
- Parameters
-
in_shape The shape to clip leader lines with.
bool HPS::LeaderLineClippingElement::ShowShape | ( | PolygonShapeElement & | out_shape | ) | const |
Shows the explicit Polygon clip shape for this LeaderLineClippingElement. If the wrong type is provided, will return false
- Parameters
-
out_shape The explicit clip shape.
- Returns
- true if out_shape was set, false otherwise.
bool HPS::LeaderLineClippingElement::ShowShape | ( | EllipseShapeElement & | out_shape | ) | const |
Shows the explicit Ellipse clip shape for this LeaderLineClippingElement. If the wrong type is provided, will return false
- Parameters
-
out_shape The explicit clip shape.
- Returns
- true if out_shape was set, false otherwise.
bool HPS::LeaderLineClippingElement::ShowShape | ( | EllipticalArcShapeElement & | out_shape | ) | const |
Shows the explicit EllipticalArc clip shape for this LeaderLineClippingElement. If the wrong type is provided, will return false
- Parameters
-
out_shape The explicit clip shape.
- Returns
- true if out_shape was set, false otherwise.
bool HPS::LeaderLineClippingElement::ShowShape | ( | CircleShapeElement & | out_shape | ) | const |
Shows the explicit Circle clip shape for this LeaderLineClippingElement. If the wrong type is provided, will return false
- Parameters
-
out_shape The explicit clip shape.
- Returns
- true if out_shape was set, false otherwise.
bool HPS::LeaderLineClippingElement::ShowShape | ( | CircularArcShapeElement & | out_shape | ) | const |
Shows the explicit Ciruclar Arc clip shape for this LeaderLineClippingElement. If the wrong type is provided, will return false
- Parameters
-
out_shape The explicit clip shape.
- Returns
- true if out_shape was set, false otherwise.
LeaderLineClippingElement& HPS::LeaderLineClippingElement::UnSetShape | ( | ) |
Unsets the explicit clip shape and returns to the default functionality of clipping around the background shape
The documentation for this class was generated from the following file:
- include/hps.h