LightingAttributeKit

class HPS.LightingAttributeKit : HPS.Kit

The HPS.LightingAttributeKit class is a user space object, useful for carrying a group attribute settings. Calling HPS.LightingAttributeKit.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.LightingAttributeKit in_kit)

Check if the source LightingAttributeKit is equivalent to this object.

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

override bool Equals (Object obj)

override int GetHashCode ()

LightingAttributeKit ()

Initializes an empty kit.

LightingAttributeKit (HPS.LightingAttributeKit in_kit)

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

Param in_kit:The source object to copy.

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

Copies all settings from the source LightingAttributeKit into this object.

Param in_kit:The source LightingAttributeKit to copy.

HPS.LightingAttributeKit SetInterpolationAlgorithm (HPS.Lighting.InterpolationAlgorithm in_interpolation)

Sets the interpolation algorithm that will be used for rendering lit faces.

Param in_interpolation:  The algorithm that will be used for rendering lit faces. Return:A reference to this object.

void Show (out HPS.LightingAttributeKit out_kit)

Copies all settings from this LightingAttributeKit into the given LightingAttributeKit.

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

bool ShowInterpolationAlgorithm (out HPS.Lighting.InterpolationAlgorithm out_interpolation)

Shows the interpolation algorithm that will be used for rendering lit faces.

Param out_interpolation:  The algorithm that will be used for rendering lit faces. Return:true if the setting is valid, false otherwise.

HPS.LightingAttributeKit UnsetEverything ()

Removes all settings from this object.

Return:A reference to this object.

HPS.LightingAttributeKit UnsetInterpolationAlgorithm ()

Removes the interpolation algorithm setting.

Return:A reference to this object.

Public Static Functions

HPS.LightingAttributeKit GetDefault ()

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

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

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