SphereAttributeKit

class HPS.SphereAttributeKit : HPS.Kit

The HPS.SphereAttributeKit class is a user space object, useful for carrying a group attribute settings. Calling HPS.SphereAttributeKit.GetDefault() will return a kit with values found in this table.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this object has any values set on it.

Return:true if no values are set on this object, false otherwise.

bool Equals (HPS.SphereAttributeKit in_kit)

Check if the source SphereAttributeKit is equivalent to this object.

Param in_kit:The source SphereAttributeKit to compare to this object. Return:true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

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.SphereAttributeKit in_kit)

Copies all settings from the source SphereAttributeKit into this object.

Param in_kit:The source SphereAttributeKit to copy.

HPS.SphereAttributeKit SetTessellation (ulong in_facets)

Sets the number of faces that should be generated around the equator of spheres.

Param in_facets:  the number of faces that should be generated around the equator of spheres. Return:A reference to this object.

void Show (out HPS.SphereAttributeKit out_kit)

Copies all settings from this SphereAttributeKit into the given SphereAttributeKit.

Param out_kit:The SphereAttributeKit to populate with the contents of this object.

bool ShowTessellation (out ulong out_facets)

Shows the number of faces that should be generated around the equator of spheres.

Param out_facets:  The number of faces that should be generated around the equator of spheres. Return:true if the setting is valid, false otherwise.

SphereAttributeKit ()

Initializes an empty kit.

SphereAttributeKit (HPS.SphereAttributeKit in_kit)

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

Param in_kit:The source object to copy.

HPS.SphereAttributeKit UnsetEverything ()

Removes all settings from this object.

Return:A reference to this object.

HPS.SphereAttributeKit UnsetTessellation ()

Removes the sphere tessellation setting.

Return:A reference to this object.

Public Static Functions

HPS.SphereAttributeKit GetDefault ()

Creates a SphereAttributeKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.

Return:A SphereAttributeKit with the default settings.

bool operator!= (HPS.SphereAttributeKit a, HPS.SphereAttributeKit b)

bool operator== (HPS.SphereAttributeKit a, HPS.SphereAttributeKit b)