#include <hps.h>

Static Public Member Functions | |
static ColorInterpolationKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Detailed Description
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.
Constructor & Destructor Documentation
HPS::ColorInterpolationKit::ColorInterpolationKit | ( | ) |
Initializes an empty kit.
HPS::ColorInterpolationKit::ColorInterpolationKit | ( | ColorInterpolationKit const & | in_kit | ) |
Copies the kit in_kit into this kit.
HPS::ColorInterpolationKit::ColorInterpolationKit | ( | ColorInterpolationKit && | in_that | ) |
The move constructor creates a ColorInterpolationKit by transferring the underlying impl of the rvalue reference to this ColorInterpolationKit thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to a ColorInterpolationKit to take the impl from.
|
virtual |
Destroy this kit.
Member Function Documentation
|
virtual |
Returns whether this kit has any values currently set on it.
Reimplemented from HPS::Object.
bool HPS::ColorInterpolationKit::Equals | ( | ColorInterpolationKit const & | in_kit | ) | const |
Compares the contents of in_kit and this kit.
|
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.
bool HPS::ColorInterpolationKit::operator!= | ( | ColorInterpolationKit const & | in_kit | ) | const |
Compares the contents of in_kit and this kit.
ColorInterpolationKit& HPS::ColorInterpolationKit::operator= | ( | ColorInterpolationKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this ColorInterpolationKit thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to an ColorInterpolationKit to take the impl from.
- Returns
- A reference to this ColorInterpolationKit.
ColorInterpolationKit& HPS::ColorInterpolationKit::operator= | ( | ColorInterpolationKit const & | in_kit | ) |
Copies the kit in_kit into this kit.
bool HPS::ColorInterpolationKit::operator== | ( | ColorInterpolationKit const & | in_kit | ) | const |
Compares the contents of in_kit and this kit.
void HPS::ColorInterpolationKit::Set | ( | ColorInterpolationKit const & | in_kit | ) |
Copies the kit in_kit into this kit.
ColorInterpolationKit& HPS::ColorInterpolationKit::SetEdgeColor | ( | bool | in_state | ) |
Controls whether edge colors will be interpolated.
- Parameters
-
in_state Whether edge colors will be interpolated.
- Returns
- a reference to this object.
ColorInterpolationKit& HPS::ColorInterpolationKit::SetEdgeIndex | ( | bool | in_state | ) |
Controls whether edge index colors will be interpolated.
- Parameters
-
in_state Whether edge index colors will be interpolated.
- Returns
- a reference to this object.
ColorInterpolationKit& HPS::ColorInterpolationKit::SetFaceColor | ( | bool | in_state | ) |
Controls whether face colors will be interpolated.
- Parameters
-
in_state Whether face colors will be interpolated.
- Returns
- a reference to this object.
ColorInterpolationKit& HPS::ColorInterpolationKit::SetFaceIndex | ( | bool | in_state | ) |
Controls whether face colors index will be interpolated.
- Parameters
-
in_state Whether face index colors will be interpolated.
- Returns
- a reference to this object.
ColorInterpolationKit& HPS::ColorInterpolationKit::SetVertexColor | ( | bool | in_state | ) |
Controls whether vertex colors will be interpolated.
- Parameters
-
in_state Whether vertex colors will be interpolated.
- Returns
- a reference to this object.
ColorInterpolationKit& HPS::ColorInterpolationKit::SetVertexIndex | ( | bool | in_state | ) |
Controls whether vertex index colors will be interpolated.
- Parameters
-
in_state Whether vertex index colors will be interpolated.
- Returns
- a reference to this object.
void HPS::ColorInterpolationKit::Show | ( | ColorInterpolationKit & | out_kit | ) | const |
Copies this kit into out_kit.
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.
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.
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.
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.
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.
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.
ColorInterpolationKit& HPS::ColorInterpolationKit::UnsetEdgeColor | ( | ) |
Removes the edge color interpolation setting.
- Returns
- a reference to this object.
ColorInterpolationKit& HPS::ColorInterpolationKit::UnsetEdgeIndex | ( | ) |
Removes the edge index color interpolation setting.
- Returns
- a reference to this object.
ColorInterpolationKit& HPS::ColorInterpolationKit::UnsetEverything | ( | ) |
Unsets all settings in this kit.
- Returns
- a reference to this object.
ColorInterpolationKit& HPS::ColorInterpolationKit::UnsetFaceColor | ( | ) |
Removes the face color interpolation setting.
- Returns
- a reference to this object.
ColorInterpolationKit& HPS::ColorInterpolationKit::UnsetFaceIndex | ( | ) |
Removes the face index color interpolation setting.
- Returns
- a reference to this object.
ColorInterpolationKit& HPS::ColorInterpolationKit::UnsetVertexColor | ( | ) |
Removes the vertex color interpolation setting.
- Returns
- a reference to this object.
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:
- include/hps.h