rescuecore2.standard.view

Class CommandLayer

java.lang.Object

rescuecore2.view.AbstractViewLayer

rescuecore2.standard.view.StandardViewLayer

rescuecore2.standard.view.CommandLayer

All Implemented Interfaces:

ViewLayer

public class CommandLayer
extends StandardViewLayer

A layer for viewing commands.

Field Summary

Fields inherited from class rescuecore2.standard.view.StandardViewLayer

VISIBILITY_SUFFIX, world

Fields inherited from class rescuecore2.view.AbstractViewLayer

component

Constructor Summary

Constructors

Constructor and Description
CommandLayer() Construct a new CommandLayer.

Method Summary

Modifier and Type	Method and Description
void	drawArea(java.awt.geom.Area area)
static java.awt.geom.Area	getClearArea(Human agent, int targetX, int targetY, int clearLength, int clearRad)
java.lang.String	getName() Get the name of this layer.
java.util.List<javax.swing.JMenuItem>	getPopupMenuItems() Get the menu items this layer wants added to the LayerViewComponent popup menu.
java.util.Collection<RenderedObject>	render(java.awt.Graphics2D graphics, ScreenTransform transform, int width, int height) Render this layer and return a collection of RenderedObjects.
void	setRenderClear(boolean render) Set whether to render Clear commands.
void	setRenderClearArea(boolean render) Set whether to render Clear commands.
void	setRenderExtinguish(boolean render) Set whether to render Extinguish commands.
void	setRenderLoad(boolean render) Set whether to render Load commands.
void	setRenderMove(boolean render) Set whether to render Move commands.
void	setRenderRescue(boolean render) Set whether to render Rescue commands.
void	setRenderUnload(boolean render) Set whether to render Unload commands.
java.awt.geom.Rectangle2D	view(java.lang.Object... objects) Set the list of objects this layer should view.
protected void	viewObject(java.lang.Object o) Callback function for processing a concrete viewable object.

Methods inherited from class rescuecore2.standard.view.StandardViewLayer

initialise

Methods inherited from class rescuecore2.view.AbstractViewLayer

isVisible, processView, setLayerViewComponent, setVisible

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandLayer

public CommandLayer()

Construct a new CommandLayer.

Method Detail

setRenderMove

public void setRenderMove(boolean render)

Set whether to render Move commands.

Parameters:

render - True if move commands should be rendered, false otherwise.

setRenderExtinguish

public void setRenderExtinguish(boolean render)

Set whether to render Extinguish commands.

Parameters:

render - True if extinguish commands should be rendered, false otherwise.

setRenderClear

public void setRenderClear(boolean render)

Set whether to render Clear commands.

Parameters:

render - True if clear commands should be rendered, false otherwise.

setRenderClearArea

public void setRenderClearArea(boolean render)

Set whether to render Clear commands.

Parameters:

render - True if clear commands should be rendered, false otherwise.

setRenderLoad

public void setRenderLoad(boolean render)

Set whether to render Load commands.

Parameters:

render - True if load commands should be rendered, false otherwise.

setRenderUnload

public void setRenderUnload(boolean render)

Set whether to render Unload commands.

Parameters:

render - True if unload commands should be rendered, false otherwise.

setRenderRescue

public void setRenderRescue(boolean render)

Set whether to render Rescue commands.

Parameters:

render - True if rescue commands should be rendered, false otherwise.

getPopupMenuItems

public java.util.List<javax.swing.JMenuItem> getPopupMenuItems()

Description copied from interface: ViewLayer

Get the menu items this layer wants added to the LayerViewComponent popup menu.

Specified by:

getPopupMenuItems in interface ViewLayer

Overrides:

getPopupMenuItems in class AbstractViewLayer

Returns:

A list of menu items, or null if no menu items are required.

getName

public java.lang.String getName()

Description copied from interface: ViewLayer

Get the name of this layer.

Returns:

The name of the layer.

view

public java.awt.geom.Rectangle2D view(java.lang.Object... objects)

Description copied from interface: ViewLayer

Set the list of objects this layer should view. The layer should record the objects it understands and draw them when ViewLayer.render(Graphics2D, ScreenTransform, int, int) is called.

Specified by:

view in interface ViewLayer

Overrides:

view in class StandardViewLayer

Parameters:

objects - The objects to view.

Returns:

A Rectangle2D with the bounds of the area this layer wants to draw. This may be null if this layer has nothing to draw.

viewObject

protected void viewObject(java.lang.Object o)

Description copied from class: AbstractViewLayer

Callback function for processing a concrete viewable object.

Overrides:

viewObject in class StandardViewLayer

Parameters:

o - The object to process.

render

public java.util.Collection<RenderedObject> render(java.awt.Graphics2D graphics,
                                                   ScreenTransform transform,
                                                   int width,
                                                   int height)

Description copied from interface: ViewLayer

Render this layer and return a collection of RenderedObjects.

Parameters:

graphics - The graphics to render to.

transform - The ScreenTransform that will convert world coordinates to screen coordinates.

width - The width of the screen in pixels.

height - The height of the screen in pixels.

Returns:

A set of RenderedObjects representing the things that were actually rendered.

getClearArea

public static java.awt.geom.Area getClearArea(Human agent,
                                              int targetX,
                                              int targetY,
                                              int clearLength,
                                              int clearRad)

drawArea

public void drawArea(java.awt.geom.Area area)