EllipseShapeElement

class HPS.EllipseShapeElement : public HPS.ShapeElement

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

Public Functions

override void Dispose ()

EllipseShapeElement ()

The default constructor creates an empty EllipseShapeElement object.

EllipseShapeElement (HPS.EllipseShapeElement in_that)

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

Param in_that

The source EllipseShapeElement to copy.

EllipseShapeElement (HPS.ShapeElement in_that)

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

Param in_that

The source ShapeElement to copy.

EllipseShapeElement (HPS.ShapePoint in_center, HPS.ShapePoint in_major_axis_point, HPS.ShapePoint in_minor_axis_point)

This constructor creates a EllipseShapeElement with the specified point array.

Param in_center

The center of the ellipse.

Param in_major_axis_point

A point defining the major axis of the ellipse

Param in_minor_axis_point

A point defining the minor axis of the ellipse.

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

Sets the points for this EllipseShapeElement.

Param in_center

The center point of the ellipse.

HPS.EllipseShapeElement SetMajorAxisPoint (HPS.ShapePoint in_major_axis_point)

Sets a point on the major axis for this EllipseShapeElement.

Param in_major_axis_point

The point on the major axis of the ellipse.

HPS.EllipseShapeElement SetMinorAxisPoint (HPS.ShapePoint in_minor_axis_point)

Sets a point on the minor axis for this EllipseShapeElement.

Param in_minor_axis_point

The point on the minor axis of the ellipse.

bool ShowCenter (out HPS.ShapePoint out_center)

Shows the center point for this EllipseShapeElement.

Param out_center

The center point for the ellipse.

Return

true if a center point was set, false otherwise.

bool ShowMajorAxisPoint (out HPS.ShapePoint out_major_axis_point)

Shows the major axis point for this EllipseShapeElement.

Param out_major_axis_point

The major axis point for the ellipse.

Return

true if a major axis point was set, false otherwise.

bool ShowMinorAxisPoint (out HPS.ShapePoint out_minor_axis_point)

Shows the minor axis point for this EllipseShapeElement.

Param out_minor_axis_point

The minor axis point for the ellipse.

Return

true if a minor axis point was set, false otherwise.