Package org.xj3d.impl.core.eventmodel

Class DefaultEventModelEvaluator

java.lang.Object

org.xj3d.impl.core.eventmodel.DefaultEventModelEvaluator

All Implemented Interfaces:

EventModelEvaluator

public class DefaultEventModelEvaluator
extends Object
implements EventModelEvaluator

Default implementation of the event model evaluator that is renderer-independent.

Event model evaluation works for both VRML97 and X3D, with mixtures of file types.

Version:

$Revision: 1.25 $

Author:

Justin Couch

Constructor Summary

Constructors

Constructor	Description
DefaultEventModelEvaluator()	Construct a new instance of the evaluator.

Method Summary

Modifier and Type	Method	Description
void	addExternalView(ExternalView view)	Add an external view to the evaluator.
void	addNodeObserver(int nodeType, NodeObserver obs)	Add an observer for a specific node type.
void	changeViewpoint(VRMLViewpointNodeType vp)	Request that this viewpoint object is bound at the start of the next frame.
void	clear()	Force clearing all state from this manager now.
void	evaluate(long time)	Run the event model for this frame now.
ContentLoadManager	getContentLoader()	Get the content loader in use by the evaluator.
FrameStateManager	getFrameStateManager()	Get the frame state manager in use by the evaluator.
LayerManager	getLayerManager(int id)	Get the layer manager for the the layer ID.
NodeManager[]	getNodeManagers()	Get the list of external node managers currently in use.
RouteManager	getRouteManager()	Get the route manager in use by the evaluator.
ScriptManager	getScriptManager()	Get the script manager in use by the evaluator.
VRMLClock	getVRMLClock()	Get the VRMLClock instance in use by this evaluator.
void	initialize(ScriptManager scripts, RouteManager router, SensorManager sensors, FrameStateManager fsm, ContentLoadManager elm, ViewpointManager vm, LayerManagerFactory lmf, LayerRenderingManager lrm, NodeManager[] extManagers)	Initialise the evaluator with the given managers.
void	removeExternalView(ExternalView view)	Remove the external view from this evaluator.
void	removeNodeObserver(int nodeType, NodeObserver obs)	Remove the given node observer instance for the specific node type.
void	setErrorReporter(org.j3d.util.ErrorReporter reporter)	Register an error reporter with the engine so that any errors generated by the loading of script code can be reported in a nice, pretty fashion.
void	setInitListener(EventModelInitListener l)	Set the listener for intialisation information.
void	setScene(VRMLScene scene, String useView)	Used to set the scene to the new content.
void	shutdown()	Shutdown the node manager now.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultEventModelEvaluator

public DefaultEventModelEvaluator()

Construct a new instance of the evaluator.

Method Details

initialize

public void initialize(ScriptManager scripts,
 RouteManager router,
 SensorManager sensors,
 FrameStateManager fsm,
 ContentLoadManager elm,
 ViewpointManager vm,
 LayerManagerFactory lmf,
 LayerRenderingManager lrm,
 NodeManager[] extManagers)

Description copied from interface: EventModelEvaluator

Initialise the evaluator with the given managers.

Specified by:

initialize in interface EventModelEvaluator

Parameters:

scripts - The manager for loading scripts

router - The manager for handling routes

sensors - The manager for all sensors

fsm - State manager for the frame

elm - Manager for loading external content

vm - Manager of viewpoint interactions

lmf - Factory for producing new layer managers

lrm - Manager for handling layer rendering

extManagers - List of external managers to handle

addNodeObserver

public void addNodeObserver(int nodeType,
 NodeObserver obs)

Description copied from interface: EventModelEvaluator

Add an observer for a specific node type. A single instance may be registered for more than one type. Each type registered will result in a separate call per frame - one per type. If the observer is currently added for this type ID, the request is ignored.

Specified by:

addNodeObserver in interface EventModelEvaluator

Parameters:

nodeType - The type identifier of the node being observed

obs - The observer instance to add

removeNodeObserver

public void removeNodeObserver(int nodeType,
 NodeObserver obs)

Description copied from interface: EventModelEvaluator

Remove the given node observer instance for the specific node type. It will not be removed for any other requested node types. If the instance is not registered for the given node type ID, the request will be silently ignored.

Specified by:

removeNodeObserver in interface EventModelEvaluator

Parameters:

nodeType - The type identifier of the node being observed

obs - The observer instance to remove

shutdown

public void shutdown()

Description copied from interface: EventModelEvaluator

Shutdown the node manager now. If this is using any external resources it should remove those now as the entire application is about to die

Specified by:

shutdown in interface EventModelEvaluator

setErrorReporter

public void setErrorReporter(org.j3d.util.ErrorReporter reporter)

Description copied from interface: EventModelEvaluator

Register an error reporter with the engine so that any errors generated by the loading of script code can be reported in a nice, pretty fashion. Setting a value of null will clear the currently set reporter. If one is already set, the new value replaces the old.

Specified by:

setErrorReporter in interface EventModelEvaluator

Parameters:

reporter - The instance to use or null

getLayerManager

public LayerManager getLayerManager(int id)

Description copied from interface: EventModelEvaluator

Get the layer manager for the the layer ID.

Specified by:

getLayerManager in interface EventModelEvaluator

Parameters:

id - a value >= 0 that is the ID of the layer to get

Returns:

The layer manager for it

getVRMLClock

public VRMLClock getVRMLClock()

Description copied from interface: EventModelEvaluator

Get the VRMLClock instance in use by this evaluator.

Specified by:

getVRMLClock in interface EventModelEvaluator

Returns:

A reference to the clock

addExternalView

public void addExternalView(ExternalView view)

Description copied from interface: EventModelEvaluator

Add an external view to the evaluator. A view can only be added once. If the view is added more than once, the second and subsequent calls are ignored.

Specified by:

addExternalView in interface EventModelEvaluator

Parameters:

view - The new view to add

removeExternalView

public void removeExternalView(ExternalView view)

Description copied from interface: EventModelEvaluator

Remove the external view from this evaluator. If the view is not currently registered, the request is silently ignored.

Specified by:

removeExternalView in interface EventModelEvaluator

Parameters:

view - The new view to remove

setScene

public void setScene(VRMLScene scene,
 String useView)

Description copied from interface: EventModelEvaluator

Used to set the scene to the new content. Will automatically shutdown the old scene. Assumes a valid scene instance is passed. Also assumes that no clock ticks will be received during the setup phase.

Specified by:

setScene in interface EventModelEvaluator

Parameters:

scene - The new scene instance to use.

useView - The initial viewpoint DEF name to bind to, Null means normal speced viewpoint.

changeViewpoint

public void changeViewpoint(VRMLViewpointNodeType vp)

Description copied from interface: EventModelEvaluator

Request that this viewpoint object is bound at the start of the next frame. This method should only be called by external users such as UI toolkits, etc., that need to synchronize the viewpoint change with rendering loop, but are not able to synchronize themselves because they exist on a different thread that cannot block.

Specified by:

changeViewpoint in interface EventModelEvaluator

Parameters:

vp - The new viewpoint instance to bind to

clear

public void clear()

Description copied from interface: EventModelEvaluator

Force clearing all state from this manager now. This is used to indicate that a new world is about to be loaded and everything should be cleaned out now.

Specified by:

clear in interface EventModelEvaluator

evaluate

public void evaluate(long time)

Description copied from interface: EventModelEvaluator

Run the event model for this frame now. This is a blocking call and does not return until the event model is complete for this frame. The time should be system clock time, not VRML time.

Specified by:

evaluate in interface EventModelEvaluator

Parameters:

time - The timestamp of this frame to evaluate

setInitListener

public void setInitListener(EventModelInitListener l)

Description copied from interface: EventModelEvaluator

Set the listener for intialisation information. Setting null will clear the current instance.

Specified by:

setInitListener in interface EventModelEvaluator

Parameters:

l - The listener instance to set

getScriptManager

public ScriptManager getScriptManager()

Description copied from interface: EventModelEvaluator

Get the script manager in use by the evaluator.

Specified by:

getScriptManager in interface EventModelEvaluator

Returns:

The script manager implementation

getRouteManager

public RouteManager getRouteManager()

Description copied from interface: EventModelEvaluator

Get the route manager in use by the evaluator.

Specified by:

getRouteManager in interface EventModelEvaluator

Returns:

The route manager implementation

getContentLoader

public ContentLoadManager getContentLoader()

Description copied from interface: EventModelEvaluator

Get the content loader in use by the evaluator.

Specified by:

getContentLoader in interface EventModelEvaluator

Returns:

The content loader implementation

getFrameStateManager

public FrameStateManager getFrameStateManager()

Description copied from interface: EventModelEvaluator

Get the frame state manager in use by the evaluator.

Specified by:

getFrameStateManager in interface EventModelEvaluator

Returns:

The frame state manager implementation

getNodeManagers

public NodeManager[] getNodeManagers()

Description copied from interface: EventModelEvaluator

Get the list of external node managers currently in use. If there are no registered managers, returns null.

Specified by:

getNodeManagers in interface EventModelEvaluator

Returns:

An array of managers or null