org.opentrafficsim.core.animation

Class TextAnimation

java.lang.Object

org.opentrafficsim.core.animation.TextAnimation

All Implemented Interfaces:

Serializable, Locatable

Direct Known Subclasses:

LinkAnimation.Text, NodeAnimation.Text

public abstract class TextAnimation
extends Object
implements Locatable, Serializable

Display a text for another Locatable object.

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

$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Dec 11, 2016

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	TextAnimation.AnimationImpl The implementation of the text animation.

Field Summary

Fields

Modifier and Type	Field and Description
protected TextAnimation.AnimationImpl	animationImpl the animation implementation.
protected Color	color the color of the text.
protected float	dx the horizontal movement of the text, in meters.
protected float	dy the vertical movement of the text, in meters.
protected Font	font the font.
protected float	fontSize fontSize the size of the font; default = 2.0 (meters).
protected Locatable	source the object for which the text is displayed.
protected String	text the text to display.
protected TextAlignment	textAlignment whether to center or not.

Constructor Summary

Constructors

Constructor and Description
TextAnimation(Locatable source, String text, float dx, float dy, TextAlignment textAlignment, Color color, float fontSize, OTSSimulatorInterface simulator)
TextAnimation(Locatable source, String text, float dx, float dy, TextAlignment textAlignment, Color color, OTSSimulatorInterface simulator)

Method Summary

Modifier and Type	Method and Description
Bounds	getBounds()
DirectedPoint	getLocation()
void	paint(Graphics2D graphics, ImageObserver observer) paint() method so it can be overridden or extended.

Methods inherited from class java.lang.Object

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

Field Detail

source

protected final Locatable source

the object for which the text is displayed.

text

protected final String text

the text to display.

dx

protected final float dx

the horizontal movement of the text, in meters.

dy

protected final float dy

the vertical movement of the text, in meters.

textAlignment

protected final TextAlignment textAlignment

whether to center or not.

color

protected final Color color

the color of the text.

fontSize

protected final float fontSize

fontSize the size of the font; default = 2.0 (meters).

animationImpl

protected final TextAnimation.AnimationImpl animationImpl

the animation implementation.

font

protected Font font

the font.

Constructor Detail

TextAnimation

public TextAnimation(Locatable source,
                     String text,
                     float dx,
                     float dy,
                     TextAlignment textAlignment,
                     Color color,
                     float fontSize,
                     OTSSimulatorInterface simulator)
              throws RemoteException,
                     NamingException

Parameters:

source - the object for which the text is displayed

text - the text to display

dx - the horizontal movement of the text, in meters

dy - the vertical movement of the text, in meters

textAlignment - where to place the text

color - the color of the text

fontSize - the size of the font; default = 2.0 (meters)

simulator - the simulator

Throws:

NamingException - when animation context cannot be created or retrieved

RemoteException - - when remote context cannot be found

TextAnimation

public TextAnimation(Locatable source,
                     String text,
                     float dx,
                     float dy,
                     TextAlignment textAlignment,
                     Color color,
                     OTSSimulatorInterface simulator)
              throws RemoteException,
                     NamingException

Parameters:

source - the object for which the text is displayed

text - the text to display

dx - the horizontal movement of the text, in meters

dy - the vertical movement of the text, in meters

textAlignment - where to place the text

color - the color of the text

simulator - the simulator

Throws:

NamingException - when animation context cannot be created or retrieved

RemoteException - - when remote context cannot be found

Method Detail

getLocation

public DirectedPoint getLocation()
                          throws RemoteException

Specified by:

getLocation in interface Locatable

Throws:

RemoteException

getBounds

public final Bounds getBounds()
                       throws RemoteException

Specified by:

getBounds in interface Locatable

Throws:

RemoteException

paint

public void paint(Graphics2D graphics,
                  ImageObserver observer)
           throws RemoteException

paint() method so it can be overridden or extended.

Parameters:

graphics - the graphics object

observer - the observer

Throws:

RemoteException - on network exception