org.opentrafficsim.simulationengine

Class AbstractWrappableAnimation

java.lang.Object

org.opentrafficsim.simulationengine.AbstractWrappableAnimation

All Implemented Interfaces:

Serializable, WrappableAnimation

public abstract class AbstractWrappableAnimation
extends Object
implements WrappableAnimation, Serializable

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

$LastChangedDate: 2018-09-19 13:55:45 +0200 (Wed, 19 Sep 2018) $, @version $Revision: 4006 $, by $Author: averbraeck $, initial version Jun 18, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	exitOnClose Use EXIT_ON_CLOSE when true, DISPOSE_ON_CLOSE when false on closing of the window.
protected Properties	frameProperties Properties for the frame appearance (not simulation related).
protected OTSAnimationPanel	panel The tabbed panel so other tabs can be added by the classes that extend this class.
protected List<Property<?>>	properties The properties exhibited by this simulation.
protected List<Property<?>>	savedUserModifiedProperties The properties after (possible) editing by the user.

Constructor Summary

Constructors

Constructor and Description
AbstractWrappableAnimation()

Method Summary

Modifier and Type	Method and Description
protected void	addAnimationToggles() Placeholder method to place animation buttons or to show/hide classes on the animation.
void	addTab(int index, String caption, Container container) Add a tab to the simulation window.
protected void	addTabs(SimpleSimulatorInterface simulator) Make additional tabs in the main simulation window.
void	addToggleAnimationButtonIcon(String name, Class<? extends Locatable> locatableClass, String iconPath, String toolTipText, boolean initiallyVisible, boolean idButton) Add a button for toggling an animatable class on or off.
void	addToggleAnimationButtonText(String name, Class<? extends Locatable> locatableClass, String toolTipText, boolean initiallyVisible) Add a button for toggling an animatable class on or off.
void	addToggleGISButtonText(String header, GisRenderable2D gisMap, String toolTipText) Add a button for toggling a GIS class on or off.
SimpleAnimator	buildAnimator(Time startTime, Duration warmupPeriod, Duration runLength, List<Property<?>> userModifiedProperties, Rectangle rect, boolean eoc) Build the animation.
protected SimpleAnimator	buildSimpleAnimator(Time startTime, Duration warmupPeriod, Duration runLength, OTSModelInterface otsModel) Build the animator.
protected SimpleAnimator	buildSimpleAnimator(Time startTime, Duration warmupPeriod, Duration runLength, OTSModelInterface otsModel, int replicationNumber) Build the animator with the specified replication number.
Appearance	getAppearance() Returns the appearance.
GTUColorer	getColorer() Overridable method to return GTU colorer.
JPanel	getDemoPanel() Return a panel for on-screen demo controls.
OTSAnimationPanel	getPanel()
ArrayList<Property<?>>	getProperties() Retrieve a list of visible properties of the simulation.
int	getTabCount() Report the current number of tabs in the simulation window.
List<Property<?>>	getUserModifiedProperties() Retrieve a list of properties as the user has modified them.
void	hideAnimationClass(Class<? extends Locatable> locatableClass) Set a class to be hidden in the animation to true.
void	hideGISLayer(String layerName) Set a GIS layer to be hidden in the animation to true.
protected Rectangle2D	makeAnimationRectangle() Return the initial 'home' extent for the animation.
protected abstract OTSModelInterface	makeModel()
SimpleSimulatorInterface	rebuildSimulator(Rectangle rect) Restart (rebuild) the simulation.
void	setAppearance(Appearance appearance) Sets an appearance.
void	setNextReplication(Integer nextReplication) Set the number of the next spawned replication.
protected void	setupDemo(AbstractWrappableAnimation animation, OTSNetwork net) Method that is called when the animation has been created, to add components for a demo.
void	showAnimationClass(Class<? extends Locatable> locatableClass) Set a class to be shown in the animation to true.
void	showGISLayer(String layerName) Set a GIS layer to be shown in the animation to true.
void	stopTimersThreads() Stop the timers and threads that are connected when disposing of this wrappable simulation.
void	toggleAnimationClass(Class<? extends Locatable> locatableClass) Toggle a class to be displayed in the animation to its reverse value.
void	toggleGISLayer(String layerName) Toggle a GIS layer to be displayed in the animation to its reverse value.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opentrafficsim.simulationengine.WrappableAnimation

description, shortName

Field Detail

properties

protected List<Property<?>> properties

The properties exhibited by this simulation.

savedUserModifiedProperties

protected List<Property<?>> savedUserModifiedProperties

The properties after (possible) editing by the user.

frameProperties

protected Properties frameProperties

Properties for the frame appearance (not simulation related).

exitOnClose

protected boolean exitOnClose

Use EXIT_ON_CLOSE when true, DISPOSE_ON_CLOSE when false on closing of the window.

panel

protected OTSAnimationPanel panel

The tabbed panel so other tabs can be added by the classes that extend this class.

Constructor Detail

AbstractWrappableAnimation

public AbstractWrappableAnimation()

Method Detail

buildSimpleAnimator

protected SimpleAnimator buildSimpleAnimator(Time startTime,
                                             Duration warmupPeriod,
                                             Duration runLength,
                                             OTSModelInterface otsModel)
                                      throws SimRuntimeException,
                                             NamingException,
                                             PropertyException

Build the animator.

Parameters:

startTime - Time; the start time

warmupPeriod - Duration; the warm up period

runLength - Duration; the duration of the simulation / animation

otsModel - OTSModelInterface; the simulation model

Returns:

SimpleAnimator; a newly constructed animator

Throws:

SimRuntimeException - on ???

NamingException - when context for the animation cannot be created

PropertyException - when one of the user modified properties has the empty string as key

buildSimpleAnimator

protected SimpleAnimator buildSimpleAnimator(Time startTime,
                                             Duration warmupPeriod,
                                             Duration runLength,
                                             OTSModelInterface otsModel,
                                             int replicationNumber)
                                      throws SimRuntimeException,
                                             NamingException,
                                             PropertyException

Build the animator with the specified replication number.

Parameters:

startTime - Time; the start time

warmupPeriod - Duration; the warm up period

runLength - Duration; the duration of the simulation / animation

otsModel - OTSModelInterface; the simulation model

replicationNumber - int; the replication number

Returns:

SimpleAnimator; a newly constructed animator

Throws:

SimRuntimeException - on ???

NamingException - when context for the animation cannot be created

PropertyException - when one of the user modified properties has the empty string as key

buildAnimator

public SimpleAnimator buildAnimator(Time startTime,
                                    Duration warmupPeriod,
                                    Duration runLength,
                                    List<Property<?>> userModifiedProperties,
                                    Rectangle rect,
                                    boolean eoc)
                             throws SimRuntimeException,
                                    NamingException,
                                    OTSSimulationException,
                                    PropertyException

Build the animation.

Specified by:

buildAnimator in interface WrappableAnimation

Parameters:

startTime - Time; the start time of the simulation

warmupPeriod - Duration; the warm up period of the simulation (use new Duration(0, SECOND) if you don't know what this is)

runLength - Duration; the duration of the simulation

userModifiedProperties - List<Property<?>>; the (possibly user-modified) properties. This list must contain all the properties returned by getProperties(); any additional properties may be ignored

rect - the x, y, width and height for the window to rebuild. Use null for maximized screen.

eoc - Use EXIT_ON_CLOSE when true, DISPOSE_ON_CLOSE when false on closing of the window.

Returns:

SimpleSimulation; the new simulation

Throws:

SimRuntimeException - on ???

NamingException - when context for the animation cannot be created

OTSSimulationException - when the construction of the simulation, the control panel, the animation, or the charts fails

PropertyException - when one of the user modified properties has the empty string as key

setAppearance

public void setAppearance(Appearance appearance)

Sets an appearance.

Parameters:

appearance - Appearance; appearance

getAppearance

public Appearance getAppearance()

Returns the appearance.

Returns:

Appearance; appearance

getColorer

public GTUColorer getColorer()

Overridable method to return GTU colorer.

Returns:

GTU colorer

addTabs

protected void addTabs(SimpleSimulatorInterface simulator)
                throws OTSSimulationException,
                       PropertyException

Make additional tabs in the main simulation window.

Parameters:

simulator - SimpleSimulatorInterface; the simulator

Throws:

OTSSimulationException - in case the chart, axes or legend cannot be generated

PropertyException - when one of the user modified properties has the empty string as key

addAnimationToggles

protected void addAnimationToggles()

Placeholder method to place animation buttons or to show/hide classes on the animation.

setupDemo

protected void setupDemo(AbstractWrappableAnimation animation,
                         OTSNetwork net)

Method that is called when the animation has been created, to add components for a demo.

Parameters:

animation - AbstractWrappableAnimation; animation

net - OTSNetwork; network

addToggleAnimationButtonIcon

public final void addToggleAnimationButtonIcon(String name,
                                               Class<? extends Locatable> locatableClass,
                                               String iconPath,
                                               String toolTipText,
                                               boolean initiallyVisible,
                                               boolean idButton)

Add a button for toggling an animatable class on or off. Button icons for which 'idButton' is true will be placed to the right of the previous button, which should be the corresponding button without the id. An example is an icon for showing/hiding the class 'Lane' followed by the button to show/hide the Lane ids.

Parameters:

name - the name of the button

locatableClass - the class for which the button holds (e.g., GTU.class)

iconPath - the path to the 24x24 icon to display

toolTipText - the tool tip text to show when hovering over the button

initiallyVisible - whether the class is initially shown or not

idButton - id button that needs to be placed next to the previous button

addToggleAnimationButtonText

public final void addToggleAnimationButtonText(String name,
                                               Class<? extends Locatable> locatableClass,
                                               String toolTipText,
                                               boolean initiallyVisible)

Add a button for toggling an animatable class on or off.

Parameters:

name - the name of the button

locatableClass - the class for which the button holds (e.g., GTU.class)

toolTipText - the tool tip text to show when hovering over the button

initiallyVisible - whether the class is initially shown or not

showAnimationClass

public final void showAnimationClass(Class<? extends Locatable> locatableClass)

Set a class to be shown in the animation to true.

Parameters:

locatableClass - the class for which the animation has to be shown.

hideAnimationClass

public final void hideAnimationClass(Class<? extends Locatable> locatableClass)

Set a class to be hidden in the animation to true.

Parameters:

locatableClass - the class for which the animation has to be hidden.

toggleAnimationClass

public final void toggleAnimationClass(Class<? extends Locatable> locatableClass)

Toggle a class to be displayed in the animation to its reverse value.

Parameters:

locatableClass - the class for which a visible animation has to be turned off or vice versa.

addToggleGISButtonText

public final void addToggleGISButtonText(String header,
                                         GisRenderable2D gisMap,
                                         String toolTipText)

Add a button for toggling a GIS class on or off.

Parameters:

header - the name of the group of layers

gisMap - the GIS map for which the toggles have to be added

toolTipText - the tool tip text to show when hovering over the button

showGISLayer

public final void showGISLayer(String layerName)

Set a GIS layer to be shown in the animation to true.

Parameters:

layerName - the name of the GIS-layer that has to be shown.

hideGISLayer

public final void hideGISLayer(String layerName)

Set a GIS layer to be hidden in the animation to true.

Parameters:

layerName - the name of the GIS-layer that has to be hidden.

toggleGISLayer

public final void toggleGISLayer(String layerName)

Toggle a GIS layer to be displayed in the animation to its reverse value.

Parameters:

layerName - the name of the GIS-layer that has to be turned off or vice versa.

makeModel

protected abstract OTSModelInterface makeModel()
                                        throws OTSSimulationException

Returns:

the demo model. Don't forget to keep a local copy.

Throws:

OTSSimulationException - in case the construction of the model fails

makeAnimationRectangle

protected Rectangle2D makeAnimationRectangle()

Return the initial 'home' extent for the animation. The 'Home' button returns to this extent. Override this method when a smaller or larger part of the infra should be shown. In the default setting, all currently visible objects are shown.

Returns:

the initial and 'home' rectangle for the animation.

getProperties

public final ArrayList<Property<?>> getProperties()

Retrieve a list of visible properties of the simulation.
The caller can modify the returned result. If the internal format is also an ArrayList it is highly recommended to make a protective copy and return that.

Specified by:

getProperties in interface WrappableAnimation

Returns:

List<Property<?>>; the list of visible properties

rebuildSimulator

public final SimpleSimulatorInterface rebuildSimulator(Rectangle rect)
                                                throws SimRuntimeException,
                                                       NetworkException,
                                                       NamingException,
                                                       OTSSimulationException,
                                                       PropertyException

Restart (rebuild) the simulation.

Specified by:

rebuildSimulator in interface WrappableAnimation

Parameters:

rect - the x, y, width and height for the window to rebuild. Use null for maximized screen.

Returns:

SimpleSimulation; the new simulation

Throws:

SimRuntimeException - on ???

NetworkException - on Network inconsistency

NamingException - when context for the animation cannot be created

OTSSimulationException - when the (re)construction of the simulation model fails

PropertyException - when one of the user modified properties has the empty string as key

getUserModifiedProperties

public final List<Property<?>> getUserModifiedProperties()

Retrieve a list of properties as the user has modified them.

Specified by:

getUserModifiedProperties in interface WrappableAnimation

Returns:

ArrayList<Property<?>>; the list of visible properties

stopTimersThreads

public void stopTimersThreads()

Stop the timers and threads that are connected when disposing of this wrappable simulation.

Specified by:

stopTimersThreads in interface WrappableAnimation

getPanel

public final OTSAnimationPanel getPanel()

Returns:

panel

addTab

public final void addTab(int index,
                         String caption,
                         Container container)

Add a tab to the simulation window. This method can not be called from constructModel because the TabbedPane has not yet been constructed at that time; recommended: override addTabs and call this method from there.

Parameters:

index - int; index of the new tab; use getTabCount() to obtain the valid range

caption - String; caption of the new tab

container - Container; content of the new tab

getTabCount

public final int getTabCount()

Report the current number of tabs in the simulation window. This method can not be called from constructModel because the TabbedPane has not yet been constructed at that time; recommended: override addTabs and call this method from there.

Returns:

int; the number of tabs in the simulation window

setNextReplication

public final void setNextReplication(Integer nextReplication)

Set the number of the next spawned replication.

Specified by:

setNextReplication in interface WrappableAnimation

Parameters:

nextReplication - Integer; the next replication number, or null to use the built-in auto-incrementing replication counter

getDemoPanel

public JPanel getDemoPanel()

Return a panel for on-screen demo controls. The panel is create on first call.

Returns:

JPanel; panel