DesireColorer (OTS generic animation classes 1.04.02 API)

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

All Implemented Interfaces:

java.io.Serializable, Colorer<GTU>, GTUColorer

Direct Known Subclasses:

IncentiveColorer, TotalDesireColorer
```
public abstract class DesireColorer
extends java.lang.Object
implements GTUColorer, java.io.Serializable
```
Super class with default coloring of left and right desire value.
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 13 apr. 2017

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

Field Summary

Fields
Modifier and Type Field Description

protected static java.awt.Color NA
N/A color.

Constructor Summary

Constructors
Constructor Description

DesireColorer()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected java.awt.Color`	`getColor(double dLeft, double dRight)`	Returns a color based on desire.
`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).

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

Methods inherited from interface org.opentrafficsim.core.animation.Colorer
getColor

- Field Detail
  - NA
```
protected static final java.awt.Color NA
```
    N/A color.
- Constructor Detail
  - DesireColorer
```
public DesireColorer()
```
- Method Detail
  - 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
  - getColor
```
protected final java.awt.Color getColor(double dLeft,
                                        double dRight)
```
    Returns a color based on desire.
    
    Parameters:
    
    dLeft - double; left desire
    
    dRight - double; right desire
    
    Returns:
    
    color based on desire