CylinderAttributeKit

class HPS.CylinderAttributeKit : public HPS.Kit

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

Public Functions

CylinderAttributeKit ()

Initializes an empty kit.

CylinderAttributeKit (HPS.CylinderAttributeKit in_kit)

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

Param in_kit

The source object to copy.

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

Check if the source CylinderAttributeKit is equivalent to this object.

Param in_kit

The source CylinderAttributeKit 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.CylinderAttributeKit in_kit)

Copies all settings from the source CylinderAttributeKit into this object.

Param in_kit

The source CylinderAttributeKit to copy.

HPS.CylinderAttributeKit SetOrientation (HPS.Cylinder.Orientation in_adjust)

Sets the orientation of colors and radii of cylinders. This can be used to invert the order of the radii and/or colors of all cylinders in a segment without editing each one.

Return

A reference to this object.

HPS.CylinderAttributeKit SetTessellation (ulong in_facets)

Sets the number of faces that should be generated around cylinders.

Param in_facets

the number of faces that should be generated around cylinders.

Return

A reference to this object.

void Show (out HPS.CylinderAttributeKit out_kit)

Copies all settings from this CylinderAttributeKit into the given CylinderAttributeKit.

Param out_kit

The CylinderAttributeKit to populate with the contents of this object.

bool ShowOrientation (out HPS.Cylinder.Orientation out_orientation)

Shows the orientation of colors and radii of cylinders.

Param out_orientation

The orientation of colors and radii of cylinders.

Return

true if the setting is valid, false otherwise.

bool ShowTessellation (out ulong out_facets)

Shows the number of faces that should be generated around cylinders.

Param out_facets

The number of faces that should be generated around cylinders

Return

true if the setting is valid, false otherwise.

HPS.CylinderAttributeKit UnsetEverything ()

Removes all settings from this object.

Return

A reference to this object.

HPS.CylinderAttributeKit UnsetOrientation ()

Removes the cylinder orientation setting.

Return

A reference to this object.

HPS.CylinderAttributeKit UnsetTessellation ()

Removes the cylinder tessellation setting.

Return

A reference to this object.

Public Static Functions

HPS.CylinderAttributeKit GetDefault ()

Creates a CylinderAttributeKit 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 CylinderAttributeKit with the default settings.

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

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