#include <hps.h>
|
static const HPS::Type | staticType = HPS::Type::ColorInterpolationKit |
|
static const HPS::Type | staticType = HPS::Type::Kit |
|
static const HPS::Type | staticType = HPS::Type::None |
|
The HPS::ColorInterpolationKit class is a user space object, useful for carrying a group attribute settings. Calling HPS::ColorInterpolationKit::GetDefault() will return a kit with values found in this table.
◆ ColorInterpolationKit() [1/3]
HPS::ColorInterpolationKit::ColorInterpolationKit |
( |
| ) |
|
Initializes an empty kit.
◆ ColorInterpolationKit() [2/3]
Copies the kit in_kit into this kit.
◆ ColorInterpolationKit() [3/3]
◆ ~ColorInterpolationKit()
virtual HPS::ColorInterpolationKit::~ColorInterpolationKit |
( |
| ) |
|
|
virtual |
◆ Empty()
bool HPS::ColorInterpolationKit::Empty |
( |
| ) |
const |
|
virtual |
Returns whether this kit has any values currently set on it.
Reimplemented from HPS::Object.
◆ Equals()
Compares the contents of in_kit and this kit.
◆ ObjectType()
HPS::Type HPS::ColorInterpolationKit::ObjectType |
( |
| ) |
const |
|
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::Kit.
◆ operator!=()
Compares the contents of in_kit and this kit.
◆ operator=() [1/2]
◆ operator=() [2/2]
Copies the kit in_kit into this kit.
◆ operator==()
Compares the contents of in_kit and this kit.
◆ Set()
Copies the kit in_kit into this kit.
◆ SetEdgeColor()
Controls whether edge colors will be interpolated.
- Parameters
-
in_state | Whether edge colors will be interpolated. |
- Returns
- a reference to this object.
◆ SetEdgeIndex()
Controls whether edge index colors will be interpolated.
- Parameters
-
in_state | Whether edge index colors will be interpolated. |
- Returns
- a reference to this object.
◆ SetFaceColor()
Controls whether face colors will be interpolated.
- Parameters
-
in_state | Whether face colors will be interpolated. |
- Returns
- a reference to this object.
◆ SetFaceIndex()
Controls whether face colors index will be interpolated.
- Parameters
-
in_state | Whether face index colors will be interpolated. |
- Returns
- a reference to this object.
◆ SetVertexColor()
Controls whether vertex colors will be interpolated.
- Parameters
-
in_state | Whether vertex colors will be interpolated. |
- Returns
- a reference to this object.
◆ SetVertexIndex()
Controls whether vertex index colors will be interpolated.
- Parameters
-
in_state | Whether vertex index colors will be interpolated. |
- Returns
- a reference to this object.
◆ Show()
Copies this kit into out_kit.
◆ ShowEdgeColor()
bool HPS::ColorInterpolationKit::ShowEdgeColor |
( |
bool & |
out_state | ) |
const |
Shows whether color interpolation for the edge color is set
- Parameters
-
out_state | The edge setting for the color interpolation |
- Returns
- true if the setting is valid, false otherwise.
◆ ShowEdgeIndex()
bool HPS::ColorInterpolationKit::ShowEdgeIndex |
( |
bool & |
out_state | ) |
const |
Shows whether color index interpolation for the edge index is set
- Parameters
-
out_state | The edge setting for the color index interpolation |
- Returns
- true if the setting is valid, false otherwise.
◆ ShowFaceColor()
bool HPS::ColorInterpolationKit::ShowFaceColor |
( |
bool & |
out_state | ) |
const |
Shows whether color interpolation for the face color is set
- Parameters
-
out_state | The face setting for the color interpolation |
- Returns
- true if the setting is valid, false otherwise.
◆ ShowFaceIndex()
bool HPS::ColorInterpolationKit::ShowFaceIndex |
( |
bool & |
out_state | ) |
const |
Shows whether color index interpolation for the face index is set
- Parameters
-
out_state | The face setting for the color index interpolation |
- Returns
- true if the setting is valid, false otherwise.
◆ ShowVertexColor()
bool HPS::ColorInterpolationKit::ShowVertexColor |
( |
bool & |
out_state | ) |
const |
Shows whether color interpolation for the vertex color is set
- Parameters
-
out_state | The vertex setting for the color interpolation |
- Returns
- true if the setting is valid, false otherwise.
◆ ShowVertexIndex()
bool HPS::ColorInterpolationKit::ShowVertexIndex |
( |
bool & |
out_state | ) |
const |
Shows whether color index interpolation for the vertex index is set
- Parameters
-
out_state | The vertex setting for the color index interpolation |
- Returns
- true if the setting is valid, false otherwise.
◆ UnsetEdgeColor()
Removes the edge color interpolation setting.
- Returns
- a reference to this object.
◆ UnsetEdgeIndex()
Removes the edge index color interpolation setting.
- Returns
- a reference to this object.
◆ UnsetEverything()
Unsets all settings in this kit.
- Returns
- a reference to this object.
◆ UnsetFaceColor()
Removes the face color interpolation setting.
- Returns
- a reference to this object.
◆ UnsetFaceIndex()
Removes the face index color interpolation setting.
- Returns
- a reference to this object.
◆ UnsetVertexColor()
Removes the vertex color interpolation setting.
- Returns
- a reference to this object.
◆ 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: