org.jzy3d.colors.colormaps
Interface IColorMap

All Known Implementing Classes:

ColorMapBlueGreen, ColorMapGrayscale, ColorMapHotCold, ColorMapRainbow, ColorMapRBG, ColorMapRedAndGreen, ColorMapWhiteBlue, ColorMapWhiteGreen, ColorMapWhiteRed

public interface IColorMap

ColorMap interface.

This interface defines the set of methods that any concrete colormap should define in order to be used by an object implementing the ColorMappable interface. The ColorMappable interface impose to an object to provide a Z-scaling, that is, a minimum and maximum value on the Z axis. These values are used by concrete colormaps in order to set an interval for the possible colors.

Author:

Martin Pernollet

Method Summary

Color	getColor(IColorMappable colorable, float v)
Color	getColor(IColorMappable colorable, float x, float y, float z)
boolean	getDirection()
void	setDirection(boolean isStandard) Indicates if the colormap use the standard or reverted color direction

Method Detail

getColor

Color getColor(IColorMappable colorable,
               float x,
               float y,
               float z)

Parameters:

colorable - A @link ColorMappable object.

x -

y -

z -

Returns:

a color for the given point.

getColor

Color getColor(IColorMappable colorable,
               float v)

Parameters:

colorable - A @link ColorMappable object.

v - the variable that is Color-dependent, and can be independent of the coordinates.

Returns:

a color for the given point.

setDirection

void setDirection(boolean isStandard)

Indicates if the colormap use the standard or reverted color direction

Parameters:

isStandard -

getDirection

boolean getDirection()

Returns:

the colormap direction: true if standard, false if reverted.