nl.tudelft.simulation.dsol.web.animation.D2

Class HTMLAnimationPanel

java.lang.Object

nl.tudelft.simulation.dsol.web.animation.D2.HTMLGridPanel

nl.tudelft.simulation.dsol.web.animation.D2.HTMLAnimationPanel

All Implemented Interfaces:

ImageObserver, EventListener, NamespaceChangeListener, NamingListener, nl.tudelft.simulation.event.EventListenerInterface

public class HTMLAnimationPanel
extends HTMLGridPanel
implements nl.tudelft.simulation.event.EventListenerInterface, NamespaceChangeListener

The AnimationPanel to display animated (Locatable) objects. Added the possibility to witch layers on and off. By default all layers will be drawn, so no changes to existing software need to be made.
copyright (c) 2002-2018 Delft University of Technology , the Netherlands.
See for project information www.simulation.tudelft.nl .

Copyright (c) 2002-2019 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See for project information https://simulation.tudelft.nl. The DSOL project is distributed under a three-clause BSD-style license, which can be found at https://simulation.tudelft.nl/dsol/3.0/license.html.

Author:

Peter Jacobs

Field Summary

Fields inherited from class nl.tudelft.simulation.dsol.web.animation.D2.HTMLGridPanel

DOWN, extent, formatter, GRIDCOLOR, gridSize, homeExtent, htmlGraphics2D, lastDimension, LEFT, preferredSize, RIGHT, showGrid, showToolTip, size, UP, worldCoordinate, ZOOMFACTOR

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
HTMLAnimationPanel(Rectangle2D extent, Dimension size, nl.tudelft.simulation.dsol.simulators.SimulatorInterface<?,?,?> simulator) constructs a new AnimationPanel.

Method Summary

Modifier and Type	Method and Description
void	addAllToggleGISButtonText(String header, nl.tudelft.simulation.dsol.animation.D2.GisRenderable2D gisMap, String toolTipText) Add buttons for toggling all GIS layers on or off.
void	addToggleAnimationButtonText(String name, Class<? extends nl.tudelft.simulation.dsol.animation.Locatable> locatableClass, String toolTipText, boolean initiallyVisible) Add a button for toggling an animatable class on or off.
void	addToggleGISButtonText(String layerName, String displayName, nl.tudelft.simulation.dsol.animation.D2.GisRenderable2D gisMap, String toolTipText) Add a button to toggle a GIS Layer on or off.
void	addToggleText(String text) Add a text to explain animatable classes.
Rectangle2D	fullExtent() Calculate the full extent based on the current positions of the objects.
javax.vecmath.Point4i	getDragLine()
SortedSet<nl.tudelft.simulation.dsol.animation.D2.Renderable2DInterface<? extends nl.tudelft.simulation.dsol.animation.Locatable>>	getElements()
List<ToggleButtonInfo>	getToggleButtons()
void	hideClass(Class<? extends nl.tudelft.simulation.dsol.animation.Locatable> locatableClass) Set a class to be hidden in the animation to true.
void	hideClass(String name) Hide a Locatable class based on the name.
void	hideGISLayer(String layerName) Set a GIS layer to be hidden in the animation to true.
boolean	isDragLineEnabled()
boolean	isShowClass(Class<? extends nl.tudelft.simulation.dsol.animation.Locatable> locatableClass) Test whether a certain class needs to be shown on the screen or not.
boolean	isShowElement(nl.tudelft.simulation.dsol.animation.D2.Renderable2DInterface<? extends nl.tudelft.simulation.dsol.animation.Locatable> element) Test whether the element needs to be shown on the screen or not.
void	namingExceptionThrown(NamingExceptionEvent namingEvent)
void	notify(nl.tudelft.simulation.event.EventInterface event)
void	objectAdded(NamingEvent namingEvent)
void	objectRemoved(NamingEvent namingEvent)
void	objectRenamed(NamingEvent namingEvent)
void	paintComponent(HTMLGraphics2D g2) Draw the grid.
void	setDragLineEnabled(boolean dragLineEnabled)
void	showClass(Class<? extends nl.tudelft.simulation.dsol.animation.Locatable> locatableClass) Set a class to be shown in the animation to true.
void	showClass(String name) Show a Locatable class based on the name.
void	showGISLayer(String layerName) Set a GIS layer to be shown in the animation to true.
void	toggleClass(Class<? extends nl.tudelft.simulation.dsol.animation.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.
void	zoomAll() resets the panel to its an extent that covers all displayed objects.

Methods inherited from class nl.tudelft.simulation.dsol.web.animation.D2.HTMLGridPanel

displayWorldCoordinateToolTip, drawGrid, getBackground, getDrawingCommands, getExtent, getFont, getFontMetrics, getHeight, getPreferredSize, getSize, getToolTipText, getWidth, getWorldCoordinate, home, imageUpdate, isDirty, isShowGrid, isShowing, isShowToolTip, pan, repaint, setBackground, setFont, setPreferredSize, setShowGrid, setShowing, setShowToolTip, setSize, setToolTipText, setWorldCoordinate, showGrid, zoom, zoom

Methods inherited from class java.lang.Object

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

Constructor Detail

HTMLAnimationPanel

public HTMLAnimationPanel(Rectangle2D extent,
                          Dimension size,
                          nl.tudelft.simulation.dsol.simulators.SimulatorInterface<?,?,?> simulator)
                   throws RemoteException

constructs a new AnimationPanel.

Parameters:

extent - Rectangle2D; the extent of the panel

size - Dimension; the size of the panel.

simulator - SimulatorInterface<?,?,?>; the simulator of which we want to know the events for animation

Throws:

RemoteException - on network error for one of the listeners

Method Detail

paintComponent

public void paintComponent(HTMLGraphics2D g2)

Draw the grid.

Overrides:

paintComponent in class HTMLGridPanel

Parameters:

g2 - HTMLGraphics2D; the virtual Graphics2D canvas to enable writing to the browser

isShowElement

public boolean isShowElement(nl.tudelft.simulation.dsol.animation.D2.Renderable2DInterface<? extends nl.tudelft.simulation.dsol.animation.Locatable> element)

Test whether the element needs to be shown on the screen or not.

Parameters:

element - Renderable2DInterface<? extends Locatable>; the renderable element to test

Returns:

whether the element needs to be shown or not

isShowClass

public boolean isShowClass(Class<? extends nl.tudelft.simulation.dsol.animation.Locatable> locatableClass)

Test whether a certain class needs to be shown on the screen or not. The class needs to implement Locatable, otherwise it cannot be shown at all.

Parameters:

locatableClass - Class<? extends Locatable>; the class to test

Returns:

whether the class needs to be shown or not

notify

public void notify(nl.tudelft.simulation.event.EventInterface event)
            throws RemoteException

Specified by:

notify in interface nl.tudelft.simulation.event.EventListenerInterface

Throws:

RemoteException

objectAdded

public void objectAdded(NamingEvent namingEvent)

Specified by:

objectAdded in interface NamespaceChangeListener

objectRemoved

public void objectRemoved(NamingEvent namingEvent)

Specified by:

objectRemoved in interface NamespaceChangeListener

objectRenamed

public void objectRenamed(NamingEvent namingEvent)

Specified by:

objectRenamed in interface NamespaceChangeListener

namingExceptionThrown

public void namingExceptionThrown(NamingExceptionEvent namingEvent)

Specified by:

namingExceptionThrown in interface NamingListener

fullExtent

public Rectangle2D fullExtent()

Calculate the full extent based on the current positions of the objects.

Returns:

the full extent of the animation.

zoomAll

public void zoomAll()

resets the panel to its an extent that covers all displayed objects.

showClass

public void showClass(Class<? extends nl.tudelft.simulation.dsol.animation.Locatable> locatableClass)

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

Parameters:

locatableClass - Class<? extends Locatable>; the class for which the animation has to be shown.

hideClass

public void hideClass(Class<? extends nl.tudelft.simulation.dsol.animation.Locatable> locatableClass)

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

Parameters:

locatableClass - Class<? extends Locatable>; the class for which the animation has to be hidden.

toggleClass

public void toggleClass(Class<? extends nl.tudelft.simulation.dsol.animation.Locatable> locatableClass)

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

Parameters:

locatableClass - Class<? extends Locatable>; the class for which a visible animation has to be turned off or vice versa.

getElements

public final SortedSet<nl.tudelft.simulation.dsol.animation.D2.Renderable2DInterface<? extends nl.tudelft.simulation.dsol.animation.Locatable>> getElements()

Returns:

the set of animation elements.

getDragLine

public final javax.vecmath.Point4i getDragLine()

Returns:

returns the dragLine.

isDragLineEnabled

public final boolean isDragLineEnabled()

Returns:

returns the dragLineEnabled.

setDragLineEnabled

public final void setDragLineEnabled(boolean dragLineEnabled)

Parameters:

dragLineEnabled - boolean; the dragLineEnabled to set.

addToggleAnimationButtonText

public final void addToggleAnimationButtonText(String name,
                                               Class<? extends nl.tudelft.simulation.dsol.animation.Locatable> locatableClass,
                                               String toolTipText,
                                               boolean initiallyVisible)

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

Parameters:

name - String; the name of the button

locatableClass - Class<? extends Locatable>; the class for which the button holds (e.g., GTU.class)

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

initiallyVisible - boolean; whether the class is initially shown or not

showClass

public final void showClass(String name)

Show a Locatable class based on the name.

Parameters:

name - the name of the class to show

hideClass

public final void hideClass(String name)

Hide a Locatable class based on the name.

Parameters:

name - the name of the class to hide

addToggleText

public final void addToggleText(String text)

Add a text to explain animatable classes.

Parameters:

text - String; the text to show

addAllToggleGISButtonText

public final void addAllToggleGISButtonText(String header,
                                            nl.tudelft.simulation.dsol.animation.D2.GisRenderable2D gisMap,
                                            String toolTipText)

Add buttons for toggling all GIS layers on or off.

Parameters:

header - String; the name of the group of layers

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

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

addToggleGISButtonText

public final void addToggleGISButtonText(String layerName,
                                         String displayName,
                                         nl.tudelft.simulation.dsol.animation.D2.GisRenderable2D gisMap,
                                         String toolTipText)

Add a button to toggle a GIS Layer on or off.

Parameters:

layerName - String; the name of the layer

displayName - String; the name to display next to the tick box

gisMap - GisRenderable2D; the map

toolTipText - String; the tool tip text

showGISLayer

public final void showGISLayer(String layerName)

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

Parameters:

layerName - String; 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 - String; 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 - String; the name of the GIS-layer that has to be turned off or vice versa.

getToggleButtons

public final List<ToggleButtonInfo> getToggleButtons()

Returns:

toggleButtons