REFERENCE MANUAL
The LightingAttributeKit class is a user space object, useful for carrying a group attribute settings. More...
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this object has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.LightingAttributeKit in_kit) |
Check if the source LightingAttributeKit is equivalent to this object. More... | |
override int | GetHashCode () |
LightingAttributeKit () | |
Initializes an empty kit. More... | |
LightingAttributeKit (HPS.LightingAttributeKit in_kit) | |
The copy constructor creates a new LightingAttributeKit object that contains the same settings as the source object. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
void | Set (HPS.LightingAttributeKit in_kit) |
Copies all settings from the source LightingAttributeKit into this object. More... | |
HPS.LightingAttributeKit | SetInterpolationAlgorithm (HPS.Lighting.InterpolationAlgorithm in_interpolation) |
Sets the interpolation algorithm that will be used for rendering lit faces. More... | |
void | Show (out HPS.LightingAttributeKit out_kit) |
Copies all settings from this LightingAttributeKit into the given LightingAttributeKit. More... | |
bool | ShowInterpolationAlgorithm (out HPS.Lighting.InterpolationAlgorithm out_interpolation) |
Shows the interpolation algorithm that will be used for rendering lit faces. More... | |
HPS.LightingAttributeKit | UnsetEverything () |
Removes all settings from this object. More... | |
HPS.LightingAttributeKit | UnsetInterpolationAlgorithm () |
Removes the interpolation algorithm setting. More... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Static Public Member Functions | |
static HPS.LightingAttributeKit | GetDefault () |
Creates a LightingAttributeKit which contains the default settings. More... | |
static bool | operator!= (HPS.LightingAttributeKit a, HPS.LightingAttributeKit b) |
static bool | operator== (HPS.LightingAttributeKit a, HPS.LightingAttributeKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The LightingAttributeKit class is a user space object, useful for carrying a group attribute settings.
Calling LightingAttributeKit::GetDefault() will return a kit with values found in this table.
HPS.LightingAttributeKit.LightingAttributeKit | ( | ) |
Initializes an empty kit.
HPS.LightingAttributeKit.LightingAttributeKit | ( | HPS.LightingAttributeKit | in_kit | ) |
The copy constructor creates a new LightingAttributeKit object that contains the same settings as the source object.
in_kit | The source object to copy. |
|
virtual |
Indicates whether this object has any values set on it.
Reimplemented from HPS.Object.
bool HPS.LightingAttributeKit.Equals | ( | HPS.LightingAttributeKit | in_kit | ) |
Check if the source LightingAttributeKit is equivalent to this object.
in_kit | The source <ref refid="class_h_p_s_1_1_lighting_attribute_kit" kindref="compound">LightingAttributeKit</ref> to compare to this object. |
|
static |
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.
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
void HPS.LightingAttributeKit.Set | ( | HPS.LightingAttributeKit | in_kit | ) |
Copies all settings from the source LightingAttributeKit into this object.
in_kit | The source <ref refid="class_h_p_s_1_1_lighting_attribute_kit" kindref="compound">LightingAttributeKit</ref> to copy. |
HPS.LightingAttributeKit HPS.LightingAttributeKit.SetInterpolationAlgorithm | ( | HPS.Lighting.InterpolationAlgorithm | in_interpolation | ) |
Sets the interpolation algorithm that will be used for rendering lit faces.
in_interpolation | The algorithm that will be used for rendering lit faces. |
void HPS.LightingAttributeKit.Show | ( | out HPS.LightingAttributeKit | out_kit | ) |
Copies all settings from this LightingAttributeKit into the given LightingAttributeKit.
out_kit | The <ref refid="class_h_p_s_1_1_lighting_attribute_kit" kindref="compound">LightingAttributeKit</ref> to populate with the contents of this object. |
bool HPS.LightingAttributeKit.ShowInterpolationAlgorithm | ( | out HPS.Lighting.InterpolationAlgorithm | out_interpolation | ) |
Shows the interpolation algorithm that will be used for rendering lit faces.
out_interpolation | The algorithm that will be used for rendering lit faces. |
HPS.LightingAttributeKit HPS.LightingAttributeKit.UnsetEverything | ( | ) |
Removes all settings from this object.
HPS.LightingAttributeKit HPS.LightingAttributeKit.UnsetInterpolationAlgorithm | ( | ) |
Removes the interpolation algorithm setting.