edu.ucdavis.cstars.client.tasks

Class AlgorithmicColorRamp

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.tasks.AlgorithmicColorRamp

public class AlgorithmicColorRamp
extends com.google.gwt.core.client.JavaScriptObject

Class added v2.6 Create an algorithmic color ramp to define the range of colors used in the renderer generated by the GenerateRendererTask. The algorithmic color ramp is defined by specifying two colors and the algorithm used to traverse the intervening color spaces. Specify the from and to colors using dojo.color. There are three algorithms that can be used to define the color values between the from and to colors: 'cie-lab', 'hsv', and 'lab-lch'. There is very little difference between these algorithms when the from and the to colors are of the same or very similar hues. But when the hues for the from and to colors are different (Hue is different by 40 or more on a 0-360 scale), the algorithms produce different results. The 'hsv' algorithim traverses the hue difference in a purely linear fashion, resulting in a bright ramp where all intermediate colors are represented. For instance, a ramp from red to green would include orange, yellow, and yellow-green. The 'cie-lab' and 'lab-lch' produce a more blended result. Thus, a ramp from dark green to orange would not contain a bright yellow, but instead a more brown and green-gold or green-brown intermediate color. The advantage of the 'cie-lab' algorithm is that the colors of the ramp are visually equidistant, which can produce a better ramp.

Author:

Justin Merz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AlgorithmicColorRamp.Algorithm

Method Summary

Methods

Modifier and Type	Method and Description
static AlgorithmicColorRamp	create() Creates a new AlgorithmicColorRamp object.
AlgorithmicColorRamp.Algorithm	getAlgorithm() The algorithim used to generate the colors between the fromColor and toColor.
Color	getFromColor() The first color in the color ramp.
Color	getToColor() The last color in the color ramp.
void	setAlgorithm(AlgorithmicColorRamp.Algorithm algorithm) Set the algorithm parameter.
void	setFromColor(Color fromColor) Set the fromColor parameter.
void	setToColor(Color toColor) Set the toColor parameter.
com.google.gwt.core.client.JavaScriptObject	toJson() Returns an easily serializable object representation of an algorithmic color ramp.

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static AlgorithmicColorRamp create()

Creates a new AlgorithmicColorRamp object.

Returns:

getAlgorithm

public final AlgorithmicColorRamp.Algorithm getAlgorithm()

The algorithim used to generate the colors between the fromColor and toColor. Each algorithim uses different methods for generating the intervening colors.

Returns:

Algorithm

setAlgorithm

public final void setAlgorithm(AlgorithmicColorRamp.Algorithm algorithm)

Set the algorithm parameter.

Parameters:

algorithm - - The algorithim used to generate the colors between the fromColor and toColor. Each algorithim uses different methods for generating the intervening colors.

getFromColor

public final Color getFromColor()

The first color in the color ramp.

Returns:

Color

setFromColor

public final void setFromColor(Color fromColor)

Set the fromColor parameter.

Parameters:

fromColor - - The first color in the color ramp.

getToColor

public final Color getToColor()

The last color in the color ramp.

Returns:

Color

setToColor

public final void setToColor(Color toColor)

Set the toColor parameter.

Parameters:

toColor - - The last color in the color ramp.

toJson

public final com.google.gwt.core.client.JavaScriptObject toJson()

Returns an easily serializable object representation of an algorithmic color ramp.

Returns:

JavaScriptObject