rle.core.ui
Class CameraModelBase

java.lang.Object
  rle.core.vm.PlugInBase
      rle.core.ui.CameraModelBase

All Implemented Interfaces:

BoardListener, ThingListener, RuntimeDataListener, CameraModel, PlugIn

public class CameraModelBase
extends PlugInBase
implements CameraModel, ThingListener

Handles the internals that drive the Camera display.

 This class listens for several types of events:
 ThingListener - to respond when things move on the board
 BoardListener - to respond to insertions/removals from the board
 RuntimeDataListener - respond to changes in interesting parameters of
 the observer, such as view-radius, infravision, etc.
 

Field Summary

protected PlayPerspective

perspective

Fields inherited from class rle.core.vm.PlugInBase

config, context, parameters

Constructor Summary

CameraModelBase()

Method Summary

void	addListener(CameraModelListener l)
void	center() Calls centerOn(getObserver())
void	centerOn(Thing t) Set the camera's location such that t is at center.
protected java.util.Set<RLPoint>	computeFieldOfView() Compute field-of-view.
void	dataChange(RuntimeDataEvent event) Respond to a RuntimeData change by one of the things we're interested in.
Board	getBoard()
RLRectangle	getBounds()
Camera	getCamera() Retrieve the camera.
RLPoint	getCameraLocation() The camera's location, in the board coordinate system.
Thing	getObserver() Retrieve the observer.
PlayPerspective	getPerspective()
RLDimension	getTileSize() Retrieve the tile size.
RLDimension	getViewportSize() The size in grids of the viewport.
boolean	isKnown(Thing t) Is it known? Something is known if the observer is aware of it, whether or not it is actually drawn by the camera.
java.util.TreeSet<Thing>	knownThings(RLPoint boardLoc) All known Objects at a board location in the following order: player, npc, item, terrain.
void	locationChange(ThingMoveEvent event) When something moves...
void	removeListener(CameraModelListener l)
void	setBoard(Board b)
void	setCamera(Camera c) Set the camera.
void	setCameraLocation(RLPoint loc) Set the camera's location, in the board coordinate system.
void	setObserver(Thing t) Set the observer.
void	setPerspective(PlayPerspective pp)
void	setTileSize(RLDimension d) Set the tile size.
void	thingInsert(ThingInsertEvent event) When any thing is added to the board, we need to listen for its location changes.
void	thingRemove(ThingRemoveEvent event) When anything is removed from the board we stop listening to it and forget it.
void	uninstall() Uninstall this CameraModel.
void	updateObserverFieldOfView() Update the observer's field of view

Methods inherited from class rle.core.vm.PlugInBase

config, getContext, getParameters, paramMap, setConfig, setParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface rle.core.vm.PlugIn

config, getContext, paramMap, setConfig, setParameters

Field Detail

perspective

protected PlayPerspective perspective

Constructor Detail

CameraModelBase

public CameraModelBase()

Method Detail

setPerspective

public void setPerspective(PlayPerspective pp)

Specified by:

setPerspective in interface CameraModel

getPerspective

public PlayPerspective getPerspective()

Specified by:

getPerspective in interface CameraModel

isKnown

public boolean isKnown(Thing t)

Is it known? Something is known if the observer is aware of it, whether or not it is actually drawn by the camera. For example, a lit grid in the observer fov with a monster, item, and floor; all three are known, despite the fact that the camera might only draw the monster.

Specified by:

isKnown in interface CameraModel

getBounds

public RLRectangle getBounds()

Specified by:

getBounds in interface CameraModel

knownThings

public java.util.TreeSet<Thing> knownThings(RLPoint boardLoc)

All known Objects at a board location in the following order: player, npc, item, terrain.

Specified by:

knownThings in interface CameraModel

center

public void center()

Calls centerOn(getObserver())

Specified by:

center in interface CameraModel

setObserver

public void setObserver(Thing t)

Set the observer.

Specified by:

setObserver in interface CameraModel

getObserver

public Thing getObserver()

Retrieve the observer.

Specified by:

getObserver in interface CameraModel

getTileSize

public RLDimension getTileSize()

Retrieve the tile size.

Specified by:

getTileSize in interface CameraModel

setTileSize

public void setTileSize(RLDimension d)

Set the tile size.

Specified by:

setTileSize in interface CameraModel

centerOn

public void centerOn(Thing t)

Set the camera's location such that t is at center.

Specified by:

centerOn in interface CameraModel

getCameraLocation

public RLPoint getCameraLocation()

The camera's location, in the board coordinate system.

Specified by:

getCameraLocation in interface CameraModel

setCameraLocation

public void setCameraLocation(RLPoint loc)

Set the camera's location, in the board coordinate system.

Specified by:

setCameraLocation in interface CameraModel

Parameters:

loc -

getViewportSize

public RLDimension getViewportSize()

The size in grids of the viewport.

Specified by:

getViewportSize in interface CameraModel

setCamera

public void setCamera(Camera c)

Set the camera.

Specified by:

setCamera in interface CameraModel

getCamera

public Camera getCamera()

Retrieve the camera.

Specified by:

getCamera in interface CameraModel

thingInsert

public void thingInsert(ThingInsertEvent event)

When any thing is added to the board, we need to listen for its location changes.

Specified by:

thingInsert in interface BoardListener

thingRemove

public void thingRemove(ThingRemoveEvent event)

When anything is removed from the board we stop listening to it and forget it.

Specified by:

thingRemove in interface BoardListener

locationChange

public void locationChange(ThingMoveEvent event)

When something moves... If it is the observer, we need to compute field-of-view If it is (or was) paintable we need to update the view

Specified by:

locationChange in interface ThingListener

updateObserverFieldOfView

public void updateObserverFieldOfView()

Update the observer's field of view

Specified by:

updateObserverFieldOfView in interface CameraModel

computeFieldOfView

protected java.util.Set<RLPoint> computeFieldOfView()

Compute field-of-view.

dataChange

public void dataChange(RuntimeDataEvent event)

Respond to a RuntimeData change by one of the things we're interested in.

 Observer
   view-radius - changes affect size of field-of-view area
 All
   changes to any data that could affect appearance


Specified by:
dataChange in interface RuntimeDataListener

addListener

public void addListener(CameraModelListener l)

Specified by:

addListener in interface CameraModel

removeListener

public void removeListener(CameraModelListener l)

Specified by:

removeListener in interface CameraModel

uninstall

public void uninstall()

Uninstall this CameraModel.

Specified by:

uninstall in interface CameraModel

setBoard

public void setBoard(Board b)

Specified by:

setBoard in interface CameraModel

getBoard

public Board getBoard()

Specified by:

getBoard in interface CameraModel