HPS::ColorInterpolationControl Class Reference

#include <hps.h>

Inheritance diagram for HPS::ColorInterpolationControl:
HPS::Control HPS::Object

Public Member Functions

 ColorInterpolationControl (SegmentKey &in_seg)
 
 ColorInterpolationControl (ColorInterpolationControl const &in_that)
 
 ColorInterpolationControl (ColorInterpolationControl &&in_that)
 
HPS::Type ObjectType () const
 
ColorInterpolationControloperator= (ColorInterpolationControl &&in_that)
 
ColorInterpolationControloperator= (ColorInterpolationControl const &in_that)
 
ColorInterpolationControlSetEdgeColor (bool in_state)
 
ColorInterpolationControlSetEdgeIndex (bool in_state)
 
ColorInterpolationControlSetFaceColor (bool in_state)
 
ColorInterpolationControlSetFaceIndex (bool in_state)
 
ColorInterpolationControlSetVertexColor (bool in_state)
 
ColorInterpolationControlSetVertexIndex (bool in_state)
 
bool ShowEdgeColor (bool &out_state) const
 
bool ShowEdgeIndex (bool &out_state) const
 
bool ShowFaceColor (bool &out_state) const
 
bool ShowFaceIndex (bool &out_state) const
 
bool ShowVertexColor (bool &out_state) const
 
bool ShowVertexIndex (bool &out_state) const
 
virtual HPS::Type Type () const
 
ColorInterpolationControlUnsetEdgeColor ()
 
ColorInterpolationControlUnsetEdgeIndex ()
 
ColorInterpolationControlUnsetEverything ()
 
ColorInterpolationControlUnsetFaceColor ()
 
ColorInterpolationControlUnsetFaceIndex ()
 
ColorInterpolationControlUnsetVertexColor ()
 
ColorInterpolationControlUnsetVertexIndex ()
 
 ~ColorInterpolationControl ()
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::ColorInterpolationControl
 
- Static Public Attributes inherited from HPS::Control
static const HPS::Type staticType = HPS::Type::Control
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 
- Protected Member Functions inherited from HPS::Control
 Control (Control &&in_that)
 
Controloperator= (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

◆ ColorInterpolationControl() [1/3]

HPS::ColorInterpolationControl::ColorInterpolationControl ( SegmentKey in_seg)
explicit

Initializes a control tied to the segment in_seg.

◆ ColorInterpolationControl() [2/3]

HPS::ColorInterpolationControl::ColorInterpolationControl ( ColorInterpolationControl const &  in_that)

Initializes a control tied to the same object as in_that.

◆ ColorInterpolationControl() [3/3]

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_thatAn rvalue reference to a ColorInterpolationControl to take the impl from.

◆ ~ColorInterpolationControl()

HPS::ColorInterpolationControl::~ColorInterpolationControl ( )

Releases a reference to the database object this control is tied to.

Member Function Documentation

◆ ObjectType()

HPS::Type HPS::ColorInterpolationControl::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::Control.

◆ operator=() [1/2]

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_thatAn rvalue reference to a ColorInterpolationControl to take the impl from.
Returns
A reference to this ColorInterpolationControl.

◆ operator=() [2/2]

ColorInterpolationControl& HPS::ColorInterpolationControl::operator= ( ColorInterpolationControl const &  in_that)

Share the underlying smart-pointer of the ColorInterpolationControl source.

Parameters
in_thatThe ColorInterpolationControl source of the assignment.
Returns
A reference to this ColorInterpolationControl.

◆ SetEdgeColor()

ColorInterpolationControl& HPS::ColorInterpolationControl::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.

◆ SetEdgeIndex()

ColorInterpolationControl& HPS::ColorInterpolationControl::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.

◆ SetFaceColor()

ColorInterpolationControl& HPS::ColorInterpolationControl::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.

◆ SetFaceIndex()

ColorInterpolationControl& HPS::ColorInterpolationControl::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.

◆ SetVertexColor()

ColorInterpolationControl& HPS::ColorInterpolationControl::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.

◆ SetVertexIndex()

ColorInterpolationControl& HPS::ColorInterpolationControl::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.

◆ ShowEdgeColor()

bool HPS::ColorInterpolationControl::ShowEdgeColor ( bool &  out_state) const

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 ( bool &  out_state) const

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 ( bool &  out_state) const

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 ( bool &  out_state) const

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 ( bool &  out_state) const

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 ( bool &  out_state) const

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()

virtual HPS::Type HPS::ColorInterpolationControl::Type ( ) const
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::Control.

◆ UnsetEdgeColor()

ColorInterpolationControl& HPS::ColorInterpolationControl::UnsetEdgeColor ( )

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()

ColorInterpolationControl& HPS::ColorInterpolationControl::UnsetEdgeIndex ( )

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()

ColorInterpolationControl& HPS::ColorInterpolationControl::UnsetEverything ( )

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()

ColorInterpolationControl& HPS::ColorInterpolationControl::UnsetFaceColor ( )

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()

ColorInterpolationControl& HPS::ColorInterpolationControl::UnsetFaceIndex ( )

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()

ColorInterpolationControl& HPS::ColorInterpolationControl::UnsetVertexColor ( )

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()

ColorInterpolationControl& HPS::ColorInterpolationControl::UnsetVertexIndex ( )

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: