view

Class MapPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

view.MapPanel

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class MapPanel
extends javax.swing.JPanel

Visualizes the map.

Author:

S.A.M. Janssen

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<MapComponent>	drawingOrder The order in which the components are drawn.
private int	fps FPS
private Map	map
private java.util.concurrent.ConcurrentHashMap<MapComponent,MapComponentView>	mapComponents The MapComponents that are visible on the Map.
private int	maxX The maximum width.
private int	maxY The maximum height.
private int	numberOfCalls FPS notification
private int	offsetX The offset in the x direction.
private int	offsetY The offset in the y direction.
private double	pixelRatio The pixel ratio.
private long	previousTime Previous time
private java.util.List<java.lang.Class<? extends MapComponentView>>	views The user created views.
private int[]	zoomCoordinates Zoom coordinates indicate the coordinates needed to draw the zoom-in rectangle.
private java.awt.Image	zoomImage The image used to visualize a zoomed in map.

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
MapPanel(Map map, double pixelRatio) Creates the map panel.

Method Summary

Modifier and Type	Method and Description
void	addMapComponent(MapComponent component) Adds a MapComponent to the map.
private void	addMapComponent(MapComponent component, int superClasses) Adds a MapComponent to the map.
void	addMapComponentView(java.lang.Class<? extends MapComponentView> view) Adds a map component view.
void	clicked(int x, int y) Method called when the user clicks the mouse.
void	doZoomRectangle(int xStart, int yStart, int xEnd, int yEnd) Indicates the coordinates that are needed for the zoom in rectangle.
void	paint(java.awt.Graphics g)
void	remove(MapComponent mapComponent) Removes a MapComponent from the map panel.
void	setPixelRatio(double pixelRatio) Sets the pixel ratio.
void	update(int timeStep, double time) Update the map panel.
void	zoom(int xStart, int yStart, int xEnd, int yEnd, double mapWidth) Calculates the parameters needed for the user specified zoom.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

drawingOrder

private java.util.List<MapComponent> drawingOrder

The order in which the components are drawn.

fps

private int fps

FPS

mapComponents

private java.util.concurrent.ConcurrentHashMap<MapComponent,MapComponentView> mapComponents

The MapComponents that are visible on the Map.

maxX

private int maxX

The maximum width. This is used for zooming in.

maxY

private int maxY

The maximum height. This is used for zooming in.

numberOfCalls

private int numberOfCalls

FPS notification

offsetX

private int offsetX

The offset in the x direction. This is used for zooming in.

offsetY

private int offsetY

The offset in the y direction. This is used for zooming in.

pixelRatio

private double pixelRatio

The pixel ratio.

previousTime

private long previousTime

Previous time

zoomCoordinates

private int[] zoomCoordinates

Zoom coordinates indicate the coordinates needed to draw the zoom-in rectangle.

zoomImage

private java.awt.Image zoomImage

The image used to visualize a zoomed in map.

views

private java.util.List<java.lang.Class<? extends MapComponentView>> views

The user created views.

map

private Map map

Constructor Detail

MapPanel

public MapPanel(Map map,
                double pixelRatio)

Creates the map panel.

Parameters:

map - The map.

pixelRatio - The pixel ratio.

Method Detail

addMapComponent

public void addMapComponent(MapComponent component)

Adds a MapComponent to the map. It is assumed that a MapComponent has a MapComponentView that visualizes the MapComponent. The naming convention for a MapComponentView is: "MapComponentName"+"View". For instance, the MapComponent HumanAgent has a MapComponentView called HumanAgentView.

Parameters:

component - The component.

addMapComponent

private void addMapComponent(MapComponent component,
                             int superClasses)

Adds a MapComponent to the map. It is a recursive method that at takes a component and a value as an input. The value represents the number of super classes above the component we want to add a visualization of. This is used, because some map components do not have a specific visualization. For instance, the Passenger does not have a view corresponding to it, but the HumanAgent (the superclass of Passenger) does have a corresponding view.

Parameters:

component - The component.

superClasses - The number of super classes above.

addMapComponentView

public void addMapComponentView(java.lang.Class<? extends MapComponentView> view)

Adds a map component view.

Parameters:

view - The view.

clicked

public void clicked(int x,
                    int y)

Method called when the user clicks the mouse. It is used to show about boxes for map components.

Parameters:

x - The x coordinate.

y - The y coordinate.

doZoomRectangle

public void doZoomRectangle(int xStart,
                            int yStart,
                            int xEnd,
                            int yEnd)

Indicates the coordinates that are needed for the zoom in rectangle.

Parameters:

xStart - Top left x coordinate.

yStart - Top left y coordinate.

xEnd - Bottom right x coordinate.

yEnd - Bottom right y coordinate.

paint

public void paint(java.awt.Graphics g)

Overrides:

paint in class javax.swing.JComponent

remove

public void remove(MapComponent mapComponent)

Removes a MapComponent from the map panel.

Parameters:

mapComponent - The map component.

setPixelRatio

public void setPixelRatio(double pixelRatio)

Sets the pixel ratio.

Parameters:

pixelRatio - The pixel ratio.

update

public void update(int timeStep,
                   double time)

Update the map panel.

Parameters:

timeStep - The time step.

time - The time.

zoom

public void zoom(int xStart,
                 int yStart,
                 int xEnd,
                 int yEnd,
                 double mapWidth)

Calculates the parameters needed for the user specified zoom. It ensures that the users specified ratio is respected, while making sure that the maximum dimensions are used.

Parameters:

xStart - Top left x coordinate.

yStart - Top left y coordinate.

xEnd - Bottom right x coordinate.

yEnd - Bottom right y coordinate.

mapWidth - The width of the map.