DesiredSpeedColorer (OTS generic animation classes 1.04.02 API)

java.lang.Object
- org.opentrafficsim.road.gtu.colorer.DesiredSpeedColorer

All Implemented Interfaces:

java.io.Serializable, Colorer<GTU>, GTUColorer
```
public class DesiredSpeedColorer
extends java.lang.Object
implements GTUColorer, java.io.Serializable
```
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 3 mrt. 2018

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface org.opentrafficsim.core.animation.gtu.colorer.GTUColorer
  GTUColorer.LegendEntry

Constructor Summary

Constructors
Constructor Description

DesiredSpeedColorer(Speed minimumSpeed, Speed maximumSpeed)
Construct a new SpeedGTUColorer.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.awt.Color`	`getColor(GTU gtu)`	Get the color, based on the Drawable object.
`java.util.List<GTUColorer.LegendEntry>`	`getLegend()`	Return a list of legend entries (useful to make a legend of the colors used to render the GTUs).
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DesiredSpeedColorer
```
public DesiredSpeedColorer(Speed minimumSpeed,
                           Speed maximumSpeed)
```
    Construct a new SpeedGTUColorer.
    
    Parameters:
    
    minimumSpeed - Speed; the speed at (and below) which the returned color will be red
    
    maximumSpeed - Speed; the speed at (and above) which the returned color will be green
- Method Detail
  - getColor
```
public final java.awt.Color getColor(GTU gtu)
```
    Get the color, based on the Drawable object.
    
    Specified by:
    
    getColor in interface Colorer<GTU>
    
    Parameters:
    
    gtu - D; the object to determine the color for
    
    Returns:
    
    the (fill, line) color of the drawable object
  - getLegend
```
public final java.util.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 java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object