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

Public Member Functions

 ColorInterpolationControl (HPS.SegmentKey in_seg)
 
 ColorInterpolationControl (HPS.ColorInterpolationControl in_that)
 
override void Dispose ()
 
override HPS.Type ObjectType ()
 
HPS.ColorInterpolationControl SetEdgeColor (bool in_state)
 
HPS.ColorInterpolationControl SetEdgeIndex (bool in_state)
 
HPS.ColorInterpolationControl SetFaceColor (bool in_state)
 
HPS.ColorInterpolationControl SetFaceIndex (bool in_state)
 
HPS.ColorInterpolationControl SetVertexColor (bool in_state)
 
HPS.ColorInterpolationControl SetVertexIndex (bool in_state)
 
bool ShowEdgeColor (out bool out_state)
 
bool ShowEdgeIndex (out bool out_state)
 
bool ShowFaceColor (out bool out_state)
 
bool ShowFaceIndex (out bool out_state)
 
bool ShowVertexColor (out bool out_state)
 
bool ShowVertexIndex (out bool out_state)
 
override HPS.Type Type ()
 
HPS.ColorInterpolationControl UnsetEdgeColor ()
 
HPS.ColorInterpolationControl UnsetEdgeIndex ()
 
HPS.ColorInterpolationControl UnsetEverything ()
 
HPS.ColorInterpolationControl UnsetFaceColor ()
 
HPS.ColorInterpolationControl UnsetFaceIndex ()
 
HPS.ColorInterpolationControl UnsetVertexColor ()
 
HPS.ColorInterpolationControl UnsetVertexIndex ()
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
override void Dispose ()
 
override HPS.Type ObjectType ()
 
override HPS.Type Type ()
 
- 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.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
 

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

◆ ColorInterpolationControl() [1/2]

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

Initializes a control tied to the segment in_seg.

◆ ColorInterpolationControl() [2/2]

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

Initializes a control tied to the same object as in_that.

Member Function Documentation

◆ ObjectType()

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

◆ SetEdgeColor()

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.

◆ SetEdgeIndex()

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.

◆ SetFaceColor()

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.

◆ SetFaceIndex()

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.

◆ SetVertexColor()

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.

◆ SetVertexIndex()

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.

◆ ShowEdgeColor()

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.

◆ ShowEdgeIndex()

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.

◆ ShowFaceColor()

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.

◆ ShowFaceIndex()

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.

◆ ShowVertexColor()

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.

◆ ShowVertexIndex()

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.

◆ Type()

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

◆ UnsetEdgeColor()

HPS.ColorInterpolationControl HPS.ColorInterpolationControl.UnsetEdgeColor ( )
inline

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

Returns
a reference to this object.

◆ UnsetEdgeIndex()

HPS.ColorInterpolationControl HPS.ColorInterpolationControl.UnsetEdgeIndex ( )
inline

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

Returns
a reference to this object.

◆ UnsetEverything()

HPS.ColorInterpolationControl HPS.ColorInterpolationControl.UnsetEverything ( )
inline

Unsets all settings in this control. If the control is attached to a WindowKey this function restores the default settings of this control as specified by ColorInterpolationKit.GetDefault().

Returns
a reference to this object.

◆ UnsetFaceColor()

HPS.ColorInterpolationControl HPS.ColorInterpolationControl.UnsetFaceColor ( )
inline

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

Returns
a reference to this object.

◆ UnsetFaceIndex()

HPS.ColorInterpolationControl HPS.ColorInterpolationControl.UnsetFaceIndex ( )
inline

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

Returns
a reference to this object.

◆ UnsetVertexColor()

HPS.ColorInterpolationControl HPS.ColorInterpolationControl.UnsetVertexColor ( )
inline

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

Returns
a reference to this object.

◆ UnsetVertexIndex()

HPS.ColorInterpolationControl HPS.ColorInterpolationControl.UnsetVertexIndex ( )
inline

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

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