HPS.LightingAttributeControl Class Reference
Inheritance diagram for HPS.LightingAttributeControl:
HPS.Control HPS.Object

Public Member Functions

override void Dispose ()
 
 LightingAttributeControl (HPS.SegmentKey in_seg)
 
 LightingAttributeControl (HPS.LightingAttributeControl in_that)
 
override HPS.Type ObjectType ()
 
HPS.LightingAttributeControl SetInterpolationAlgorithm (HPS.Lighting.InterpolationAlgorithm in_interpolation)
 
bool ShowInterpolationAlgorithm (out HPS.Lighting.InterpolationAlgorithm out_interpolation)
 
override HPS.Type Type ()
 
HPS.LightingAttributeControl UnsetEverything ()
 
HPS.LightingAttributeControl UnsetInterpolationAlgorithm ()
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Protected Member Functions

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

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The HPS.LightingAttributeControl class is a smart pointer that is tied to a database object. This control is used to set the lighting interpolation algorithm.

This table lists default values for the various segment attributes accessible from HPS.LightingAttributeControl.

Constructor & Destructor Documentation

◆ LightingAttributeControl() [1/2]

HPS.LightingAttributeControl.LightingAttributeControl ( HPS.SegmentKey  in_seg)
inline

Initializes a control tied to the segment in_seg.

◆ LightingAttributeControl() [2/2]

HPS.LightingAttributeControl.LightingAttributeControl ( HPS.LightingAttributeControl  in_that)
inline

Initializes a control tied to the same object as in_that.

Member Function Documentation

◆ ObjectType()

override HPS.Type HPS.LightingAttributeControl.ObjectType ( )
inlinevirtual

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

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

Reimplemented from HPS.Control.

◆ SetInterpolationAlgorithm()

HPS.LightingAttributeControl HPS.LightingAttributeControl.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.

◆ ShowInterpolationAlgorithm()

bool HPS.LightingAttributeControl.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.

◆ Type()

override HPS.Type HPS.LightingAttributeControl.Type ( )
inlinevirtual

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.

Warning
This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
Returns
The true type of the object in question.

Reimplemented from HPS.Control.

◆ UnsetEverything()

HPS.LightingAttributeControl HPS.LightingAttributeControl.UnsetEverything ( )
inline

Removes all settings from this object. If the control is attached to a WindowKey this function restores the default settings of this control as specified by LightingAttributeKit.GetDefault().

Returns
A reference to this object.

◆ UnsetInterpolationAlgorithm()

HPS.LightingAttributeControl HPS.LightingAttributeControl.UnsetInterpolationAlgorithm ( )
inline

Removes the interpolation algorithm setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by LightingAttributeKit.GetDefault().

Returns
A reference to this object.

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