Package org.web3d.vrml.renderer.common.input

Class DefaultSensorManager

java.lang.Object

org.web3d.vrml.renderer.common.input.DefaultSensorManager

All Implemented Interfaces:

SensorManager

public class DefaultSensorManager
extends Object
implements SensorManager

Common implementation of the SensorManager interface for all renderers.

This base class handles the basic management needs of the sensor manager, such as sorting and processing the various sensor types. Renderer-specific extensions then process the sensors according to their specific needs.

Version:

$Revision: 1.12 $

Author:

Alan Hudson

Field Summary

Fields

Modifier and Type	Field	Description
protected org.j3d.util.ErrorReporter	errorReporter	Reporter instance for handing out errors
protected InputDeviceManager	inputManager	Buffer for input events
protected float	invWorldScale
protected KeyDeviceSensorManager	keySensors	Manager of key devices
protected LayerSensorManager[]	layerManagers	Managers for each layer keyed by layer number
protected boolean	navigationEnabled	Flag to say if navigation handling should be disabled
protected int	numLayerManagers	Number of currently valid sensor layer managers
protected int	numPointingDeviceSensors	The number of pointing device sensors
protected int	numRenderOrder	The number of valid items in the render order list
protected OriginManager	originManager	Origin manager for dynamic origin calculation
protected PickingManager	pickManager	Picking manager for intersection testing
protected int[]	renderOrder	The order that the layers are presented on screen visually
protected TimeSensorManager	timeSensors	Manager of TimeSensor nodes
protected float	worldScale	The world scale

Constructor Summary

Constructors

Constructor	Description
DefaultSensorManager()	Create a new default instance of the manager.
DefaultSensorManager(TimeSensorManager manager)	Create a new default instance of the manager.

Method Summary

Modifier and Type	Method	Description
void	addLayerSensorManager(LayerSensorManager mgr)	Add a per-layer manager to the sensor manager.
void	addSensors(NodeArray sensors)	Initialise new sensors that are just about to be added to the scene.
void	addViewDependentNodes(NodeArray nodes)	Add view-dependent nodes that need to be updated each frame based on the user's position for rendering.
void	clear()	Force clearing all state from this manager now.
boolean	getNavigationEnabled()	Get the currently set navigation state.
VRMLClock	getVRMLClock()	Get the VRMLClock instance in use by this sensor manager.
void	loadScene(BasicScene scene)	Load the contents of this scene into the sensor manager.
void	processUserInput(int layerId, long time)	Process the user input to the scene now.
void	removeLayerSensorManager(LayerSensorManager mgr)	Remove this layer sensor manager from the system.
void	removeSensors(NodeArray sensors)	Cleanup the given sensors and remove them from the list of processing to be done each frame.
void	removeViewDependentNodes(NodeArray nodes)	Remove these view-dependent nodes from the scene.
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	setInputManager(InputDeviceManager manager)	Set the user input manager to be used by this implementation.
void	setKeyDeviceSensorManager(KeyDeviceSensorManager manager)	Set the manager responsible for handling key device sensor.
void	setNavigationEnabled(boolean state)	Enable or disable navigation processing sub-section of the user input processing.
void	setOriginManager(OriginManager manager)	Set the manager for handling dynamic origin calculation.
void	setPickingManager(PickingManager picker)	Set the manager that is responsible for handling picking sensors.
void	setRenderOrder(int[] order, int numValid)	Set the rendering order for all the layers.
void	unloadScene(BasicScene scene)	UnLoad the contents of this scene into the sensor manager.

Methods inherited from class java.lang.Object

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

Field Details

timeSensors

protected TimeSensorManager timeSensors

Manager of TimeSensor nodes

keySensors

protected KeyDeviceSensorManager keySensors

Manager of key devices

pickManager

protected PickingManager pickManager

Picking manager for intersection testing

originManager

protected OriginManager originManager

Origin manager for dynamic origin calculation

layerManagers

protected LayerSensorManager[] layerManagers

Managers for each layer keyed by layer number

numLayerManagers

protected int numLayerManagers

Number of currently valid sensor layer managers

inputManager

protected InputDeviceManager inputManager

Buffer for input events

errorReporter

protected org.j3d.util.ErrorReporter errorReporter

Reporter instance for handing out errors

navigationEnabled

protected boolean navigationEnabled

Flag to say if navigation handling should be disabled

worldScale

protected float worldScale

The world scale

invWorldScale

protected float invWorldScale

numPointingDeviceSensors

protected int numPointingDeviceSensors

The number of pointing device sensors

renderOrder

protected int[] renderOrder

The order that the layers are presented on screen visually

numRenderOrder

protected int numRenderOrder

The number of valid items in the render order list

Constructor Details

DefaultSensorManager

public DefaultSensorManager()

Create a new default instance of the manager. It will only register a handler for TimeSensors. Anything other than that will require the end user code to register an appropriate manager.

DefaultSensorManager

public DefaultSensorManager(TimeSensorManager manager)

Create a new default instance of the manager. It will only register a handler for TimeSensors. Anything other than that will require the end user code to register an appropriate manager.

Parameters:

manager -

Method Details

setErrorReporter

public 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. 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 SensorManager

Parameters:

reporter - The instance to use or null

setRenderOrder

public void setRenderOrder(int[] order,
 int numValid)

Set the rendering order for all the layers. This is so that input handling, such as drag sensors are evaluated in the correct order, from front to back.

Specified by:

setRenderOrder in interface SensorManager

Parameters:

order - The index of the list of rendered layers ids

numValid - The number of valid items in the order list

processUserInput

public void processUserInput(int layerId,
 long time)

Process the user input to the scene now. User input is the mouse and keyboard processing that would be used to send events to Key/StringSensors and perform navigation and picking duties as well as adjust items like billboards and LODs.

The base class version calls the individual layer sensor managers and the picking manager and time sensor manager to set the appropriate clock tick time. If you need to override for renderer-specific capabilities, make sure you call this too.

Specified by:

processUserInput in interface SensorManager

Parameters:

layerId - The ID of the layer that is active for navigation

time - The clock time, in Java coordinates, not VRML

addLayerSensorManager

public void addLayerSensorManager(LayerSensorManager mgr)

Add a per-layer manager to the sensor manager. Managers are added once, and calling a manager for a layer ID will replace any manager at that current ID.

Specified by:

addLayerSensorManager in interface SensorManager

Parameters:

mgr - The layer manager instance to add

removeLayerSensorManager

public void removeLayerSensorManager(LayerSensorManager mgr)

Remove this layer sensor manager from the system.

Specified by:

removeLayerSensorManager in interface SensorManager

Parameters:

mgr - The layer manager instance to remove

setInputManager

public void setInputManager(InputDeviceManager manager)

Set the user input manager to be used by this implementation. User input is generally independent of the main render loop. A value of null may be used to clear the currently set manager and make the handler not process user input.

Specified by:

setInputManager in interface SensorManager

Parameters:

manager - The input manager instance to use

setKeyDeviceSensorManager

public void setKeyDeviceSensorManager(KeyDeviceSensorManager manager)

Set the manager responsible for handling key device sensor. A value of null may be used to clear the currently set manager and make the handler not process user input.

Specified by:

setKeyDeviceSensorManager in interface SensorManager

Parameters:

manager - Reference to the manager instance to use or null

setPickingManager

public void setPickingManager(PickingManager picker)

Set the manager that is responsible for handling picking sensors.

Specified by:

setPickingManager in interface SensorManager

Parameters:

picker - Reference to the manager instance to use or null

setOriginManager

public void setOriginManager(OriginManager manager)

Description copied from interface: SensorManager

Set the manager for handling dynamic origin calculation.

Specified by:

setOriginManager in interface SensorManager

Parameters:

manager - Reference to the manager instance to use or null

removeSensors

public void removeSensors(NodeArray sensors)

Description copied from interface: SensorManager

Cleanup the given sensors and remove them from the list of processing to be done each frame. The list will be created elsewhere (typically the per-frame behaviour as a result of the event model processing) and passed to this manager. The given list will contain instances of VRMLSensorNodeType. There will be no protos as this is just the raw sensor nodes internally.

Specified by:

removeSensors in interface SensorManager

Parameters:

sensors - The list of sensors to process

addSensors

public void addSensors(NodeArray sensors)

Description copied from interface: SensorManager

Initialise new sensors that are just about to be added to the scene. These sensors should also be added to the processing list for dealing with user input. Note that the adding process should only send the initial events, but should not do any processing for environmental effects like collisions or proximity sensing. It is assumed these will be first processed in the next render pass.

Specified by:

addSensors in interface SensorManager

Parameters:

sensors - The list of sensors to process

addViewDependentNodes

public void addViewDependentNodes(NodeArray nodes)

Add view-dependent nodes that need to be updated each frame based on the user's position for rendering. These are not sensors nodes, but others like Billboard, LOD etc.

Specified by:

addViewDependentNodes in interface SensorManager

Parameters:

nodes - List of nodes that need to be processed

removeViewDependentNodes

public void removeViewDependentNodes(NodeArray nodes)

Remove these view-dependent nodes from the scene.

Specified by:

removeViewDependentNodes in interface SensorManager

Parameters:

nodes - List of nodes to be removed

loadScene

public void loadScene(BasicScene scene)

Load the contents of this scene into the sensor manager. The call does not need to be recursive as it is expected the external caller will work with this.

Specified by:

loadScene in interface SensorManager

Parameters:

scene - The scene to source data from

unloadScene

public void unloadScene(BasicScene scene)

UnLoad the contents of this scene into the sensor manager. The call does not need to be recursive as it is expected the external caller will work with this.

Specified by:

unloadScene in interface SensorManager

Parameters:

scene - The scene to source data from

clear

public void clear()

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 SensorManager

getVRMLClock

public VRMLClock getVRMLClock()

Get the VRMLClock instance in use by this sensor manager.

Specified by:

getVRMLClock in interface SensorManager

Returns:

A reference to the clock

getNavigationEnabled

public boolean getNavigationEnabled()

Get the currently set navigation state.

Returns:

true for the current state

setNavigationEnabled

public void setNavigationEnabled(boolean state)

Enable or disable navigation processing sub-section of the user input processing. By default the navigation processing is enabled.

Parameters:

state - true to enable navigation