#include <hps.h>

Inheritance diagram for HPS::ColorInterpolationKit:
HPS::Kit HPS::Object

Public Member Functions

 ColorInterpolationKit ()
 
 ColorInterpolationKit (ColorInterpolationKit const &in_kit)
 
 ColorInterpolationKit (ColorInterpolationKit &&in_that)
 
bool Empty () const
 
bool Equals (ColorInterpolationKit const &in_kit) const
 
HPS::Type ObjectType () const
 
bool operator!= (ColorInterpolationKit const &in_kit) const
 
ColorInterpolationKitoperator= (ColorInterpolationKit &&in_that)
 
ColorInterpolationKitoperator= (ColorInterpolationKit const &in_kit)
 
bool operator== (ColorInterpolationKit const &in_kit) const
 
void Set (ColorInterpolationKit const &in_kit)
 
ColorInterpolationKitSetEdgeColor (bool in_state)
 
ColorInterpolationKitSetEdgeIndex (bool in_state)
 
ColorInterpolationKitSetFaceColor (bool in_state)
 
ColorInterpolationKitSetFaceIndex (bool in_state)
 
ColorInterpolationKitSetVertexColor (bool in_state)
 
ColorInterpolationKitSetVertexIndex (bool in_state)
 
void Show (ColorInterpolationKit &out_kit) const
 
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
 
ColorInterpolationKitUnsetEdgeColor ()
 
ColorInterpolationKitUnsetEdgeIndex ()
 
ColorInterpolationKitUnsetEverything ()
 
ColorInterpolationKitUnsetFaceColor ()
 
ColorInterpolationKitUnsetFaceIndex ()
 
ColorInterpolationKitUnsetVertexColor ()
 
ColorInterpolationKitUnsetVertexIndex ()
 
virtual ~ColorInterpolationKit ()
 
- Public Member Functions inherited from HPS::Kit
virtual HPS::Type Type () const
 
- Public Member Functions inherited from HPS::Object
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 Member Functions

static ColorInterpolationKit GetDefault ()
 
- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::ColorInterpolationKit
 
- Static Public Attributes inherited from HPS::Kit
static const HPS::Type staticType = HPS::Type::Kit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (Kit &&in_that)
 

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

◆ ColorInterpolationKit() [1/3]

HPS::ColorInterpolationKit::ColorInterpolationKit ( )

Initializes an empty kit.

◆ ColorInterpolationKit() [2/3]

HPS::ColorInterpolationKit::ColorInterpolationKit ( ColorInterpolationKit const &  in_kit)

Copies the kit in_kit into this kit.

◆ ColorInterpolationKit() [3/3]

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

◆ ~ColorInterpolationKit()

virtual HPS::ColorInterpolationKit::~ColorInterpolationKit ( )
virtual

Destroy this kit.

Member Function Documentation

◆ Empty()

bool HPS::ColorInterpolationKit::Empty ( ) const
virtual

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

Reimplemented from HPS::Object.

◆ Equals()

bool HPS::ColorInterpolationKit::Equals ( ColorInterpolationKit const &  in_kit) const

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

bool HPS::ColorInterpolationKit::operator!= ( ColorInterpolationKit const &  in_kit) const

Compares the contents of in_kit and this kit.

◆ operator=() [1/2]

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

◆ operator=() [2/2]

ColorInterpolationKit& HPS::ColorInterpolationKit::operator= ( ColorInterpolationKit const &  in_kit)

Copies the kit in_kit into this kit.

◆ operator==()

bool HPS::ColorInterpolationKit::operator== ( ColorInterpolationKit const &  in_kit) const

Compares the contents of in_kit and this kit.

◆ Set()

void HPS::ColorInterpolationKit::Set ( ColorInterpolationKit const &  in_kit)

Copies the kit in_kit into this kit.

◆ SetEdgeColor()

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.

◆ SetEdgeIndex()

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.

◆ SetFaceColor()

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.

◆ SetFaceIndex()

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.

◆ SetVertexColor()

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.

◆ SetVertexIndex()

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.

◆ Show()

void HPS::ColorInterpolationKit::Show ( ColorInterpolationKit out_kit) const

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_stateThe 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_stateThe 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_stateThe 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_stateThe 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_stateThe 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_stateThe vertex setting for the color index interpolation
Returns
true if the setting is valid, false otherwise.

◆ UnsetEdgeColor()

ColorInterpolationKit& HPS::ColorInterpolationKit::UnsetEdgeColor ( )

Removes the edge color interpolation setting.

Returns
a reference to this object.

◆ UnsetEdgeIndex()

ColorInterpolationKit& HPS::ColorInterpolationKit::UnsetEdgeIndex ( )

Removes the edge index color interpolation setting.

Returns
a reference to this object.

◆ UnsetEverything()

ColorInterpolationKit& HPS::ColorInterpolationKit::UnsetEverything ( )

Unsets all settings in this kit.

Returns
a reference to this object.

◆ UnsetFaceColor()

ColorInterpolationKit& HPS::ColorInterpolationKit::UnsetFaceColor ( )

Removes the face color interpolation setting.

Returns
a reference to this object.

◆ UnsetFaceIndex()

ColorInterpolationKit& HPS::ColorInterpolationKit::UnsetFaceIndex ( )

Removes the face index color interpolation setting.

Returns
a reference to this object.

◆ UnsetVertexColor()

ColorInterpolationKit& HPS::ColorInterpolationKit::UnsetVertexColor ( )

Removes the vertex color interpolation setting.

Returns
a reference to this object.

◆ UnsetVertexIndex()

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: