SphereKey

class HPS.SphereKey : HPS.GeometryKey 

The SphereKey class is a smart pointer to a database object. It is a handle to a sphere inserted via SegmentKey.InsertSphere.

Public Functions

void Consume (HPS.SphereKit in_kit)

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

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.SphereKit in_kit)

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

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

HPS.SphereKey SetBasis (HPS.Vector in_vertical, HPS.Vector in_horizontal)

Sets the basis for the SphereKey.

Param in_vertical:
	The vector to use as the vertical axis for the SphereKey.
Param in_horizontal:
	The vector to use as the horizontal axis for the SphereKey.
Return:	A reference to this SphereKey.

HPS.SphereKey SetCenter (HPS.Point in_center)

Sets the center point for the SphereKey.

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

HPS.SphereKey SetRadius (float in_radius)

Sets the radius for the SphereKey.

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

void Show (out HPS.SphereKit out_kit)

Copy the contents of this SphereKey into the specified kit.

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

bool ShowBasis (out HPS.Vector out_vertical, out HPS.Vector out_horizontal)

Shows the basis for the SphereKey.

Param out_vertical:
	The vector to use as the vertical axis for the SphereKey.
Param out_horizontal:
	The vector to use as the horizontal axis for the SphereKey.
Return:	true if a basis was set, false otherwise.

bool ShowCenter (out HPS.Point out_center)

Shows the center point for this SphereKey.

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

bool ShowRadius (out float out_radius)

Shows the radius for the SphereKey.

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

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

SphereKey (HPS.Key in_that): This constructor creates a SphereKey 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 Sphere key. Otherwise the copy will fail and the resulting SphereKey will be invalid.

SphereKey (HPS.SphereKey in_that)

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

Param in_that:	The source SphereKey to copy.