The HPS::ColorInterpolationKit class is a user space object, useful for carrying a group attribute settings. More...

#include <hps.h>

Inheritance diagram for HPS::ColorInterpolationKit:

Collaboration diagram for HPS::ColorInterpolationKit:

Public Member Functions
	ColorInterpolationKit ()
	Initializes an empty kit. More...

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

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

ColorInterpolationKit &	operator= (ColorInterpolationKit &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this ColorInterpolationKit thereby avoiding a copy. More...

virtual	~ColorInterpolationKit ()
	Destroy this kit. More...

HPS::Type	ObjectType () const

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

void	Show (ColorInterpolationKit &out_kit) const
	Copies this kit into out_kit. More...

ColorInterpolationKit &	operator= (ColorInterpolationKit const &in_kit)
	Copies the kit in_kit into this kit. More...

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

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

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

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

ColorInterpolationKit &	SetFaceColor (bool in_state)
	Controls whether face colors will be interpolated. More...

ColorInterpolationKit &	SetEdgeColor (bool in_state)
	Controls whether edge colors will be interpolated. More...

ColorInterpolationKit &	SetVertexColor (bool in_state)
	Controls whether vertex colors will be interpolated. More...

ColorInterpolationKit &	SetFaceIndex (bool in_state)
	Controls whether face colors index will be interpolated. More...

ColorInterpolationKit &	SetEdgeIndex (bool in_state)
	Controls whether edge index colors will be interpolated. More...

ColorInterpolationKit &	SetVertexIndex (bool in_state)
	Controls whether vertex index colors will be interpolated. More...

ColorInterpolationKit &	UnsetFaceColor ()
	Removes the face color interpolation setting. More...

ColorInterpolationKit &	UnsetEdgeColor ()
	Removes the edge color interpolation setting. More...

ColorInterpolationKit &	UnsetVertexColor ()
	Removes the vertex color interpolation setting. More...

ColorInterpolationKit &	UnsetFaceIndex ()
	Removes the face index color interpolation setting. More...

ColorInterpolationKit &	UnsetEdgeIndex ()
	Removes the edge index color interpolation setting. More...

ColorInterpolationKit &	UnsetVertexIndex ()
	Removes the vertex index color interpolation setting. More...

ColorInterpolationKit &	UnsetEverything ()
	Unsets all settings in this kit. More...

bool	ShowFaceColor (bool &out_state) const
	Shows whether color interpolation for the face color is set. More...

bool	ShowEdgeColor (bool &out_state) const
	Shows whether color interpolation for the edge color is set. More...

bool	ShowVertexColor (bool &out_state) const
	Shows whether color interpolation for the vertex color is set. More...

bool	ShowFaceIndex (bool &out_state) const
	Shows whether color index interpolation for the face index is set. More...

bool	ShowEdgeIndex (bool &out_state) const
	Shows whether color index interpolation for the edge index is set. More...

bool	ShowVertexIndex (bool &out_state) const
	Shows whether color index interpolation for the vertex index is set. More...

virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...

virtual void	Reset ()
	Resets this object to its initial, uninitialized state. More...

bool	HasType (HPS::Type in_mask) const
	This function indicates whether this Object has the given Type mask. More...

intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...

intptr_t	GetInstanceID () const
	Returns an identifier that can be used to identify which instance of a class an object is. More...

Static Public Member Functions
static ColorInterpolationKit	GetDefault ()

template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::ColorInterpolationKit

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

◆ ~ColorInterpolationKit()

virtual HPS::ColorInterpolationKit::~ColorInterpolationKit ( )

virtual

Destroy this kit.

Member Function Documentation

◆ ClassID()

template<typename T >

static intptr_t HPS::Object::ClassID ( )

inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

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

◆ GetClassID()

intptr_t HPS::Object::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns: A unique value shared by all objects of the same class.

◆ GetDefault()

static ColorInterpolationKit HPS::ColorInterpolationKit::GetDefault ( )

static

◆ GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const

inherited

Returns an identifier that can be used to identify which instance of a class an object is.

Different keys and controls will return the same value if they are backed by the same database resource.

Returns: A value unique to an instance of an object and all objects that are backed by the same database resource.

◆ HasType()

bool HPS::Object::HasType ( HPS::Type in_mask ) const

inherited

This function indicates whether this Object has the given Type mask.

Parameters

in_mask The Type mask to check against this Object.

Returns: true if this Object has the given Type mask, false otherwise.

◆ ObjectType()

HPS::Type HPS::ColorInterpolationKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ 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_that An 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.

◆ Reset()

virtual void HPS::Object::Reset ( )

virtualinherited

Resets this object to its initial, uninitialized state.

Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.

◆ 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_state Whether 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_state Whether 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_state Whether 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_state Whether 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_state Whether 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_state Whether 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_state The 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_state The 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_state The 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_state The 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_state The 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_state The vertex setting for the color index interpolation

Returns: true if the setting is valid, false otherwise.

◆ Type()

virtual HPS::Type HPS::Kit::Type ( ) const

inlinevirtualinherited

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::Object.

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

Member Data Documentation

◆ staticType

const HPS::Type HPS::ColorInterpolationKit::staticType = HPS::Type::ColorInterpolationKit

static

The documentation for this class was generated from the following file:

hps.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ColorInterpolationKit() [1/3]

◆ ColorInterpolationKit() [2/3]

◆ ColorInterpolationKit() [3/3]

◆ ~ColorInterpolationKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetDefault()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetEdgeColor()

◆ SetEdgeIndex()

◆ SetFaceColor()

◆ SetFaceIndex()

◆ SetVertexColor()

◆ SetVertexIndex()

◆ Show()

◆ ShowEdgeColor()

◆ ShowEdgeIndex()

◆ ShowFaceColor()

◆ ShowFaceIndex()

◆ ShowVertexColor()

◆ ShowVertexIndex()

◆ Type()

◆ UnsetEdgeColor()

◆ UnsetEdgeIndex()

◆ UnsetEverything()

◆ UnsetFaceColor()

◆ UnsetFaceIndex()

◆ UnsetVertexColor()

◆ UnsetVertexIndex()

Member Data Documentation

◆ staticType