ColorInterpolationKit

class ColorInterpolationKit : public HPS::Kit 

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.

Public Functions

ColorInterpolationKit(): Initializes an empty kit.

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.

ColorInterpolationKit(ColorInterpolationKit const &in_kit): Copies the kit in_kit into this kit.

virtual bool Empty() const: Returns whether this kit has any values currently set on it.

bool Equals(ColorInterpolationKit const &in_kit) const: Compares the contents of in_kit and this kit.

inline virtual HPS::Type ObjectType() const

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.

bool operator!=(ColorInterpolationKit const &in_kit) const: Compares the contents of in_kit and this kit.

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 &operator=(ColorInterpolationKit const &in_kit): Copies the kit in_kit into this kit.

bool operator==(ColorInterpolationKit const &in_kit) const: Compares the contents of in_kit and this kit.

void Set(ColorInterpolationKit const &in_kit): Copies the kit in_kit into this kit.

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 &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 &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 &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 &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 &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 Show(ColorInterpolationKit &out_kit) const: Copies this kit into out_kit.

bool 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 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 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 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 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 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 &UnsetEdgeColor()

Removes the edge color interpolation setting.

Returns:	a reference to this object.

ColorInterpolationKit &UnsetEdgeIndex()

Removes the edge index color interpolation setting.

Returns:	a reference to this object.

ColorInterpolationKit &UnsetEverything()

Unsets all settings in this kit.

Returns:	a reference to this object.

ColorInterpolationKit &UnsetFaceColor()

Removes the face color interpolation setting.

Returns:	a reference to this object.

ColorInterpolationKit &UnsetFaceIndex()

Removes the face index color interpolation setting.

Returns:	a reference to this object.

ColorInterpolationKit &UnsetVertexColor()

Removes the vertex color interpolation setting.

Returns:	a reference to this object.

ColorInterpolationKit &UnsetVertexIndex()

Removes the vertex index color interpolation setting.

Returns:	a reference to this object.

virtual ~ColorInterpolationKit(): Destroy this kit.

Public Static Functions

static ColorInterpolationKit GetDefault()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::ColorInterpolationKit