MiColorMapping< _TValue, _TColor > Class Template Reference
[Attributes]

MeshViz Interface class defining a color mapping function. More...

#include <MeshVizXLM/mapping/interfaces/MiColorMapping.h>

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

List of all members.

Public Member Functions

virtual ~MiColorMapping ()
virtual _TColor getColor (_TValue value) const =0
virtual void getRange (_TValue &min, _TValue &max) const
virtual size_t getTimeStamp () const =0

Detailed Description

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

MeshViz Interface class defining a color mapping function.

This abstract class specifies the interface used to map a value of a scalar data set to a color. It is used when displaying scalar data sets as colors.

In order to define a custom color mapping, create a class derived from this class.


Constructor & Destructor Documentation

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

Member Function Documentation

template<typename _TValue, typename _TColor>
virtual _TColor MiColorMapping< _TValue, _TColor >::getColor ( _TValue  value  )  const [pure virtual]

Returns the color associated with the given value.

Implemented in MbLevelColorMapping< _TValue, _TColor >, and MbLinearColorMapping< _TValue, _TColor, _TColorType >.

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

Returns the range of values for the colormap.

Note:
This method should be pure virtual, but, for compatibility reasons, it throws an exception instead.

Reimplemented in MbLevelColorMapping< _TValue, _TColor >, and MbLinearColorMapping< _TValue, _TColor, _TColorType >.

template<typename _TValue, typename _TColor>
virtual size_t MiColorMapping< _TValue, _TColor >::getTimeStamp (  )  const [pure virtual]

Returns for this colormap a unique time stamp across all colormaps in the application.

When the content of the colormap changes, the time stamp must increase. The time stamp allows representations to identify this colormap and to be aware of any changes to it.

Note:
MxTimeStamp can be used to generate a valid time stamp.

Implemented in MbLevelColorMapping< _TValue, _TColor >, MbLinearColorMapping< _TValue, _TColor, _TColorType >, MbLevelColorMapping< double, SbColorRGBA >, and MbLinearColorMapping< double, SbColorRGBA, float >.


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

Open Inventor by FEI reference manual, generated on 2 Sep 2019
Copyright © FEI S.A.S. All rights reserved.
http://www.openinventor.com/