CircularArcShapeElement

class HPS.CircularArcShapeElement : HPS.ShapeElement

The CircularArcShapeElement class is a user space object. It is used to define circular arc elements to make up shapes for text backgrounds.

Public Functions

CircularArcShapeElement ()

The default constructor creates an empty CircularArcShapeElement object.

CircularArcShapeElement (HPS.CircularArcShapeElement in_that)

The copy constructor creates a new CircularArcShapeElement object that contains the same settings as the source CircularArcShapeElement.

Param in_that:The source CircularArcShapeElement to copy.

CircularArcShapeElement (HPS.ShapeElement in_that)

This constructor creates a CircularArcShapeElement 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 circular arc shape element. Otherwise the copy will fail and the resulting CircularArcShapeElement will be invalid.

Param in_that:The source ShapeElement to copy.

CircularArcShapeElement (HPS.ShapePoint in_start_point, HPS.ShapePoint in_middle_point, HPS.ShapePoint in_end_point)

This constructor creates a CircularArcShapeElement with the specified parameters.

Param in_start_point:  The start of the arc. Param in_middle_point:  A point between the start and the end point, where the arc passes through Param in_end_point:  The end of the arc.

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.CircularArcShapeElement SetEndPoint (HPS.ShapePoint in_end)

Sets the end point for this CircularArcShapeElement.

Param in_end:The end point of the arc.

HPS.CircularArcShapeElement SetMiddlePoint (HPS.ShapePoint in_middle)

Sets the minor axis point for this CircularArcShapeElement.

Param in_middle:  A point between the start and the end point. The arc passes through this point.

HPS.CircularArcShapeElement SetStartPoint (HPS.ShapePoint in_start)

Sets the center point for this CircularArcShapeElement.

Param in_start:The start of the arc.

bool ShowEndPoint (out HPS.ShapePoint out_end)

Shows the end point for this CircularArcShapeElement.

Param out_end:The end point of the arc Return:true if an end point was set, false otherwise.

bool ShowMiddlePoint (out HPS.ShapePoint out_middle)

Shows the middle point for this CircularArcShapeElement.

Param out_middle:  A point between the start and the end point. The arc passes through this point. Return:true if a middle point was set, false otherwise.

bool ShowStartPoint (out HPS.ShapePoint out_start)

Shows the center point for this CircularArcShapeElement.

Param out_start:  The start for the arc. Return:true if a star point was set, false otherwise.