Overview

Sample Code

Programming Guide

API Reference

Support

HPS.LightingAttributeControl Class Reference

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

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

Public Member Functions

override void Dispose ()
 
 LightingAttributeControl (HPS.SegmentKey in_seg)
 Initializes a control tied to the segment in_seg. More...
 
 LightingAttributeControl (HPS.LightingAttributeControl in_that)
 Initializes a control tied to the same object as in_that. 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...
 
HPS.LightingAttributeControl SetInterpolationAlgorithm (HPS.Lighting.InterpolationAlgorithm in_interpolation)
 Sets the interpolation algorithm that will be used for rendering lit faces. More...
 
bool ShowInterpolationAlgorithm (out HPS.Lighting.InterpolationAlgorithm out_interpolation)
 Shows the interpolation algorithm that will be used for rendering lit faces. More...
 
HPS.LightingAttributeControl UnsetEverything ()
 Removes all settings from this object. More...
 
HPS.LightingAttributeControl UnsetInterpolationAlgorithm ()
 Removes the interpolation algorithm setting. More...
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
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...
 

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
 
HandleRef scptr
 

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

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

Initializes a control tied to the segment in_seg.

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

Initializes a control tied to the same object as in_that.

Member Function Documentation

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

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.
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.
HPS.LightingAttributeControl HPS.LightingAttributeControl.UnsetEverything ( )
inline

Removes all settings from this object.

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

Removes the interpolation algorithm setting.

Returns
A reference to this object.

The documentation for this class was generated from the following file: