EllipticalArcKey

class HPS.EllipticalArcKey : public HPS.GeometryKey 

The EllipticalArcKey class is a smart pointer to a database object. It is a handle to an elliptical arc inserted via SegmentKey.InsertEllipticalArc.

Public Functions

void Consume (HPS.EllipticalArcKit in_kit)

Completely replaces all settings on this EllipticalArcKey with those set on the specified kit and resets the kit.

Param in_kit: The kit from which to get the settings to replace on this EllipticalArcKey.

override void Dispose ()

EllipticalArcKey (): The default constructor creates an uninitialized EllipticalArcKey object. The Type() function will return Type.None.

EllipticalArcKey (HPS.EllipticalArcKey in_that)

The copy constructor creates an EllipticalArcKey object that shares the underlying smart-pointer of the source EllipticalArcKey.

Param in_that: The source EllipticalArcKey to copy.

EllipticalArcKey (HPS.Key in_that): This constructor creates an EllipticalArcKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really an upcast of an EllipticalArc key. Otherwise the copy will fail and the resulting EllipticalArcKey will be invalid.

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.

void Set (HPS.EllipticalArcKit in_kit)

Replace those settings on this EllipticalArcKey with those set on the specified kit.

Param in_kit: The kit from which to get the settings to replace on this EllipticalArcKey.

HPS.EllipticalArcKey SetCenter (HPS.Point in_center)

Sets the center point for the ellipse used to define the elliptical arc.

Param in_center: The center point for the ellipse used to define the elliptical arc.
Return: A reference to this EllipticalArcKey.

HPS.EllipticalArcKey SetEnd (float in_end)

Sets the normalized parametric value on the ellipse at which the elliptical arc ends. The value should be in the range [0.0f,1.0f] and be larger than the start value. It is defined such that 0.0f is the point where the major axis intersects the ellipse, and as the value increases it passes through the point at which the minor axis intersects the ellipse (0.25f), and that 1.0f maps to the same point as 0.0f.

Param in_end: The normalized parametric value on the ellipse at which the elliptical arc ends. This value should be in the range [0.0f,1.0f] and be larger than the start value.
Return: A reference to this EllipticalArcKey.

HPS.EllipticalArcKey SetMajor (HPS.Point in_major)

Sets the intersection point of the major axis and the ellipse used to define the elliptical arc.

Param in_major: The intersection point of the major axis and the ellipse used to define the elliptical arc.
Return: A reference to this EllipticalArcKey.

HPS.EllipticalArcKey SetMinor (HPS.Point in_minor)

Sets the intersection point of the minor axis and the ellipse used to define the elliptical arc.

Param in_minor: The intersection point of the minor axis and the ellipse used to define the elliptical arc.
Return: A reference to this EllipticalArcKey.

HPS.EllipticalArcKey SetStart (float in_start)

Sets the normalized parametric value on the ellipse at which the elliptical arc starts. The value should be in the range [0.0f,1.0f] and be smaller than the end value. It is defined such that 0.0f is the point where the major axis intersects the ellipse, and as the value increases it passes through the point at which the minor axis intersects the ellipse (0.25f), and that 1.0f maps to the same point as 0.0f.

Param in_start: The normalized parametric value on the ellipse at which the elliptical arc starts. This value should be in the range [0.0f,1.0f] and be smaller than the end value.
Return: A reference to this EllipticalArcKey.

void Show (out HPS.EllipticalArcKit out_kit)

Copy the contents of this EllipticalArcKey into the specified kit.

Param out_kit: The kit to populate with the contents of this EllipticalArcKey.

bool ShowCenter (out HPS.Point out_center)

Shows the center point for the ellipse used to define the elliptical arc.

Param out_center: The center point for the ellipse used to define the elliptical arc.
Return: true if a center was set, false otherwise.

bool ShowEnd (out float out_end)

Shows the normalized parametric value on the ellipse at which the elliptical arc ends.

Param out_end: The normalized parametric value on the ellipse at which the elliptical arc ends.
Return: true if a normalized parametric end value was set, false otherwise.

bool ShowMajor (out HPS.Point out_major)

Shows the intersection point of the major axis and the ellipse used to define the elliptical arc.

Param out_major: The intersection point of the major axis and the ellipse used to define the elliptical arc.
Return: true if an intersection point with the major axis was set, false otherwise.

bool ShowMinor (out HPS.Point out_minor)

Shows the intersection point of the minor axis and the ellipse used to define the elliptical arc.

Param out_minor: The intersection point of the minor axis and the ellipse used to define the elliptical arc.
Return: true if an intersection point with the minor axis was set, false otherwise.

bool ShowStart (out float out_start)

Shows the normalized parametric value on the ellipse at which the elliptical arc starts.

Param out_start: The normalized parametric value on the ellipse at which the elliptical arc starts.
Return: true if a normalized parametric start value was set, false otherwise.