MbLinearColorMapping< _TValue, _TColor, _TColorType > Class Template Reference
[Colormapping]

MeshViz Class implementing a linear color mapping function. More...

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

Inheritance diagram for MbLinearColorMapping< _TValue, _TColor, _TColorType >:
MiColorMapping< _TValue, _TColor >

List of all members.

Public Member Functions

 MbLinearColorMapping ()
virtual ~MbLinearColorMapping ()
virtual _TColor getColor (_TValue value) const
virtual void getRange (_TValue &min, _TValue &max) const
virtual size_t getTimeStamp () const
void setColormap (std::vector< std::pair< _TValue, _TColor > > &colorMap)
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 getNumValues () const
void getValue (size_t level, _TValue &value, _TColor &color) const

Detailed Description

template<typename _TValue, typename _TColor, typename _TColorType>
class MbLinearColorMapping< _TValue, _TColor, _TColorType >

MeshViz Class implementing a linear color mapping function.

This class implements a linear color mapping defined by a set of data values and their corresponding colors. For a given value v, Vk <= v <= Vk+1, the associated color c is determined by a linear interpolation between (Vk,Ck) and (Vk+1,Ck+1). Where Vk,Ck is pair number k of the colormap.


Constructor & Destructor Documentation

template<typename _TValue , typename _TColor , typename _TColorType >
MbLinearColorMapping< _TValue, _TColor, _TColorType >::MbLinearColorMapping (  )  [inline]
template<typename _TValue , typename _TColor , typename _TColorType >
MbLinearColorMapping< _TValue, _TColor, _TColorType >::~MbLinearColorMapping (  )  [inline, virtual]

Member Function Documentation

template<typename _TValue, typename _TColor , typename _TColorType >
_TColor MbLinearColorMapping< _TValue, _TColor, _TColorType >::getColor ( _TValue  value  )  const [inline, virtual]

Returns the color associated with the given value.

Implements MiColorMapping< _TValue, _TColor >.

template<typename _TValue, typename _TColor, typename _TColorType >
bool MbLinearColorMapping< _TValue, _TColor, _TColorType >::getMaxThreshold ( _TValue &  maxThresholdValue,
_TColor &  maxThresholdColor 
) const [inline]
template<typename _TValue, typename _TColor, typename _TColorType >
bool MbLinearColorMapping< _TValue, _TColor, _TColorType >::getMinThreshold ( _TValue &  minThresholdValue,
_TColor &  minThresholdColor 
) const [inline]
template<typename _TValue, typename _TColor, typename _TColorType>
size_t MbLinearColorMapping< _TValue, _TColor, _TColorType >::getNumValues (  )  const [inline]
template<typename _TValue, typename _TColor , typename _TColorType >
void MbLinearColorMapping< _TValue, _TColor, _TColorType >::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 , typename _TColorType >
size_t MbLinearColorMapping< _TValue, _TColor, _TColorType >::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, typename _TColorType>
void MbLinearColorMapping< _TValue, _TColor, _TColorType >::getValue ( size_t  level,
_TValue &  value,
_TColor &  color 
) const [inline]
template<typename _TValue, typename _TColor, typename _TColorType >
void MbLinearColorMapping< _TValue, _TColor, _TColorType >::setColormap ( std::vector< std::pair< _TValue, _TColor > > &  colorMap  )  [inline]

Sets the colormap levels.

Parameters:
colorMap is a list of pairs (value, color) sorted in increasing order of values.
template<typename _TValue, typename _TColor, typename _TColorType >
void MbLinearColorMapping< _TValue, _TColor, _TColorType >::setMaxThreshold ( bool  enable,
_TValue  maxThresholdValue,
_TColor  maxThresholdColor 
) [inline]

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

template<typename _TValue, typename _TColor, typename _TColorType >
void MbLinearColorMapping< _TValue, _TColor, _TColorType >::setMinThreshold ( bool  enable,
_TValue  minThresholdValue,
_TColor  minThresholdColor 
) [inline]

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


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

Open Inventor Toolkit reference manual, generated on 24 Mar 2020
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/