< Home

< Table of Contents

REFERENCE MANUAL

HPS.ColorInterpolationKit Class Reference

The ColorInterpolationKit class is a user space object, useful for carrying a group attribute settings. More...

Inheritance diagram for HPS.ColorInterpolationKit:
HPS.Object

Public Member Functions

 ColorInterpolationKit ()
 Initializes an empty kit. More...
 
 ColorInterpolationKit (HPS.ColorInterpolationKit in_kit)
 Copies the kit in_kit into this kit. More...
 
override void Dispose ()
 
override bool Empty ()
 Returns whether this kit has any values currently set on it. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.ColorInterpolationKit in_kit)
 Compares the contents of in_kit and this kit. More...
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
void Set (HPS.ColorInterpolationKit in_kit)
 Copies the kit in_kit into this kit. More...
 
HPS.ColorInterpolationKit SetEdgeColor (bool in_state)
 Controls whether edge colors will be interpolated. More...
 
HPS.ColorInterpolationKit SetEdgeIndex (bool in_state)
 Controls whether edge index colors will be interpolated. More...
 
HPS.ColorInterpolationKit SetFaceColor (bool in_state)
 Controls whether face colors will be interpolated. More...
 
HPS.ColorInterpolationKit SetFaceIndex (bool in_state)
 Controls whether face colors index will be interpolated. More...
 
HPS.ColorInterpolationKit SetVertexColor (bool in_state)
 Controls whether vertex colors will be interpolated. More...
 
HPS.ColorInterpolationKit SetVertexIndex (bool in_state)
 Controls whether vertex index colors will be interpolated. More...
 
void Show (out HPS.ColorInterpolationKit out_kit)
 Copies this kit into out_kit. 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.ColorInterpolationKit UnsetEdgeColor ()
 Removes the edge color interpolation setting. More...
 
HPS.ColorInterpolationKit UnsetEdgeIndex ()
 Removes the edge index color interpolation setting. More...
 
HPS.ColorInterpolationKit UnsetEverything ()
 Unsets all settings in this kit. More...
 
HPS.ColorInterpolationKit UnsetFaceColor ()
 Removes the face color interpolation setting. More...
 
HPS.ColorInterpolationKit UnsetFaceIndex ()
 Removes the face index color interpolation setting. More...
 
HPS.ColorInterpolationKit UnsetVertexColor ()
 Removes the vertex color interpolation setting. More...
 
HPS.ColorInterpolationKit UnsetVertexIndex ()
 Removes the vertex index color interpolation 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. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
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. More...
 

Static Public Member Functions

static HPS.ColorInterpolationKit GetDefault ()
 
static bool operator!= (HPS.ColorInterpolationKit a, HPS.ColorInterpolationKit b)
 
static bool operator== (HPS.ColorInterpolationKit a, HPS.ColorInterpolationKit 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 ColorInterpolationKit class is a user space object, useful for carrying a group attribute settings.

Calling ColorInterpolationKit::GetDefault() will return a kit with values found in this table.

Constructor & Destructor Documentation

HPS.ColorInterpolationKit.ColorInterpolationKit ( )

Initializes an empty kit.

HPS.ColorInterpolationKit.ColorInterpolationKit ( HPS.ColorInterpolationKit  in_kit)

Copies the kit in_kit into this kit.

Member Function Documentation

override bool HPS.ColorInterpolationKit.Empty ( )
virtual

Returns whether this kit has any values currently set on it.

Reimplemented from HPS.Object.

bool HPS.ColorInterpolationKit.Equals ( HPS.ColorInterpolationKit  in_kit)

Compares the contents of in_kit and this kit.

override HPS.Type HPS.ColorInterpolationKit.ObjectType ( )
virtual

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.ColorInterpolationKit.Set ( HPS.ColorInterpolationKit  in_kit)

Copies the kit in_kit into this kit.

HPS.ColorInterpolationKit HPS.ColorInterpolationKit.SetEdgeColor ( bool  in_state)

Controls whether edge colors will be interpolated.

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

Controls whether edge index colors will be interpolated.

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

Controls whether face colors will be interpolated.

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

Controls whether face colors index will be interpolated.

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

Controls whether vertex colors will be interpolated.

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

Controls whether vertex index colors will be interpolated.

Parameters
in_stateWhether vertex index colors will be interpolated.
Returns
a reference to this object.
void HPS.ColorInterpolationKit.Show ( out HPS.ColorInterpolationKit  out_kit)

Copies this kit into out_kit.

bool HPS.ColorInterpolationKit.ShowEdgeColor ( out bool  out_state)

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.ColorInterpolationKit.ShowEdgeIndex ( out bool  out_state)

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.ColorInterpolationKit.ShowFaceColor ( out bool  out_state)

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.ColorInterpolationKit.ShowFaceIndex ( out bool  out_state)

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.ColorInterpolationKit.ShowVertexColor ( out bool  out_state)

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.ColorInterpolationKit.ShowVertexIndex ( out bool  out_state)

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.ColorInterpolationKit HPS.ColorInterpolationKit.UnsetEdgeColor ( )

Removes the edge color interpolation setting.

Returns
a reference to this object.
HPS.ColorInterpolationKit HPS.ColorInterpolationKit.UnsetEdgeIndex ( )

Removes the edge index color interpolation setting.

Returns
a reference to this object.
HPS.ColorInterpolationKit HPS.ColorInterpolationKit.UnsetEverything ( )

Unsets all settings in this kit.

Returns
a reference to this object.
HPS.ColorInterpolationKit HPS.ColorInterpolationKit.UnsetFaceColor ( )

Removes the face color interpolation setting.

Returns
a reference to this object.
HPS.ColorInterpolationKit HPS.ColorInterpolationKit.UnsetFaceIndex ( )

Removes the face index color interpolation setting.

Returns
a reference to this object.
HPS.ColorInterpolationKit HPS.ColorInterpolationKit.UnsetVertexColor ( )

Removes the vertex color interpolation setting.

Returns
a reference to this object.
HPS.ColorInterpolationKit HPS.ColorInterpolationKit.UnsetVertexIndex ( )

Removes the vertex index color interpolation setting.

Returns
a reference to this object.

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