ColorInterpolationControl

class HPS::ColorInterpolationControl : public HPS::Control

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.

Public Functions

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.

ColorInterpolationControl(ColorInterpolationControl const &in_that)

Initializes a control tied to the same object as in_that.

explicit ColorInterpolationControl(SegmentKey &in_seg)

Initializes a control tied to the segment in_seg.

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.

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 &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 &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 &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 &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 &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 &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 &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 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.

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.

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.

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.

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.

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.

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.

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.

~ColorInterpolationControl()

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

Public Static Attributes

static const HPS::Type staticType = HPS::Type::ColorInterpolationControl