Package org.opentrafficsim.draw.core

Class BoundsPaintScale

java.lang.Object

org.opentrafficsim.draw.core.BoundsPaintScale

All Implemented Interfaces:

Serializable, PaintScale, ColorPaintScale

public class BoundsPaintScale
extends Object
implements ColorPaintScale, Serializable

Paint scale interpolating between colors at values.

Copyright (c) 2013-2020 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:

$Revision$, $LastChangedDate$, by $Author$, initial version 8 okt. 2018

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static Color[]	GREEN_RED	3-color scale from green to red.
static Color[]	GREEN_RED_DARK	5-color scale from green to red with dark edges.

Constructor Summary

Constructors

Constructor	Description
BoundsPaintScale(double[] bounds, Color[] boundColors)	Constructor.

Method Summary

Modifier and Type	Method	Description
double	getLowerBound()
Color	getPaint(double value)
double	getUpperBound()
static Color[]	hue(int n)	Creates an array of n colors with varying hue.
static Color[]	reverse(Color[] colors)	Reverses the color array.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

GREEN_RED

public static final Color[] GREEN_RED

3-color scale from green to red.

GREEN_RED_DARK

public static final Color[] GREEN_RED_DARK

5-color scale from green to red with dark edges.

Constructor Detail

BoundsPaintScale

public BoundsPaintScale(double[] bounds,
                        Color[] boundColors)
                 throws IllegalArgumentException

Constructor.

Parameters:

bounds - double[]; value bounds

boundColors - Color[]; colors at bounds

Throws:

IllegalArgumentException - if less than 2 bounds, unequal number of bounds and colors, or duplicate bounds

Method Detail

reverse

public static Color[] reverse(Color[] colors)

Reverses the color array.

Parameters:

colors - Color[]; array of colors

Returns:

Color[]; reversed color array

hue

public static Color[] hue(int n)

Creates an array of n colors with varying hue.

Parameters:

n - int; number of colors.

Returns:

Color[]; array of n colors with varying hue

getPaint

public Color getPaint(double value)

Specified by:

getPaint in interface ColorPaintScale

Specified by:

getPaint in interface PaintScale

getLowerBound

public final double getLowerBound()

Specified by:

getLowerBound in interface PaintScale

getUpperBound

public final double getUpperBound()

Specified by:

getUpperBound in interface PaintScale

toString

public String toString()

Overrides:

toString in class Object