HPS::LeaderLineClippingElement Class Reference

#include <hps.h>

Inheritance diagram for HPS::LeaderLineClippingElement:
HPS::ShapeElement HPS::Object

Public Member Functions

 LeaderLineClippingElement ()
 
 LeaderLineClippingElement (ShapeElement const &in_that)
 
 LeaderLineClippingElement (LeaderLineClippingElement const &in_that)
 
 LeaderLineClippingElement (LeaderLineClippingElement &&in_that)
 
HPS::Type ObjectType () const
 
LeaderLineClippingElementoperator= (LeaderLineClippingElement &&in_that)
 
LeaderLineClippingElementSetShape (const PolygonShapeElement &in_shape)
 
LeaderLineClippingElementSetShape (const EllipseShapeElement &in_shape)
 
LeaderLineClippingElementSetShape (const EllipticalArcShapeElement &in_shape)
 
LeaderLineClippingElementSetShape (const CircleShapeElement &in_shape)
 
LeaderLineClippingElementSetShape (const CircularArcShapeElement &in_shape)
 
bool ShowClipShapeType (HPS::Type &out_type)
 
bool ShowShape (PolygonShapeElement &out_shape) const
 
bool ShowShape (EllipseShapeElement &out_shape) const
 
bool ShowShape (EllipticalArcShapeElement &out_shape) const
 
bool ShowShape (CircleShapeElement &out_shape) const
 
bool ShowShape (CircularArcShapeElement &out_shape) const
 
LeaderLineClippingElementUnSetShape ()
 
- Public Member Functions inherited from HPS::ShapeElement
bool Equals (ShapeElement const &in_that) const
 
bool operator!= (ShapeElement const &in_that) const
 
ShapeElementoperator= (ShapeElement &&in_that)
 
ShapeElementoperator= (ShapeElement const &in_that)
 
bool operator== (ShapeElement const &in_that) const
 
void Set (ShapeElement const &in_that)
 
ShapeElementSetDisjointed (bool in_state)
 
ShapeElementSetFill (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
 
- Public Member Functions inherited from HPS::Object
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)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::LeaderLineClippingElement
 
- Static Public Attributes inherited from HPS::ShapeElement
static const HPS::Type staticType = HPS::Type::ShapeElement
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
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

◆ LeaderLineClippingElement() [1/4]

HPS::LeaderLineClippingElement::LeaderLineClippingElement ( )

The default constructor creates an empty LeaderLineClippingElement object.

◆ LeaderLineClippingElement() [2/4]

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_thatThe source ShapeElement to copy.

◆ LeaderLineClippingElement() [3/4]

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_thatThe source LeaderLineClippingElement to copy.

◆ LeaderLineClippingElement() [4/4]

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_thatAn rvalue reference to a LeaderLineClippingElement to take the impl from.

Member Function Documentation

◆ ObjectType()

HPS::Type HPS::LeaderLineClippingElement::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=()

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_thatAn rvalue reference to a PolygonShapeElement to take the impl from.
Returns
A reference to this LeaderLineClippingElement.

◆ SetShape() [1/5]

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_shapeThe shape to clip leader lines with.

◆ SetShape() [2/5]

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_shapeThe shape to clip leader lines with.

◆ SetShape() [3/5]

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_shapeThe shape to clip leader lines with.

◆ SetShape() [4/5]

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_shapeThe shape to clip leader lines with.

◆ SetShape() [5/5]

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_shapeThe shape to clip leader lines with.

◆ ShowShape() [1/5]

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_shapeThe explicit clip shape.
Returns
true if out_shape was set, false otherwise.

◆ ShowShape() [2/5]

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_shapeThe explicit clip shape.
Returns
true if out_shape was set, false otherwise.

◆ ShowShape() [3/5]

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_shapeThe explicit clip shape.
Returns
true if out_shape was set, false otherwise.

◆ ShowShape() [4/5]

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_shapeThe explicit clip shape.
Returns
true if out_shape was set, false otherwise.

◆ ShowShape() [5/5]

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_shapeThe explicit clip shape.
Returns
true if out_shape was set, false otherwise.

◆ UnSetShape()

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: