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. More...

Inheritance diagram for HPS.LightingAttributeKit:
HPS.Object

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. This does not necessarily give the true type of the underlying object. 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...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object that)
 
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. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More...
 

Static Public Member Functions

static 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. More...
 
static bool operator!= (HPS.LightingAttributeKit a, HPS.LightingAttributeKit b)
 
static bool operator== (HPS.LightingAttributeKit a, HPS.LightingAttributeKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

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.

Constructor & Destructor Documentation

HPS.LightingAttributeKit.LightingAttributeKit ( )
inline

Initializes an empty kit.

HPS.LightingAttributeKit.LightingAttributeKit ( HPS.LightingAttributeKit  in_kit)
inline

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

Parameters
in_kitThe source object to copy.

Member Function Documentation

override bool HPS.LightingAttributeKit.Empty ( )
inlinevirtual

Indicates whether this object has any values set on it.

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

Reimplemented from HPS.Object.

bool HPS.LightingAttributeKit.Equals ( HPS.LightingAttributeKit  in_kit)
inline

Check if the source LightingAttributeKit is equivalent to this object.

Parameters
in_kitThe source LightingAttributeKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.
static HPS.LightingAttributeKit HPS.LightingAttributeKit.GetDefault ( )
inlinestatic

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.

Returns
A LightingAttributeKit with the default settings.
override HPS.Type HPS.LightingAttributeKit.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Object.

void HPS.LightingAttributeKit.Set ( HPS.LightingAttributeKit  in_kit)
inline

Copies all settings from the source LightingAttributeKit into this object.

Parameters
in_kitThe source LightingAttributeKit to copy.
HPS.LightingAttributeKit HPS.LightingAttributeKit.SetInterpolationAlgorithm ( HPS.Lighting.InterpolationAlgorithm  in_interpolation)
inline

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

Parameters
in_interpolationThe algorithm that will be used for rendering lit faces.
Returns
A reference to this object.
void HPS.LightingAttributeKit.Show ( out HPS.LightingAttributeKit  out_kit)
inline

Copies all settings from this LightingAttributeKit into the given LightingAttributeKit.

Parameters
out_kitThe LightingAttributeKit to populate with the contents of this object.
bool HPS.LightingAttributeKit.ShowInterpolationAlgorithm ( out HPS.Lighting.InterpolationAlgorithm  out_interpolation)
inline

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

Parameters
out_interpolationThe algorithm that will be used for rendering lit faces.
Returns
true if the setting is valid, false otherwise.
HPS.LightingAttributeKit HPS.LightingAttributeKit.UnsetEverything ( )
inline

Removes all settings from this object.

Returns
A reference to this object.
HPS.LightingAttributeKit HPS.LightingAttributeKit.UnsetInterpolationAlgorithm ( )
inline

Removes the interpolation algorithm setting.

Returns
A reference to this object.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.LightingAttributeKit.cs