CircleKey

class HPS.CircleKey : HPS.GeometryKey

The CircleKey class is a smart pointer to a database object. It is a handle to a circle inserted via SegmentKey.InsertCircle. A circle has face geometry contained within its circumference. The visualization of the circle will be determined by attribute settings affecting faces and edges.

Public Functions

CircleKey ()

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

CircleKey (HPS.CircleKey in_that)

The copy constructor creates a CircleKey object that shares the underlying smart-pointer of the source CircleKey.

Param in_that:The source CircleKey to copy.

CircleKey (HPS.Key in_that)

This constructor creates a CircleKey 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 a Circle key. Otherwise the copy will fail and the resulting CircleKey will be invalid.

void Consume (HPS.CircleKit in_kit)

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

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.

void Set (HPS.CircleKit in_kit)

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

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

HPS.CircleKey SetCenter (HPS.Point in_center)

Sets the center point for this CircleKey.

Param in_center:  The center point for this CircleKey. Return:A reference to this CircleKey.

HPS.CircleKey SetNormal (HPS.Vector in_normal)

Sets the normal for this CircleKey. This is the normal for the plane in which the circle lies.

Param in_normal:  The normal for this CircleKey. Return:A reference to this CircleKey.

HPS.CircleKey SetRadius (float in_radius)

Sets the radius for this CircleKey.

Param in_radius:  The radius for this CircleKey. Return:A reference to this CircleKey.

void Show (out HPS.CircleKit out_kit)

Copy the contents of this CircleKey into the specified kit.

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

bool ShowCenter (out HPS.Point out_center)

Shows the center point for this CircleKey.

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

bool ShowNormal (out HPS.Vector out_normal)

Shows the normal for this CircleKey.

Param out_normal:  The normal for this CircleKey. Return:true if a normal was set, false otherwise.

bool ShowRadius (out float out_radius)

Shows the radius for this CircleKey.

Param out_radius:  The radius for this CircleKey. Return:true if a radius was set, false otherwise.