HPS.AnchorShapeElement Class Reference
Inheritance diagram for HPS.AnchorShapeElement:
HPS.ShapeElement HPS.Object

Public Member Functions

 AnchorShapeElement ()
 
 AnchorShapeElement (HPS.ShapeElement in_that)
 
 AnchorShapeElement (HPS.AnchorShapeElement in_that)
 
 AnchorShapeElement (HPS.ShapePoint in_anchor_point)
 
 AnchorShapeElement (HPS.ShapePoint in_anchor_point, HPS.ShapePoint[] in_intermediate_points, bool in_connection)
 
override void Dispose ()
 
override HPS.Type ObjectType ()
 
HPS.AnchorShapeElement SetAnchor (HPS.ShapePoint in_anchor)
 
HPS.AnchorShapeElement SetConnection (bool in_connection)
 
HPS.AnchorShapeElement SetIntermediatePoints (HPS.ShapePoint[] in_intermediate_points)
 
bool ShowAnchor (out HPS.ShapePoint out_anchor)
 
bool ShowConnection (out bool out_connection)
 
bool ShowIntermediatePoints (out HPS.ShapePoint[] out_intermediate_points)
 
HPS.AnchorShapeElement UnsetConnection ()
 
HPS.AnchorShapeElement UnsetIntermediatePoints ()
 
- Public Member Functions inherited from HPS.ShapeElement
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.ShapeElement in_that)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.ShapeElement in_that)
 
HPS.ShapeElement SetDisjointed (bool in_state)
 
HPS.ShapeElement SetFill (bool in_state)
 
 ShapeElement ()
 
 ShapeElement (HPS.ShapeElement in_that)
 
bool ShowDisjointed (out bool out_state)
 
bool ShowFill (out bool out_state)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.ShapeElement
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.ShapeElement
static bool operator!= (HPS.ShapeElement a, HPS.ShapeElement b)
 
static bool operator== (HPS.ShapeElement a, HPS.ShapeElement b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

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

◆ AnchorShapeElement() [1/5]

HPS.AnchorShapeElement.AnchorShapeElement ( )
inline

The default constructor creates an empty AnchorShapeElement object.

◆ AnchorShapeElement() [2/5]

HPS.AnchorShapeElement.AnchorShapeElement ( HPS.ShapeElement  in_that)
inline

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

◆ AnchorShapeElement() [3/5]

HPS.AnchorShapeElement.AnchorShapeElement ( HPS.AnchorShapeElement  in_that)
inline

The copy constructor creates a AnchorShapeElementAnchorShapeElement object that contains the same settings as the source AnchorShapeElement.

Parameters
in_thatThe source CircleShapeElement to copy.

◆ AnchorShapeElement() [4/5]

HPS.AnchorShapeElement.AnchorShapeElement ( HPS.ShapePoint  in_anchor_point)
inline

This constructor creates a AnchorShapeElement with the specified anchor point.

Parameters
in_anchor_pointThe anchor point.

◆ AnchorShapeElement() [5/5]

HPS.AnchorShapeElement.AnchorShapeElement ( HPS.ShapePoint  in_anchor_point,
HPS.ShapePoint []  in_intermediate_points,
bool  in_connection 
)
inline

This constructor creates a AnchorShapeElement with the specified parameters.

Parameters
in_anchor_pointThe anchor point.
in_intermediate_pointsIntermediate points between the leader line and the anchor point
in_connectionWhether the first intermediate point is connected to the anchor point by a line.

Member Function Documentation

◆ ObjectType()

override HPS.Type HPS.AnchorShapeElement.ObjectType ( )
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.Object.

◆ SetAnchor()

HPS.AnchorShapeElement HPS.AnchorShapeElement.SetAnchor ( HPS.ShapePoint  in_anchor)
inline

Sets the anchor point for this AnchorShapeElement.

Parameters
in_anchorThe anchor point.

◆ SetConnection()

HPS.AnchorShapeElement HPS.AnchorShapeElement.SetConnection ( bool  in_connection)
inline

Sets the connection setting for this AnchorShapeElement.

Parameters
in_connectionWhether the first intermediate point connects to the anchor point.

◆ SetIntermediatePoints()

HPS.AnchorShapeElement HPS.AnchorShapeElement.SetIntermediatePoints ( HPS.ShapePoint []  in_intermediate_points)
inline

Sets the intermediate points for this AnchorShapeElement.

Parameters
in_intermediate_pointsThe points between the anchor and the leader line.

◆ ShowAnchor()

bool HPS.AnchorShapeElement.ShowAnchor ( out HPS.ShapePoint  out_anchor)
inline

Shows the anchor for this AnchorShapeElement.

Parameters
out_anchorThe anchor point.
Returns
true if an anchor point was set, false otherwise.

◆ ShowConnection()

bool HPS.AnchorShapeElement.ShowConnection ( out bool  out_connection)
inline

Shows the connection setting for this AnchorShapeElement.

Parameters
out_connectionWhether the first intermediate point connects to the anchor point.
Returns
true if a connection setting was set, false otherwise.

◆ ShowIntermediatePoints()

bool HPS.AnchorShapeElement.ShowIntermediatePoints ( out HPS.ShapePoint []  out_intermediate_points)
inline

Shows the intermediate points for this AnchorShapeElement.

Parameters
out_intermediate_pointsThe points between the anchor point and the leader line.
Returns
true if intermediate points were set, false otherwise.

◆ UnsetConnection()

HPS.AnchorShapeElement HPS.AnchorShapeElement.UnsetConnection ( )
inline

Unsets the connection setting for this AnchorShapeElement.

◆ UnsetIntermediatePoints()

HPS.AnchorShapeElement HPS.AnchorShapeElement.UnsetIntermediatePoints ( )
inline

Unsets the intermediate points for this AnchorShapeElement.


The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.AnchorShapeElement.cs