MbLevelColorMapping< _TValue, _TColor > Class Template Reference
[Colormapping]

Class implementing a level color mapping function. More...

#include <MeshVizXLM/mesh/colormapping/MbLevelColorMapping.h>

Inheritance diagram for MbLevelColorMapping< _TValue, _TColor >:

List of all members.

Public Member Functions
	MbLevelColorMapping ()
virtual	~MbLevelColorMapping ()
virtual _TColor	getColor (_TValue value) const
virtual void	getRange (_TValue &min, _TValue &max) const
virtual size_t	getTimeStamp () const
void	setLevels (std::vector< _TValue > &values, std::vector< _TColor > &colors)
void	setMinThreshold (bool enable, _TValue minThresholdValue, _TColor minThresholdColor)
bool	getMinThreshold (_TValue &minThresholdValue, _TColor &minThresholdColor) const
void	setMaxThreshold (bool enable, _TValue maxThresholdValue, _TColor maxThresholdColor)
bool	getMaxThreshold (_TValue &maxThresholdValue, _TColor &maxThresholdColor) const
size_t	getLevelIndex (_TValue value) const
size_t	getNumValues () const
_TValue	getValue (size_t level) const
size_t	getNumColors () const
_TColor	getColorValue (size_t index) const

---

Detailed Description

template<typename _TValue, typename _TColor>
class MbLevelColorMapping< _TValue, _TColor >

Class implementing a level color mapping function.

This class implements a level color mapping defined by a set of N intervals between scalar values and N-1 colors representing the constant color used for values located in each interval.

---

Constructor & Destructor Documentation

template<typename _TValue , typename _TColor >

MbLevelColorMapping< _TValue, _TColor >::MbLevelColorMapping

(

)

[inline]

template<typename _TValue , typename _TColor >

MbLevelColorMapping< _TValue, _TColor >::~MbLevelColorMapping

(

)

[inline, virtual]

---

Member Function Documentation

template<typename _TValue, typename _TColor >

_TColor MbLevelColorMapping< _TValue, _TColor >::getColor

(

_TValue

value

)

const [inline, virtual]

Returns the color associated with the given value.

Implements MiColorMapping< _TValue, _TColor >.

template<typename _TValue, typename _TColor>

_TColor MbLevelColorMapping< _TValue, _TColor >::getColorValue

(

size_t

index

)

const [inline]

template<typename _TValue, typename _TColor >

size_t MbLevelColorMapping< _TValue, _TColor >::getLevelIndex

(

_TValue

value

)

const [inline]

Returns the index in the level array of the interval containing the input value.

template<typename _TValue, typename _TColor>

bool MbLevelColorMapping< _TValue, _TColor >::getMaxThreshold	(	_TValue &	maxThresholdValue,
		_TColor &	maxThresholdColor
	)			const [inline]

template<typename _TValue, typename _TColor>

bool MbLevelColorMapping< _TValue, _TColor >::getMinThreshold	(	_TValue &	minThresholdValue,
		_TColor &	minThresholdColor
	)			const [inline]

template<typename _TValue, typename _TColor>

size_t MbLevelColorMapping< _TValue, _TColor >::getNumColors

(

)

const [inline]

template<typename _TValue, typename _TColor>

size_t MbLevelColorMapping< _TValue, _TColor >::getNumValues

(

)

const [inline]

template<typename _TValue, typename _TColor >

void MbLevelColorMapping< _TValue, _TColor >::getRange	(	_TValue &	min,
		_TValue &	max
	)			const [inline, virtual]

Returns the range of values for the colormap.

Reimplemented from MiColorMapping< _TValue, _TColor >.

template<typename _TValue , typename _TColor >

size_t MbLevelColorMapping< _TValue, _TColor >::getTimeStamp

(

)

const [inline, virtual]

Returns a time stamp on this color mapping.

When the content of the color mapping changes, the time stamp must also change. The time stamp allows MeshViz to be aware of any change to this color mapping.

Implements MiColorMapping< _TValue, _TColor >.

template<typename _TValue, typename _TColor>

_TValue MbLevelColorMapping< _TValue, _TColor >::getValue

(

size_t

level

)

const [inline]

template<typename _TValue, typename _TColor>

void MbLevelColorMapping< _TValue, _TColor >::setLevels	(	std::vector< _TValue > &	values,
		std::vector< _TColor > &	colors
	)			[inline]

Sets the scalar values (levels) and the constant color for each level.

Parameters:

	values	is a list of N values sorted in increasing order defining the boundaries of each level.
	colors	is a list of N-1 colors defining the constant color of each level.

template<typename _TValue, typename _TColor>

void MbLevelColorMapping< _TValue, _TColor >::setMaxThreshold	(	bool	enable,
		_TValue	maxThresholdValue,
		_TColor	maxThresholdColor
	)			[inline]

Defines a maximum threshold above which the maxThresholdColor replaces the colormap colors.

template<typename _TValue, typename _TColor>

void MbLevelColorMapping< _TValue, _TColor >::setMinThreshold	(	bool	enable,
		_TValue	minThresholdValue,
		_TColor	minThresholdColor
	)			[inline]

Defines a minimum threshold under which the minThresholdColor replaces the colormap colors.

---

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

• MeshVizXLM/mesh/colormapping/MbLevelColorMapping.h