Module omix.api

Package omix.lang

Class ColorInterpolator

java.lang.Object

omix.lang.ColorInterpolator

public final class ColorInterpolator
extends Object

The ColorInterpolator class implements interpolation between colors. A ColorInterpolator with two initial colors can be created. By calling get() with a value between 0.0 and 1.0 the ColorInterpolator returns the linear interpolation of the two colors. Additionally further colors at values between 0.0 and 1.0 can be inserted. In this case the interpolation happens between neighbored colors of the given value. ColorInterpolator can use the RGB or HSV color space to interpolate colors.

Author:

Dr. Peter Droste, Omix Visualization

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ColorInterpolator.ColorSpace	This enum list all color spaces available in ColorInterpolator.
static class	ColorInterpolator.InterpolationMode	This enum represents possible color interpolation modes.

Constructor Summary

Constructors

Constructor	Description
ColorInterpolator(List<Color> colors, List<Double> keys, ColorInterpolator.ColorSpace colorSpace)	Deprecated.
ColorInterpolator(Map<Double,Color> colors)
ColorInterpolator(Map<Double,Color> colors, ColorInterpolator.ColorSpace colorSpace)
ColorInterpolator(Map<Double,Color> colors, ColorInterpolator.InterpolationMode interpolationMode)
ColorInterpolator(Map<Double,Color> colors, ColorInterpolator.InterpolationMode interpolationMode, ColorInterpolator.ColorSpace colorSpace)
ColorInterpolator(Color color0, Color color1)	The same as ColorInterpolator(color0, color1, ColorSpace.RGB)
ColorInterpolator(Color color0, Color color1, ColorInterpolator.ColorSpace colorSpace)	ColorInterpolator initialized with a color at 0.0 and a color at 1.0 interpolating in the submitted color space.
ColorInterpolator(Color color0, Color color1, ColorInterpolator.InterpolationMode interpolationMode)	ColorInterpolator initialized with a color at 0.0 and a color at 1.0 interpolating in the submitted color space.
ColorInterpolator(Color color0, Color color1, ColorInterpolator.InterpolationMode interpolationMode, ColorInterpolator.ColorSpace colorSpace)	ColorInterpolator initialized with a color at 0.0 and a color at 1.0 interpolating in the submitted color space.

Method Summary

Modifier and Type	Method	Description
Map<Double,Color>	colors()
Color	get(double value)	returns the interpolated color for the given value in range of 0.0 to 1.0.
List<Color>	getColors()	Deprecated.
ColorInterpolator.ColorSpace	getColorSpace()
ColorInterpolator.InterpolationMode	getInterpolationMode()
List<Double>	getKeys()	Deprecated.
void	set(double value, Color color)	This method can be used to insert further colors at certain values.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ColorInterpolator

@ConstructorProperties({"color0","color1","colorSpace"}) public ColorInterpolator(Color color0, Color color1, ColorInterpolator.ColorSpace colorSpace)

ColorInterpolator initialized with a color at 0.0 and a color at 1.0 interpolating in the submitted color space.

Parameters:

color0 - the color at value 0.0.

color1 - the color at value 1.0.

colorSpace - the color space the colors are interpolated in.

ColorInterpolator

@ConstructorProperties({"color0","color1","colorSpace"}) public ColorInterpolator(Color color0, Color color1, ColorInterpolator.InterpolationMode interpolationMode)

ColorInterpolator initialized with a color at 0.0 and a color at 1.0 interpolating in the submitted color space.

Parameters:

color0 - the color at value 0.0.

color1 - the color at value 1.0.

interpolationMode - the color interpolation mode

ColorInterpolator

@ConstructorProperties({"color0","color1","interpolationMode","colorSpace"}) public ColorInterpolator(Color color0, Color color1, ColorInterpolator.InterpolationMode interpolationMode, ColorInterpolator.ColorSpace colorSpace)

ColorInterpolator initialized with a color at 0.0 and a color at 1.0 interpolating in the submitted color space.

Parameters:

color0 - the color at value 0.0.

color1 - the color at value 1.0.

interpolationMode - the color interpolation mode

colorSpace - the color space the colors are interpolated in.

ColorInterpolator

@OVLInaccessible @ConstructorProperties({"colors","keys","colorSpace"}) @Deprecated public ColorInterpolator(List<Color> colors, List<Double> keys, ColorInterpolator.ColorSpace colorSpace)

Deprecated.

ColorInterpolator

@ConstructorProperties({"color0","color1"}) public ColorInterpolator(Color color0, Color color1)

The same as ColorInterpolator(color0, color1, ColorSpace.RGB)

Parameters:

color0 - the color at value 0.0.

color1 - the color at value 1.0.

ColorInterpolator

@ConstructorProperties("colors") public ColorInterpolator(Map<Double,Color> colors)

ColorInterpolator

@ConstructorProperties({"colors","colorSpace"}) public ColorInterpolator(Map<Double,Color> colors, ColorInterpolator.ColorSpace colorSpace)

ColorInterpolator

@ConstructorProperties({"colors","interpolationMode"}) public ColorInterpolator(Map<Double,Color> colors, ColorInterpolator.InterpolationMode interpolationMode)

ColorInterpolator

@ConstructorProperties({"colors","interpolationMode","colorSpace"}) public ColorInterpolator(Map<Double,Color> colors, ColorInterpolator.InterpolationMode interpolationMode, ColorInterpolator.ColorSpace colorSpace)

Method Details

set

public void set(double value, Color color)

This method can be used to insert further colors at certain values.

Parameters:

value - the value of the inserted color in range of 0.0 to 1.0

color - the inserted color

get

public Color get(double value)

returns the interpolated color for the given value in range of 0.0 to 1.0.

Parameters:

value - in range of 0.0 to 1.0.

Returns:

the interpolated color

getColors

@OVLInaccessible @Deprecated public List<Color> getColors()

Deprecated.

Returns:

the colors

getKeys

@OVLInaccessible @Deprecated public List<Double> getKeys()

Deprecated.

Returns:

the keys

colors

@OVLInaccessible public Map<Double,Color> colors()

toString

public String toString()

Overrides:

toString in class Object

getColorSpace

@OVLInaccessible public ColorInterpolator.ColorSpace getColorSpace()

Returns:

the colorSpace

getInterpolationMode

public ColorInterpolator.InterpolationMode getInterpolationMode()