SceneManager (ZVTM-ZUIST 0.12.0 API)

java.lang.Object
- fr.inria.zuist.engine.SceneManager

```
public class SceneManager
extends Object
```
Multi-scale scene manager: main ZUIST class instantiated by client application.

Author:

Emmanuel Pietriga

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`HTTP_AUTH_PASSWORD`
`static String`	`HTTP_AUTH_USER`
`static String`	`SO_CAMERA`
`static String`	`SO_PARAMS`
`static String`	`SO_TYPE`
`static short`	`SO_TYPE_TVSO`
`static short`	`SO_TYPE_VSO`
`static String`	`SO_VIRTUAL_SPACES`
`static short`	`TAKES_TO_OBJECT`
`static short`	`TAKES_TO_REGION`

Constructor Summary

Constructors
Constructor and Description
`SceneManager(HashMap<String,Object>[] soDescriptions, HashMap<String,String> properties)`
`SceneManager(SceneObserver[] sos, HashMap<String,String> properties)` Scene Manager: Main ZUIST class instantiated by client application.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addSceneObserver(SceneObserver so)`
`static SceneObserver[]`	`buildObservers(HashMap<String,Object>[] soDescriptions)`
`ObjectPicker`	`createObjectPicker(int tl, int bl)`
`RegionPicker`	`createRegionPicker(int tl, int bl)`
`void`	`enableRegionUpdater(boolean b)`
`double[]`	`findFarmostRegionCoords()` Get the bounding box of all regions in this scene.
`Region`	`getClosestRegionAtCurrentLevel(Point2D.Double lp, int level)` Get region whose center is closest to a given location at level l.
`static boolean`	`getDebugMode()`
`static String`	`getHTTPPassword()`
`static String`	`getHTTPUser()`
`Level`	`getLevel(int index)` Get a level.
`int`	`getLevelCount()` Get the total number of levels in the scene.
`ObjectDescription`	`getObject(String id)` Get an object knowing its ID.
`int`	`getObjectCount()` Get the total number of objects (at any level and in any region) in the scene.
`Collection<ObjectDescription>`	`getObjectDescriptions()` Gets an unmodifiable view of every ObjectDescription known to this SceneManager
`Set<String>`	`getObjectIDs()` Get a list of all object IDs, at any level and in any region.
`ObjectListener`	`getObjectListener()`
`Point2D.Double`	`getOrigin()` Is set to something else than 0,0 when translating a scene to another location than that defined originally.
`int`	`getPendingRequestQueueSize()`
`Region`	`getRegion(String id)` Get a region knowing its ID.
`int`	`getRegionCount()` Get the total number of regions (at any level) in the scene.
`Set<String>`	`getRegionIDs()`
`Region[]`	`getRegionsAtLevel(int level)` Get all regions that belong to a given level.
`ResourceHandler`	`getResourceHandler(String rType)` Get the class handling a given type of resource.
`HashMap`	`getSceneAttributes()`
`SceneBuilder`	`getSceneBuilder()`
`Region[]`	`loadScene(Document scene, File sceneFileDirectory, boolean reset)` Load a multi-scale scene configuration described in an XML document.
`Region[]`	`loadScene(Document scene, File sceneFileDirectory, boolean reset, ProgressListener pl)` Load a multi-scale scene configuration described in an XML document.
`void`	`objectCreated(ObjectDescription od)` For internal use.
`void`	`objectDestroyed(ObjectDescription od)` For internal use.
`void`	`removeSceneObserver(SceneObserver so)`
`void`	`reset()`
`static void`	`setDebugMode(boolean b)`
`void`	`setFadeInDuration(int d)`
`void`	`setFadeOutDuration(int d)`
`static void`	`setHTTPPassword(String p)`
`static void`	`setHTTPUser(String u)`
`void`	`setObjectListener(ObjectListener ol)`
`void`	`setOrigin(Point2D.Double p)` Set to something else than 0,0 to translate a scene to another location than that defined originally.
`void`	`setProperties(HashMap<String,String> properties)` Set properties on this scene manager.
`void`	`setRegionUpdatePeriod(int period)` Sets the RegionUpdater period.
`void`	`setResourceHandler(String rType, ResourceHandler rh)` Declare a ResourceHandler for a given type of resource.
`void`	`setUpdateLevel(boolean b)` Enable/disable level updating.
`void`	`shutdown()` Shuts down this SceneManager.
`void`	`updateVisibleRegions()` Update visible regions for all cameras.

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

- Field Detail
  - TAKES_TO_OBJECT
```
public static final short TAKES_TO_OBJECT
```
    See Also:
    
    Constant Field Values
  - TAKES_TO_REGION
```
public static final short TAKES_TO_REGION
```
    See Also:
    
    Constant Field Values
  - SO_TYPE
```
public static final String SO_TYPE
```
    See Also:
    
    Constant Field Values
  - SO_CAMERA
```
public static final String SO_CAMERA
```
    See Also:
    
    Constant Field Values
  - SO_VIRTUAL_SPACES
```
public static final String SO_VIRTUAL_SPACES
```
    See Also:
    
    Constant Field Values
  - SO_PARAMS
```
public static final String SO_PARAMS
```
    See Also:
    
    Constant Field Values
  - SO_TYPE_VSO
```
public static final short SO_TYPE_VSO
```
    See Also:
    
    Constant Field Values
  - SO_TYPE_TVSO
```
public static final short SO_TYPE_TVSO
```
    See Also:
    
    Constant Field Values
  - HTTP_AUTH_USER
```
public static final String HTTP_AUTH_USER
```
    See Also:
    
    Constant Field Values
  - HTTP_AUTH_PASSWORD
```
public static final String HTTP_AUTH_PASSWORD
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SceneManager
```
public SceneManager(SceneObserver[] sos,
                    HashMap<String,String> properties)
```
    Scene Manager: Main ZUIST class instantiated by client application.
    
    Parameters:
    
    sos - scene observers through which the scene will be observed.
    
    properties - properties that can be set on this scene manager.
    
    See Also:
    
    setProperties(HashMap properties)
  - SceneManager
```
public SceneManager(HashMap<String,Object>[] soDescriptions,
                    HashMap<String,String> properties)
```
- Method Detail
  - buildObservers
```
public static SceneObserver[] buildObservers(HashMap<String,Object>[] soDescriptions)
```
  - getSceneBuilder
```
public SceneBuilder getSceneBuilder()
```
  - setProperties
```
public void setProperties(HashMap<String,String> properties)
```
    Set properties on this scene manager.
    - HTTP_AUTH_USER: username as a string for HTTP authentication when fetching resources from the Web.
    - HTTP_AUTH_PASSWORD: password as a string for HTTP authentication when fetching resources from the Web.
  - setHTTPUser
```
public static void setHTTPUser(String u)
```
  - setHTTPPassword
```
public static void setHTTPPassword(String p)
```
  - getHTTPUser
```
public static String getHTTPUser()
```
  - getHTTPPassword
```
public static String getHTTPPassword()
```
  - addSceneObserver
```
public void addSceneObserver(SceneObserver so)
```
  - removeSceneObserver
```
public void removeSceneObserver(SceneObserver so)
```
  - setRegionUpdatePeriod
```
public void setRegionUpdatePeriod(int period)
```
    Sets the RegionUpdater period. Region updates will be spaced by at least period milliseconds.
    
    Parameters:
    
    period - the new period, in milliseconds.
  - shutdown
```
public void shutdown()
```
    Shuts down this SceneManager. The SceneManager should not be used after invoking shutdown.
  - setResourceHandler
```
public void setResourceHandler(String rType,
                               ResourceHandler rh)
```
    Declare a ResourceHandler for a given type of resource.
    
    Parameters:
    
    rType - type of resource to be handled, e.g., "pdf", "img", ...
    
    rh - class implementing ResourceHandler for that type of resource
  - getResourceHandler
```
public ResourceHandler getResourceHandler(String rType)
```
    Get the class handling a given type of resource.
    
    Parameters:
    
    rType - type of resource to handled, e.g., "pdf", "img", ...
    
    Returns:
    
    instance of class implementing ResourceHandler for that type of resource. Null if none associated with rType.
  - getObjectDescriptions
```
public Collection<ObjectDescription> getObjectDescriptions()
```
    Gets an unmodifiable view of every ObjectDescription known to this SceneManager
  - setOrigin
```
public void setOrigin(Point2D.Double p)
```
    Set to something else than 0,0 to translate a scene to another location than that defined originally.
  - getOrigin
```
public Point2D.Double getOrigin()
```
    Is set to something else than 0,0 when translating a scene to another location than that defined originally.
  - getSceneAttributes
```
public HashMap getSceneAttributes()
```
    Returns:
    
    the actual hashmap used internally to store scene attributes.
  - getRegionIDs
```
public Set<String> getRegionIDs()
```
  - getRegion
```
public Region getRegion(String id)
```
    Get a region knowing its ID.
    
    Returns:
    
    null if no region associated with this ID.
  - getObjectIDs
```
public Set<String> getObjectIDs()
```
    Get a list of all object IDs, at any level and in any region.
    
    Returns:
    
    sequence of object IDs in no particular order
  - getObject
```
public ObjectDescription getObject(String id)
```
    Get an object knowing its ID.
    
    Returns:
    
    null if no object associated with this ID.
  - getObjectCount
```
public int getObjectCount()
```
    Get the total number of objects (at any level and in any region) in the scene.
  - getRegionCount
```
public int getRegionCount()
```
    Get the total number of regions (at any level) in the scene.
  - getLevelCount
```
public int getLevelCount()
```
    Get the total number of levels in the scene.
  - getLevel
```
public Level getLevel(int index)
```
    Get a level.
    
    Parameters:
    
    index - index of level.
    
    Returns:
    
    null if level index does not correspond to an actual level.
  - getRegionsAtLevel
```
public Region[] getRegionsAtLevel(int level)
```
    Get all regions that belong to a given level.
    
    Parameters:
    
    level - index of level.
    
    Returns:
    
    sequence of regions at this level, in no particular order. Returns null if level index does not correspond to an actual level.
  - loadScene
```
public Region[] loadScene(Document scene,
                          File sceneFileDirectory,
                          boolean reset)
```
    Load a multi-scale scene configuration described in an XML document.
    
    Parameters:
    
    scene - XML document (DOM) containing the scene description
    
    sceneFileDirectory - absolute or relative (w.r.t exec dir) path to the directory containing that XML file (required only if the scene contains image objects whose location is indicated as relative paths to the bitmap files)
    
    reset - reset scene (default is true) ; if false, append regions and objects to existing scene, new levels are ignored (as they would most likely conflict).
  - loadScene
```
public Region[] loadScene(Document scene,
                          File sceneFileDirectory,
                          boolean reset,
                          ProgressListener pl)
```
    Load a multi-scale scene configuration described in an XML document.
    
    Parameters:
    
    scene - XML document (DOM) containing the scene description
    
    sceneFileDirectory - absolute or relative (w.r.t exec dir) path to the directory containing that XML file (required only if the scene contains image objects whose location is indicated as relative paths to the bitmap files)
    
    reset - reset scene (default is true) ; if false, append regions and objects to existing scene, new levels are ignored (as they would most likely conflict).
  - createRegionPicker
```
public RegionPicker createRegionPicker(int tl,
                                       int bl)
```
  - createObjectPicker
```
public ObjectPicker createObjectPicker(int tl,
                                       int bl)
```
  - getPendingRequestQueueSize
```
public int getPendingRequestQueueSize()
```
  - setObjectListener
```
public void setObjectListener(ObjectListener ol)
```
  - getObjectListener
```
public ObjectListener getObjectListener()
```
  - objectCreated
```
public void objectCreated(ObjectDescription od)
```
    For internal use.
  - objectDestroyed
```
public void objectDestroyed(ObjectDescription od)
```
    For internal use. Made public for outside package subclassing
  - reset
```
public void reset()
```
  - enableRegionUpdater
```
public void enableRegionUpdater(boolean b)
```
  - setUpdateLevel
```
public void setUpdateLevel(boolean b)
```
    Enable/disable level updating. Calls to updateLevel(altitude) have no effect if level updating is disabled.
    
    See Also:
    
    updateLevel(SceneObserver so)
  - getClosestRegionAtCurrentLevel
```
public Region getClosestRegionAtCurrentLevel(Point2D.Double lp,
                                             int level)
```
    Get region whose center is closest to a given location at level l.
  - updateVisibleRegions
```
public void updateVisibleRegions()
```
    Update visible regions for all cameras.
  - setFadeInDuration
```
public void setFadeInDuration(int d)
```
  - setFadeOutDuration
```
public void setFadeOutDuration(int d)
```
  - findFarmostRegionCoords
```
public double[] findFarmostRegionCoords()
```
    Get the bounding box of all regions in this scene.
    
    Returns:
    
    bounds in virtual space
  - setDebugMode
```
public static void setDebugMode(boolean b)
```
  - getDebugMode
```
public static boolean getDebugMode()
```

Copyright © 2000-2002 Xerox Corporation. All Rights Reserved
Copyright © 2003 World Wide Web Consortium. All Rights Reserved
Copyright © 2004-2015 INRIA. All Rights Reserved
Licensed under the GNU LGPL. For full terms see the file COPYING.

Class SceneManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TAKES_TO_OBJECT

TAKES_TO_REGION

SO_TYPE

SO_CAMERA

SO_VIRTUAL_SPACES

SO_PARAMS

SO_TYPE_VSO

SO_TYPE_TVSO

HTTP_AUTH_USER

HTTP_AUTH_PASSWORD

Constructor Detail

SceneManager

SceneManager

Method Detail

buildObservers

getSceneBuilder

setProperties

setHTTPUser

setHTTPPassword

getHTTPUser

getHTTPPassword

addSceneObserver

removeSceneObserver

setRegionUpdatePeriod

shutdown

setResourceHandler

getResourceHandler

getObjectDescriptions

setOrigin

getOrigin

getSceneAttributes

getRegionIDs

getRegion

getObjectIDs

getObject

getObjectCount

getRegionCount

getLevelCount

getLevel

getRegionsAtLevel

loadScene

loadScene

createRegionPicker

createObjectPicker

getPendingRequestQueueSize

setObjectListener

getObjectListener

objectCreated

objectDestroyed

reset

enableRegionUpdater

setUpdateLevel

getClosestRegionAtCurrentLevel

updateVisibleRegions

setFadeInDuration

setFadeOutDuration

findFarmostRegionCoords

setDebugMode

getDebugMode