HPS.ColorInterpolationControl Class Reference

The HPS::ColorInterpolationControl class is a smart pointer that is tied to a database object. This class is the interface that allows you to manipulate whether color is interpolated over faces and edges. This table lists default values for the various segment attributes accessible from HPS::ColorInterpolationControl. More...

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

Public Member Functions

 ColorInterpolationControl (HPS.SegmentKey in_seg)
 Initializes a control tied to the segment in_seg. More...
 
 ColorInterpolationControl (HPS.ColorInterpolationControl in_that)
 Initializes a control tied to the same object as in_that. More...
 
override void Dispose ()
 
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.ColorInterpolationControl SetEdgeColor (bool in_state)
 Controls whether edge colors will be interpolated. More...
 
HPS.ColorInterpolationControl SetEdgeIndex (bool in_state)
 Controls whether edge index colors will be interpolated. More...
 
HPS.ColorInterpolationControl SetFaceColor (bool in_state)
 Controls whether face colors will be interpolated. More...
 
HPS.ColorInterpolationControl SetFaceIndex (bool in_state)
 Controls whether face colors index will be interpolated. More...
 
HPS.ColorInterpolationControl SetVertexColor (bool in_state)
 Controls whether vertex colors will be interpolated. More...
 
HPS.ColorInterpolationControl SetVertexIndex (bool in_state)
 Controls whether vertex index colors will be interpolated. More...
 
bool ShowEdgeColor (out bool out_state)
 Shows whether color interpolation for the edge color is set More...
 
bool ShowEdgeIndex (out bool out_state)
 Shows whether color index interpolation for the edge index is set More...
 
bool ShowFaceColor (out bool out_state)
 Shows whether color interpolation for the face color is set More...
 
bool ShowFaceIndex (out bool out_state)
 Shows whether color index interpolation for the face index is set More...
 
bool ShowVertexColor (out bool out_state)
 Shows whether color interpolation for the vertex color is set More...
 
bool ShowVertexIndex (out bool out_state)
 Shows whether color index interpolation for the vertex index is set More...
 
HPS.ColorInterpolationControl UnsetEdgeColor ()
 Removes the edge color interpolation setting. More...
 
HPS.ColorInterpolationControl UnsetEdgeIndex ()
 Removes the edge index color interpolation setting. More...
 
HPS.ColorInterpolationControl UnsetEverything ()
 Unsets all settings in this control. More...
 
HPS.ColorInterpolationControl UnsetFaceColor ()
 Removes the face color interpolation setting. More...
 
HPS.ColorInterpolationControl UnsetFaceIndex ()
 Removes the face index color interpolation setting. More...
 
HPS.ColorInterpolationControl UnsetVertexColor ()
 Removes the vertex color interpolation setting. More...
 
HPS.ColorInterpolationControl UnsetVertexIndex ()
 Removes the vertex index color interpolation setting. More...
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
override void Dispose ()
 
- 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.Control
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::ColorInterpolationControl class is a smart pointer that is tied to a database object. This class is the interface that allows you to manipulate whether color is interpolated over faces and edges. This table lists default values for the various segment attributes accessible from HPS::ColorInterpolationControl.

Constructor & Destructor Documentation

HPS.ColorInterpolationControl.ColorInterpolationControl ( HPS.SegmentKey  in_seg)
inline

Initializes a control tied to the segment in_seg.

HPS.ColorInterpolationControl.ColorInterpolationControl ( HPS.ColorInterpolationControl  in_that)
inline

Initializes a control tied to the same object as in_that.

Member Function Documentation

override HPS.Type HPS.ColorInterpolationControl.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.ColorInterpolationControl HPS.ColorInterpolationControl.SetEdgeColor ( bool  in_state)
inline

Controls whether edge colors will be interpolated.

Parameters
in_stateWhether edge colors will be interpolated.
Returns
a reference to this object.
HPS.ColorInterpolationControl HPS.ColorInterpolationControl.SetEdgeIndex ( bool  in_state)
inline

Controls whether edge index colors will be interpolated.

Parameters
in_stateWhether edge index colors will be interpolated.
Returns
a reference to this object.
HPS.ColorInterpolationControl HPS.ColorInterpolationControl.SetFaceColor ( bool  in_state)
inline

Controls whether face colors will be interpolated.

Parameters
in_stateWhether face colors will be interpolated.
Returns
a reference to this object.
HPS.ColorInterpolationControl HPS.ColorInterpolationControl.SetFaceIndex ( bool  in_state)
inline

Controls whether face colors index will be interpolated.

Parameters
in_stateWhether face index colors will be interpolated.
Returns
a reference to this object.
HPS.ColorInterpolationControl HPS.ColorInterpolationControl.SetVertexColor ( bool  in_state)
inline

Controls whether vertex colors will be interpolated.

Parameters
in_stateWhether vertex colors will be interpolated.
Returns
a reference to this object.
HPS.ColorInterpolationControl HPS.ColorInterpolationControl.SetVertexIndex ( bool  in_state)
inline

Controls whether vertex index colors will be interpolated.

Parameters
in_stateWhether vertex index colors will be interpolated.
Returns
a reference to this object.
bool HPS.ColorInterpolationControl.ShowEdgeColor ( out bool  out_state)
inline

Shows whether color interpolation for the edge color is set

Parameters
out_stateThe edge setting for the color interpolation
Returns
true if the setting is valid, false otherwise.
bool HPS.ColorInterpolationControl.ShowEdgeIndex ( out bool  out_state)
inline

Shows whether color index interpolation for the edge index is set

Parameters
out_stateThe edge setting for the color index interpolation
Returns
true if the setting is valid, false otherwise.
bool HPS.ColorInterpolationControl.ShowFaceColor ( out bool  out_state)
inline

Shows whether color interpolation for the face color is set

Parameters
out_stateThe face setting for the color interpolation
Returns
true if the setting is valid, false otherwise.
bool HPS.ColorInterpolationControl.ShowFaceIndex ( out bool  out_state)
inline

Shows whether color index interpolation for the face index is set

Parameters
out_stateThe face setting for the color index interpolation
Returns
true if the setting is valid, false otherwise.
bool HPS.ColorInterpolationControl.ShowVertexColor ( out bool  out_state)
inline

Shows whether color interpolation for the vertex color is set

Parameters
out_stateThe vertex setting for the color interpolation
Returns
true if the setting is valid, false otherwise.
bool HPS.ColorInterpolationControl.ShowVertexIndex ( out bool  out_state)
inline

Shows whether color index interpolation for the vertex index is set

Parameters
out_stateThe vertex setting for the color index interpolation
Returns
true if the setting is valid, false otherwise.
HPS.ColorInterpolationControl HPS.ColorInterpolationControl.UnsetEdgeColor ( )
inline

Removes the edge color interpolation setting.

Returns
a reference to this object.
HPS.ColorInterpolationControl HPS.ColorInterpolationControl.UnsetEdgeIndex ( )
inline

Removes the edge index color interpolation setting.

Returns
a reference to this object.
HPS.ColorInterpolationControl HPS.ColorInterpolationControl.UnsetEverything ( )
inline

Unsets all settings in this control.

Returns
a reference to this object.
HPS.ColorInterpolationControl HPS.ColorInterpolationControl.UnsetFaceColor ( )
inline

Removes the face color interpolation setting.

Returns
a reference to this object.
HPS.ColorInterpolationControl HPS.ColorInterpolationControl.UnsetFaceIndex ( )
inline

Removes the face index color interpolation setting.

Returns
a reference to this object.
HPS.ColorInterpolationControl HPS.ColorInterpolationControl.UnsetVertexColor ( )
inline

Removes the vertex color interpolation setting.

Returns
a reference to this object.
HPS.ColorInterpolationControl HPS.ColorInterpolationControl.UnsetVertexIndex ( )
inline

Removes the vertex index color interpolation setting.

Returns
a reference to this object.

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