org.opentrafficsim.graphs

Class ContinuousColorPaintScale

java.lang.Object

org.opentrafficsim.graphs.ContinuousColorPaintScale

All Implemented Interfaces:

Serializable, org.jfree.chart.renderer.PaintScale

public class ContinuousColorPaintScale
extends Object
implements org.jfree.chart.renderer.PaintScale, Serializable

Create a continuous color paint scale.
Primarily intended for the contour plots, but sufficiently abstract for more general use.
A continuous color paint scale creates paints (actually simple Colors) by linearly interpolating between a limited set of RGB Color values that correspond to given input values.

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

$LastChangedDate: 2015-07-26 01:01:13 +0200 (Sun, 26 Jul 2015) $, @version $Revision: 1155 $, by $Author: averbraeck $, initial version Jul 30, 2014

Author:

Peter Knoppers

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ContinuousColorPaintScale(String format, double[] bounds, Color[] boundColors) Create a new ContinuousColorPaintScale.

Method Summary

Modifier and Type	Method and Description
String	getFormat() Retrieve the format string.
double	getLowerBound()
Paint	getPaint(double value)
double	getUpperBound()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ContinuousColorPaintScale

ContinuousColorPaintScale(String format,
                          double[] bounds,
                          Color[] boundColors)
                   throws org.opentrafficsim.simulationengine.OTSSimulationException

Create a new ContinuousColorPaintScale.

Parameters:

format - Format string to render the value under the mouse in a human readable format

bounds - Double[] array of boundary values (all values must be distinct and the number of values must be >= 2)

boundColors - Color[] array of the colors to use at the boundary values (must have same size as bounds)

Throws:

org.opentrafficsim.simulationengine.OTSSimulationException - when bounds are wrong

Method Detail

getLowerBound

public final double getLowerBound()

Specified by:

getLowerBound in interface org.jfree.chart.renderer.PaintScale

getPaint

public final Paint getPaint(double value)

Specified by:

getPaint in interface org.jfree.chart.renderer.PaintScale

getUpperBound

public final double getUpperBound()

Specified by:

getUpperBound in interface org.jfree.chart.renderer.PaintScale

getFormat

public final String getFormat()

Retrieve the format string.

Returns:

format string

toString

public final String toString()

Overrides:

toString in class Object