org.jdesktop.wonderland.client.cell
Interface CellCache

All Known Implementing Classes:
CellCacheBasicImpl, JmeCellCache

public interface CellCache

The defining interface for the client Cell Cache

Author:
paulby

Nested Class Summary
static interface CellCache.CellCacheListener
          A listener that will be notified when cells are loaded or unloaded.
 
Method Summary
 void addCellCacheListener(CellCache.CellCacheListener listener)
          Add a cell cache listener
 Cell getCell(CellID cellId)
          Return the cell with the specified id, or null if no such cell exists.
 CellChannelConnection getCellChannelConnection()
          Get the CellChannelConnection
 EnvironmentCell getEnvironmentCell()
          Get the singleton environment cell for the world represented by this cache
 java.util.Collection<Cell> getRootCells()
          Returns a collection of root cells in this cache.
 WonderlandSession getSession()
          Return the session with which this cell cache is associated.
 CellStatistics getStatistics()
          Get the CellStatistics for cells in this cache
 ViewCell getViewCell()
          Returns the ViewCell for this cache
 void removeCellCacheListener(CellCache.CellCacheListener listener)
          Remove a cell cache listener
 void setViewCell(ViewCell viewCell)
          Set the view cell for this cache
 

Method Detail

getCell

Cell getCell(CellID cellId)
Return the cell with the specified id, or null if no such cell exists.

Parameters:
cellId - the id of the cell to return
Returns:
the cell with the specified ID.

getEnvironmentCell

EnvironmentCell getEnvironmentCell()
Get the singleton environment cell for the world represented by this cache

Returns:
the environment cell, or null if there is no environment cell

getSession

WonderlandSession getSession()
Return the session with which this cell cache is associated.

Returns:
the session for this cache

setViewCell

void setViewCell(ViewCell viewCell)
Set the view cell for this cache

Parameters:
viewCell - the view cell

getViewCell

ViewCell getViewCell()
Returns the ViewCell for this cache


getRootCells

java.util.Collection<Cell> getRootCells()
Returns a collection of root cells in this cache. The returned collection is a copy of the internal collection.

Returns:
the RootCells for this cache

getCellChannelConnection

CellChannelConnection getCellChannelConnection()
Get the CellChannelConnection

Returns:
the CellChannelConnection for this CellCache

addCellCacheListener

void addCellCacheListener(CellCache.CellCacheListener listener)
Add a cell cache listener

Parameters:
listener - the listener to add

removeCellCacheListener

void removeCellCacheListener(CellCache.CellCacheListener listener)
Remove a cell cache listener

Parameters:
listener - the listener to remove

getStatistics

CellStatistics getStatistics()
Get the CellStatistics for cells in this cache

Returns:
the cell statistics


Open Wonderland - http://openwonderland.org