org.opentrafficsim.core.gtu.animation

Class SwitchableGTUColorer

java.lang.Object

org.opentrafficsim.core.gtu.animation.SwitchableGTUColorer

All Implemented Interfaces:

GTUColorer

Direct Known Subclasses:

DefaultSwitchableGTUColorer

public class SwitchableGTUColorer
extends Object
implements GTUColorer

GTU colorer that uses a coloring method that can be switched by the user of the program.

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

Version:

$Revision: 1401 $, $LastChangedDate: 2015-09-14 01:33:02 +0200 (Mon, 14 Sep 2015) $, by $Author: averbraeck $, initial version 28 mei 2015

Author:

Alexander Verbraeck, Peter Knoppers

Nested Class Summary

Nested classes/interfaces inherited from interface org.opentrafficsim.core.gtu.animation.GTUColorer

GTUColorer.LegendEntry

Constructor Summary

Constructors

Constructor and Description
SwitchableGTUColorer(int activeIndex, GTUColorer... colorers) Construct a new Switchable GTUColorer based on a list of colorers.

Method Summary

Modifier and Type	Method and Description
Color	getColor(GTU gtu) Return the fill color for a GTU.
List<GTUColorer>	getColorers()
List<GTUColorer.LegendEntry>	getLegend() Return a list of legend entries (useful to make a legend of the colors used to render the GTUs).
void	setGTUColorer(int activeIndex) Replace the currently active GTUColorer.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SwitchableGTUColorer

public SwitchableGTUColorer(int activeIndex,
                            GTUColorer... colorers)
                     throws IndexOutOfBoundsException

Construct a new Switchable GTUColorer based on a list of colorers.

Parameters:

activeIndex - the index of the initially active colorer in the list (0-based).

colorers - GTUColorers; the list of GTUColorer. List cannot be empty.

Throws:

IndexOutOfBoundsException - when activeIndex < 0 or larger than or equal to the number of colorers.

Method Detail

setGTUColorer

public final void setGTUColorer(int activeIndex)
                         throws IndexOutOfBoundsException

Replace the currently active GTUColorer.

Parameters:

activeIndex - the index of the new active colorer in the list (0-based).

Throws:

IndexOutOfBoundsException - when activeIndex < 0 or larger than or equal to the number of colorers.

getColor

public final Color getColor(GTU gtu)

Return the fill color for a GTU.

Specified by:

getColor in interface GTUColorer

Parameters:

gtu - GTU; the GTU

Returns:

Color; the color for the GTU

getLegend

public final List<GTUColorer.LegendEntry> getLegend()

Return a list of legend entries (useful to make a legend of the colors used to render the GTUs).

Specified by:

getLegend in interface GTUColorer

Returns:

List<LegendEntry>; the list of legend entries; the caller should not (try to) modify this List

toString

public final String toString()

Overrides:

toString in class Object

getColorers

public final List<GTUColorer> getColorers()

Returns:

the list of colorers.