LeaderLineClippingElement

class HPS::LeaderLineClippingElement : public HPS::ShapeElement

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

Public Functions

LeaderLineClippingElement()

The default constructor creates an empty LeaderLineClippingElement object.

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.

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.

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.

inline virtual HPS::Type ObjectType() const

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.

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 &SetShape(CircleShapeElement const &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 &SetShape(CircularArcShapeElement const &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.

LeaderLineClippingElement &SetShape(EllipseShapeElement const &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 &SetShape(EllipticalArcShapeElement const &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 &SetShape(PolygonShapeElement const &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.

bool ShowClipShapeType(HPS::Type &out_type)

bool 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 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.

bool 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 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 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.

LeaderLineClippingElement &UnSetShape()

Unsets the explicit clip shape and returns to the default functionality of clipping around the background shape

~LeaderLineClippingElement()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::LeaderLineClippingElement