EllipticalArcShapeElement

class HPS.EllipticalArcShapeElement : public HPS.ShapeElement 

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

Public Functions

override void Dispose ()

EllipticalArcShapeElement (): The default constructor creates an empty EllipticalArcShapeElement object.

EllipticalArcShapeElement (HPS.EllipticalArcShapeElement in_that)

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

Param in_that: The source EllipticalArcShapeElement to copy.

EllipticalArcShapeElement (HPS.ShapeElement in_that)

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

Param in_that: The source ShapeElement to copy.

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

This constructor creates a EllipticalArcShapeElement with the specified parameters.

Param in_center: The center point of the arc.
Param in_major_axis_point: A point defining the major axis of the arc.
Param in_minor_axis_point: A point defining the minor axis of the arc.

EllipticalArcShapeElement (HPS.ShapePoint in_center, HPS.ShapePoint in_major_axis_point, HPS.ShapePoint in_minor_axis_point, float in_start)

This constructor creates a EllipticalArcShapeElement with the specified parameters.

Param in_center: The center point of the arc.
Param in_major_axis_point: A point defining the major axis of the arc.
Param in_minor_axis_point: A point defining the minor axis of the arc.
Param in_start: The start of the arc, in degrees.

EllipticalArcShapeElement (HPS.ShapePoint in_center, HPS.ShapePoint in_major_axis_point, HPS.ShapePoint in_minor_axis_point, float in_start, float in_end)

This constructor creates a EllipticalArcShapeElement with the specified parameters.

Param in_center: The center point of the arc.
Param in_major_axis_point: A point defining the major axis of the arc.
Param in_minor_axis_point: A point defining the minor axis of the arc.
Param in_start: The start of the arc, in degrees.
Param in_end: The end of the arc, in degrees.

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

Sets the center point for this EllipticalArcShapeElement.

Param in_center: The center point of the arc.

HPS.EllipticalArcShapeElement SetEnd (float in_end)

Sets the end for this EllipticalArcShapeElement.

Param in_end: The ending point of this arc, expressed in degrees

HPS.EllipticalArcShapeElement SetMajorAxisPoint (HPS.ShapePoint in_major_axis_point)

Sets the major axis point for this EllipticalArcShapeElement.

Param in_major_axis_point: A point defining the major axis of the arc.

HPS.EllipticalArcShapeElement SetMinorAxisPoint (HPS.ShapePoint in_minor_axis_point)

Sets the minor axis point for this EllipticalArcShapeElement.

Param in_minor_axis_point: A point defining the minor axis of the arc.

HPS.EllipticalArcShapeElement SetStart (float in_start)

Sets the start for this EllipticalArcShapeElement.

Param in_start: The starting point of this arc, expressed in degrees

bool ShowCenter (out HPS.ShapePoint out_center)

Shows the center point for this EllipticalArcShapeElement.

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

bool ShowEnd (out float out_end)

Shows the end point for this EllipticalArcShapeElement.

Param out_end: The ending point of this arc, expressed in degrees
Return: true if an end point was set, false otherwise.

bool ShowMajorAxisPoint (out HPS.ShapePoint out_major_axis_point)

Shows the major axis point for this EllipticalArcShapeElement.

Param out_major_axis_point: A point defining the major axis of the arc.
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 EllipticalArcShapeElement.

Param out_minor_axis_point: A point defining the minor axis of the arc.
Return: true if a minor axis point was set, false otherwise.

bool ShowStart (out float out_start)

Shows the start point for this EllipticalArcShapeElement.

Param out_start: The starting point of this arc, expressed in degrees
Return: true if a start point was set, false otherwise.