EllipseKey

class HPS.EllipseKey : public HPS.GeometryKey

The EllipseKey class is a smart pointer to a database object. It is a handle to an ellipse inserted via SegmentKey.InsertEllipse.

Public Functions

void Consume (HPS.EllipseKit in_kit)

Completely replaces all settings on this EllipseKit 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 EllipseKit.

override void Dispose ()

EllipseKey ()

The default constructor creates an uninitialized EllipseKey object. The Type() function will return Type.None.

EllipseKey (HPS.EllipseKey in_that)

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

Param in_that

The source EllipseKey to copy.

EllipseKey (HPS.Key in_that)

This constructor creates an EllipseKey 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 Ellipse key. Otherwise the copy will fail and the resulting EllipseKey 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.EllipseKit in_kit)

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

Param in_kit

The kit from which to get the settings to replace on this EllipseKey.

HPS.EllipseKey SetCenter (HPS.Point in_center)

Sets the center point for the ellipse.

Param in_center

The center point for the ellipse.

Return

A reference to this EllipseKey.

HPS.EllipseKey SetMajor (HPS.Point in_major)

Sets the intersection point of the major axis and the ellipse.

Param in_major

The intersection point of the major axis and the ellipse.

Return

A reference to this EllipseKey.

HPS.EllipseKey SetMinor (HPS.Point in_minor)

Sets the intersection point of the minor axis and the ellipse.

Param in_minor

The intersection point of the minor axis and the ellipse.

Return

A reference to this EllipseKey.

void Show (out HPS.EllipseKit out_kit)

Copy the contents of this EllipseKey into the specified kit.

Param out_kit

The kit to populate with the contents of this EllipseKey.

bool ShowCenter (out HPS.Point out_center)

Shows the center point for the ellipse.

Param out_center

The center point for the ellipse.

Return

true if a center was set, false otherwise.

bool ShowMajor (out HPS.Point out_major)

Shows the intersection point of the major axis and the ellipse.

Param out_major

The intersection point of the major axis and the ellipse.

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.

Param out_minor

The intersection point of the minor axis and the ellipse.

Return

true if an intersection point with the minor axis was set, false otherwise.