rescuecore2.standard.view

Class StandardEntityViewLayer<T extends StandardEntity>

java.lang.Object

rescuecore2.view.AbstractViewLayer

rescuecore2.standard.view.StandardViewLayer

rescuecore2.standard.view.StandardEntityViewLayer<T>

Type Parameters:

T - The subclass of StandardEntity that this layer knows how to render.

All Implemented Interfaces:

ViewLayer

Direct Known Subclasses:

AreaIconLayer, AreaLayer, AreaNeighboursLayer, BuildingIconLayer, HumanLayer, PositionHistoryLayer, RoadBlockageLayer

public abstract class StandardEntityViewLayer<T extends StandardEntity>
extends StandardViewLayer

An abstract base class for StandardWorldModel view layers that render standard entities.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<T>	entities The entities this layer should render.

Fields inherited from class rescuecore2.standard.view.StandardViewLayer

VISIBILITY_SUFFIX, world

Fields inherited from class rescuecore2.view.AbstractViewLayer

component

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StandardEntityViewLayer(java.lang.Class<T> clazz) Construct a new StandardViewLayer.

Method Summary

Modifier and Type	Method and Description
protected void	postView() Perform any post-processing required after view(java.lang.Object...) has been called.
protected void	preView() Perform any pre-processing required before view(java.lang.Object...) has been called.
java.util.Collection<RenderedObject>	render(java.awt.Graphics2D g, ScreenTransform transform, int width, int height) Render this layer and return a collection of RenderedObjects.
abstract java.awt.Shape	render(T entity, java.awt.Graphics2D graphics, ScreenTransform transform) Render an entity and return the shape.
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

getPopupMenuItems, isVisible, processView, setLayerViewComponent, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface rescuecore2.view.ViewLayer

getName

Field Detail

entities

protected java.util.List<T extends StandardEntity> entities

The entities this layer should render.

Constructor Detail

StandardEntityViewLayer

protected StandardEntityViewLayer(java.lang.Class<T> clazz)

Construct a new StandardViewLayer.

Parameters:

clazz - The class of entity that this layer can render.

Method Detail

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 g,
                                                   ScreenTransform transform,
                                                   int width,
                                                   int height)

Description copied from interface: ViewLayer

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.

render

public abstract java.awt.Shape render(T entity,
                                      java.awt.Graphics2D graphics,
                                      ScreenTransform transform)

Render an entity and return the shape. This shape is used for resolving mouse-clicks so should represent a hit-box for the entity.

Parameters:

entity - The entity to render.

graphics - The graphics to render on.

transform - A helpful coordinate transformer.

Returns:

A Shape that represents the hit-box of the rendered entity.

preView

protected void preView()

Perform any pre-processing required before view(java.lang.Object...) has been called.

postView

protected void postView()

Perform any post-processing required after view(java.lang.Object...) has been called.