CircleShapeElement

class HPS.CircleShapeElement : HPS.ShapeElement

The CircleShapeElement class is a user space object. It is used to define circle elements to make up shapes for text backgrounds.

Public Functions

CircleShapeElement ()

The default constructor creates an empty CircleShapeElement object.

CircleShapeElement (HPS.CircleShapeElement in_that)

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

Param in_that:The source CircleShapeElement to copy.

CircleShapeElement (HPS.ShapeElement in_that)

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

Param in_that:The source ShapeElement to copy.

CircleShapeElement (HPS.ShapePoint in_center, HPS.ShapePoint in_radius)

This constructor creates a CircleShapeElement with the specified center and radius points.

Param in_center:  The center point of the circle. Param in_radius:  The radius of the circle.

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.CircleShapeElement SetCenter (HPS.ShapePoint in_center)

Sets the center point for this CircleShapeElement.

Param in_center:  The center point of the circle.

HPS.CircleShapeElement SetRadius (HPS.ShapePoint in_radius)

Sets the radius point for this CircleShapeElement.

Param in_radius:  The radius point of the circle.

bool ShowCenter (out HPS.ShapePoint out_center)

Shows the center point for this CircleShapeElement.

Param out_center:  The center point for the circle. Return:true if a center point was set, false otherwise.

bool ShowRadius (out HPS.ShapePoint out_radius)

Shows the radius point for this CircleShapeElement.

Param out_radius:  The radius point for the circle. Return:true if a radius was set, false otherwise.