com.openinventor.meshvizxlm.mapping

Interface MiColorMapping<V,C>

Type Parameters:

V - the type of values

C - the type of colors

public interface MiColorMapping<V,C>

Interface defining a color mapping function.

This generic 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.

Method Summary

Modifier and Type	Method and Description
C	getColor(V value) Returns the color associated with the given value.
V	getMax() Returns the maximum of values for the colormap.
V	getMin() Returns the minimum of values for the colormap.
long	getTimeStamp() Returns for this colormap a unique time stamp across all colormaps in the application. When the content of the color mapping changes, the time stamp must increase.

Method Detail

getColor

C getColor(V value)

Returns the color associated with the given value.

Parameters:

value - the value

Returns:

the associated color

getMin

V getMin()

Returns the minimum of values for the colormap.

Returns:

minimum value

getMax

V getMax()

Returns the maximum of values for the colormap.

Returns:

maximum value

getTimeStamp

long getTimeStamp()

Returns for this colormap a unique time stamp across all colormaps in the application.
When the content of the color mapping 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.

Returns:

a time stamp value