#include <hps.h>

Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
Control (Control &&in_that) | |
Control & | operator= (Control &&in_that) |
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
|
explicit |
Initializes a control tied to the segment in_seg.
HPS::ColorInterpolationControl::ColorInterpolationControl | ( | ColorInterpolationControl const & | in_that | ) |
Initializes a control tied to the same object as in_that.
HPS::ColorInterpolationControl::ColorInterpolationControl | ( | ColorInterpolationControl && | in_that | ) |
The move constructor creates a ColorInterpolationControl by transferring the underlying impl of the rvalue reference to this ColorInterpolationControl thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to a ColorInterpolationControl to take the impl from.
HPS::ColorInterpolationControl::~ColorInterpolationControl | ( | ) |
Releases a reference to the database object this control is tied to.
Member Function Documentation
|
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::Control.
ColorInterpolationControl& HPS::ColorInterpolationControl::operator= | ( | ColorInterpolationControl && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this ColorInterpolationControl thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to a ColorInterpolationControl to take the impl from.
- Returns
- A reference to this ColorInterpolationControl.
ColorInterpolationControl& HPS::ColorInterpolationControl::operator= | ( | ColorInterpolationControl const & | in_that | ) |
Share the underlying smart-pointer of the ColorInterpolationControl source.
- Parameters
-
in_that The ColorInterpolationControl source of the assignment.
- Returns
- A reference to this ColorInterpolationControl.
ColorInterpolationControl& HPS::ColorInterpolationControl::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.
ColorInterpolationControl& HPS::ColorInterpolationControl::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.
ColorInterpolationControl& HPS::ColorInterpolationControl::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.
ColorInterpolationControl& HPS::ColorInterpolationControl::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.
ColorInterpolationControl& HPS::ColorInterpolationControl::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.
ColorInterpolationControl& HPS::ColorInterpolationControl::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.
bool HPS::ColorInterpolationControl::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::ColorInterpolationControl::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::ColorInterpolationControl::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::ColorInterpolationControl::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::ColorInterpolationControl::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::ColorInterpolationControl::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.
|
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.
- Returns
- The true type of the object in question.
Reimplemented from HPS::Control.
ColorInterpolationControl& HPS::ColorInterpolationControl::UnsetEdgeColor | ( | ) |
Removes the edge color interpolation setting.
- Returns
- a reference to this object.
ColorInterpolationControl& HPS::ColorInterpolationControl::UnsetEdgeIndex | ( | ) |
Removes the edge index color interpolation setting.
- Returns
- a reference to this object.
ColorInterpolationControl& HPS::ColorInterpolationControl::UnsetEverything | ( | ) |
Unsets all settings in this control.
- Returns
- a reference to this object.
ColorInterpolationControl& HPS::ColorInterpolationControl::UnsetFaceColor | ( | ) |
Removes the face color interpolation setting.
- Returns
- a reference to this object.
ColorInterpolationControl& HPS::ColorInterpolationControl::UnsetFaceIndex | ( | ) |
Removes the face index color interpolation setting.
- Returns
- a reference to this object.
ColorInterpolationControl& HPS::ColorInterpolationControl::UnsetVertexColor | ( | ) |
Removes the vertex color interpolation setting.
- Returns
- a reference to this object.
ColorInterpolationControl& HPS::ColorInterpolationControl::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