org.opentrafficsim.core.animation

Class TextAnimation

java.lang.Object

org.opentrafficsim.core.animation.TextAnimation

All Implemented Interfaces:

Serializable, nl.tudelft.simulation.dsol.animation.Locatable

Direct Known Subclasses:

LinkAnimation.Text, NodeAnimation.Text

public abstract class TextAnimation
extends Object
implements nl.tudelft.simulation.dsol.animation.Locatable, Serializable

Display a text for another Locatable object.

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-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

Constructor Summary

Constructors

Constructor and Description
TextAnimation(nl.tudelft.simulation.dsol.animation.Locatable source, String text, float dx, float dy, TextAlignment textAlignment, Color color, float fontSize, OTSSimulatorInterface simulator)
TextAnimation(nl.tudelft.simulation.dsol.animation.Locatable source, String text, float dx, float dy, TextAlignment textAlignment, Color color, OTSSimulatorInterface simulator)

Method Summary

Modifier and Type	Method and Description
abstract TextAnimation	clone(nl.tudelft.simulation.dsol.animation.Locatable newSource, OTSSimulatorInterface newSimulator) Clone the TextAnimation and return a copy for the new source on the new simulator.
void	destroy() Destroy the text animation.
javax.media.j3d.Bounds	getBounds()
protected Color	getColor()
protected float	getDx()
protected float	getDy()
protected Font	getFont()
protected float	getFontSize()
nl.tudelft.simulation.language.d3.DirectedPoint	getLocation()
protected nl.tudelft.simulation.dsol.animation.Locatable	getSource()
protected String	getText()
protected TextAlignment	getTextAlignment()
boolean	isFlip()
boolean	isRotate()
boolean	isScale()
boolean	isTranslate()
void	paint(Graphics2D graphics, ImageObserver observer) paint() method so it can be overridden or extended.
protected void	setColor(Color color)
void	setFlip(boolean flip)
void	setRotate(boolean rotate)
void	setScale(boolean scale)
protected void	setText(String text)
void	setTranslate(boolean translate)

Methods inherited from class java.lang.Object

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

Constructor Detail

TextAnimation

public TextAnimation(nl.tudelft.simulation.dsol.animation.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(nl.tudelft.simulation.dsol.animation.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 nl.tudelft.simulation.language.d3.DirectedPoint getLocation()
                                                            throws RemoteException

Specified by:

getLocation in interface nl.tudelft.simulation.dsol.animation.Locatable

Throws:

RemoteException

getBounds

public final javax.media.j3d.Bounds getBounds()
                                       throws RemoteException

Specified by:

getBounds in interface nl.tudelft.simulation.dsol.animation.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

destroy

public final void destroy()

Destroy the text animation.

clone

public abstract TextAnimation clone(nl.tudelft.simulation.dsol.animation.Locatable newSource,
                                    OTSSimulatorInterface newSimulator)
                             throws RemoteException,
                                    NamingException

Clone the TextAnimation and return a copy for the new source on the new simulator.

Parameters:

newSource - the new source to link to the text animation

newSimulator - the new simulator to register the animation on

Returns:

a copy of the TextAnimation

Throws:

RemoteException - when remote animation cannot be reached

NamingException - when animation name cannot be found or bound in the Context

getSource

protected final nl.tudelft.simulation.dsol.animation.Locatable getSource()

Returns:

source

getDx

protected final float getDx()

Returns:

dx

getDy

protected final float getDy()

Returns:

dy

getTextAlignment

protected final TextAlignment getTextAlignment()

Returns:

textAlignment

getFontSize

protected final float getFontSize()

Returns:

fontSize

getFont

protected final Font getFont()

Returns:

font

getText

protected final String getText()

Returns:

current text

setText

protected final void setText(String text)

Parameters:

text - set new text

getColor

protected final Color getColor()

Returns:

current color

setColor

protected final void setColor(Color color)

Parameters:

color - set new color

isFlip

public final boolean isFlip()

Returns:

Returns the flip.

setFlip

public final void setFlip(boolean flip)

Parameters:

flip - The flip to set.

isRotate

public final boolean isRotate()

Returns:

Returns the rotate.

setRotate

public final void setRotate(boolean rotate)

Parameters:

rotate - The rotate to set.

isScale

public final boolean isScale()

Returns:

Returns the scale.

setScale

public final void setScale(boolean scale)

Parameters:

scale - The scale to set.

isTranslate

public final boolean isTranslate()

Returns:

Returns the translate.

setTranslate

public final void setTranslate(boolean translate)

Parameters:

translate - The translate to set.