rescuecore2.view

Interface ViewLayer

All Known Implementing Classes:

AbstractViewLayer, AnimatedHumanLayer, AreaIconLayer, AreaLayer, AreaNeighboursLayer, BuildingIconLayer, BuildingLayer, CommandLayer, HumanLayer, PositionHistoryLayer, RoadBlockageLayer, RoadLayer, StandardEntityViewLayer, StandardViewLayer

public interface ViewLayer

A layer of a view. The LayerViewComponent is composed of a list of ViewLayer objects.

Method Summary

Modifier and Type	Method and Description
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.
void	initialise(Config config) Initialise this view layer.
boolean	isVisible() Find out if this layer should be rendered or not.
java.util.Collection<RenderedObject>	render(java.awt.Graphics2D g, ScreenTransform transform, int width, int height) Render this layer and return a collection of RenderedObjects.
void	setLayerViewComponent(LayerViewComponent component) Set the LayerViewComponent for this layer.
void	setVisible(boolean b) Set whether this layer should be rendered or not.
java.awt.geom.Rectangle2D	view(java.lang.Object... objects) Set the list of objects this layer should view.

Method Detail

initialise

void initialise(Config config)

Initialise this view layer.

Parameters:

config - The system configuration.

setLayerViewComponent

void setLayerViewComponent(LayerViewComponent component)

Set the LayerViewComponent for this layer.

Parameters:

component - The LayerViewComponent that this layer is part of.

getPopupMenuItems

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

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

Returns:

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

view

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

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

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.

render

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

Render this layer and return a collection of RenderedObjects.

Parameters:

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

setVisible

void setVisible(boolean b)

Set whether this layer should be rendered or not.

Parameters:

b - True if this layer should be rendered, false otherwise.

isVisible

boolean isVisible()

Find out if this layer should be rendered or not.

Returns:

True if this layer should be rendered, false otherwise.

getName

java.lang.String getName()

Get the name of this layer.

Returns:

The name of the layer.