AnchorShapeElement

class HPS.AnchorShapeElement : public HPS.ShapeElement

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.

Public Functions

AnchorShapeElement ()

The default constructor creates an empty AnchorShapeElement object.

AnchorShapeElement (HPS.AnchorShapeElement in_that)

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

Param in_that

The source CircleShapeElement to copy.

AnchorShapeElement (HPS.ShapeElement 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.

Param in_that

The source ShapeElement to copy.

AnchorShapeElement (HPS.ShapePoint in_anchor_point)

This constructor creates a AnchorShapeElement with the specified anchor point.

Param in_anchor_point

The anchor point.

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

This constructor creates a AnchorShapeElement with the specified parameters.

Param in_anchor_point

The anchor point.

Param in_intermediate_points

Intermediate points between the leader line and the anchor point

Param in_connection

Whether the first intermediate point is connected to the anchor point by a line.

override void Dispose ()

override HPS.Type ObjectType ()

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

Return

The declared type of the object in question, which may differ from the true, underlying type.

HPS.AnchorShapeElement SetAnchor (HPS.ShapePoint in_anchor)

Sets the anchor point for this AnchorShapeElement.

Param in_anchor

The anchor point.

HPS.AnchorShapeElement SetConnection (bool in_connection)

Sets the connection setting for this AnchorShapeElement.

Param in_connection

Whether the first intermediate point connects to the anchor point.

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

Sets the intermediate points for this AnchorShapeElement.

Param in_intermediate_points

The points between the anchor and the leader line.

bool ShowAnchor (out HPS.ShapePoint out_anchor)

Shows the anchor for this AnchorShapeElement.

Param out_anchor

The anchor point.

Return

true if an anchor point was set, false otherwise.

bool ShowConnection (out bool out_connection)

Shows the connection setting for this AnchorShapeElement.

Param out_connection

Whether the first intermediate point connects to the anchor point.

Return

true if a connection setting was set, false otherwise.

bool ShowIntermediatePoints (out HPS.ShapePoint[] out_intermediate_points)

Shows the intermediate points for this AnchorShapeElement.

Param out_intermediate_points

The points between the anchor point and the leader line.

Return

true if intermediate points were set, false otherwise.

HPS.AnchorShapeElement UnsetConnection ()

Unsets the connection setting for this AnchorShapeElement.

HPS.AnchorShapeElement UnsetIntermediatePoints ()

Unsets the intermediate points for this AnchorShapeElement.