StageScene

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.threerings.stage.data
Class StageScene

java.lang.Object
  com.threerings.whirled.data.SceneImpl
      com.threerings.stage.data.StageScene

All Implemented Interfaces:: Scene, SpotScene, Cloneable

public class StageScene
extends SceneImpl
implements SpotScene, Cloneable
extends SceneImpl
implements SpotScene, Cloneable

The implementation of the Stage scene interface.

Field Summary
`protected StageSceneModel`	`_model` A reference to our scene model.
`protected ArrayList<com.threerings.miso.data.ObjectInfo>`	`_objects` A list of all interesting scene objects.
`protected SpotSceneImpl`	`_sdelegate` Our spot scene delegate.

Fields inherited from class com.threerings.whirled.data.SceneImpl
`_config`

Constructor Summary
`StageScene(StageSceneModel model, PlaceConfig config)` Creates an instance that will obtain data from the supplied scene model and place config.

Method Summary
`void`	`addObject(com.threerings.miso.data.ObjectInfo info)` Adds a new object to this scene.
`void`	`addPortal(Portal portal)` Adds a portal to this scene, immediately making the requisite modifications to the underlying scene model.
`StageScene`	`clone()`
`Iterator<com.threerings.miso.data.ObjectInfo>`	`enumerateObjects()` Iterates over all of the interesting objects in this scene.
`int`	`getDefaultColor(int classId)` Get the default color id to use for the specified colorization class, or -1 if no default is set.
`Portal`	`getDefaultEntrance()` Returns the portal that represents the default entrance to this scene.
`short`	`getNextPortalId()` Returns the portal id that should be assigned to the next portal added to this scene.
`Portal`	`getPortal(int portalId)` Returns a `Portal` object for the portal with the specified id or null if no portal exists with that id.
`int`	`getPortalCount()` Returns the number of portals in this scene.
`Iterator<Portal>`	`getPortals()` Returns an iterator over the portals in this scene.
`String`	`getType()` Returns the scene type (e.g.
`int`	`getZoneId()` Returns the zone id to which this scene belongs.
`protected void`	`readInterestingObjects()`
`boolean`	`removeObject(com.threerings.miso.data.ObjectInfo info)` Removes an object from this scene.
`void`	`removePortal(Portal portal)` Removes the specified portal from the scene.
`void`	`setDefaultColor(int classId, int colorId)` Set the default color to use for the specified colorization class id.
`void`	`setDefaultEntrance(Portal portal)` Sets the default entrance in this scene, immediately making the requisite modifications to the underlying scene model.
`void`	`setType(String type)` Sets the type of this scene.
`void`	`updateReceived(SceneUpdate update)` Called to inform the scene that an update has been received while the scene was resolved and active.

Methods inherited from class com.threerings.whirled.data.SceneImpl
`getId, getName, getPlaceConfig, getSceneModel, getVersion, setId, setName, setVersion, toString`

Methods inherited from class java.lang.Object
`equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

_model

protected StageSceneModel _model

A reference to our scene model.

_sdelegate

protected SpotSceneImpl _sdelegate

Our spot scene delegate.

_objects

protected ArrayList<com.threerings.miso.data.ObjectInfo> _objects

A list of all interesting scene objects.

Constructor Detail

StageScene

public StageScene(StageSceneModel model,
                  PlaceConfig config)

Creates an instance that will obtain data from the supplied scene model and place config.

Method Detail

getType

public String getType()

Returns the scene type (e.g. "world", "port", "bank", etc.).

getZoneId

public int getZoneId()

Returns the zone id to which this scene belongs.

setType

public void setType(String type)

Sets the type of this scene.

getDefaultColor

public int getDefaultColor(int classId)

Get the default color id to use for the specified colorization class, or -1 if no default is set.

setDefaultColor

public void setDefaultColor(int classId,
                            int colorId)

Set the default color to use for the specified colorization class id. Setting the colorId to -1 disables the default.

enumerateObjects

public Iterator<com.threerings.miso.data.ObjectInfo> enumerateObjects()

Iterates over all of the interesting objects in this scene.

addObject

public void addObject(com.threerings.miso.data.ObjectInfo info)

Adds a new object to this scene.

removeObject

public boolean removeObject(com.threerings.miso.data.ObjectInfo info)

Removes an object from this scene.

updateReceived

public void updateReceived(SceneUpdate update)

Description copied from interface: Scene

Called to inform the scene that an update has been received while the scene was resolved and active. The update should be applied to the underlying scene model and any derivative data should be appropriately updated.

Specified by:: updateReceived in interface Scene
Overrides:: updateReceived in class SceneImpl

clone

public StageScene clone()
                 throws CloneNotSupportedException

Overrides:: clone in class Object

Throws:: CloneNotSupportedException