org.jdesktop.j3d.examples.virtual_input_device

Class VirtualInputDevice

java.lang.Object

org.jdesktop.j3d.examples.virtual_input_device.VirtualInputDevice

All Implemented Interfaces:

InputDevice

public class VirtualInputDevice
extends java.lang.Object
implements InputDevice

Field Summary

Fields inherited from interface org.jogamp.java3d.InputDevice

BLOCKING, DEMAND_DRIVEN, NON_BLOCKING

Constructor Summary

Constructors

Constructor and Description
VirtualInputDevice(java.lang.String[] args)

Method Summary

Modifier and Type	Method and Description
void	close() Code to process the clean up of the device and relinquish associated resources.
int	getProcessingMode() This method retrieves the device's processing mode: one of BLOCKING, NON_BLOCKING, or DEMAND_DRIVEN.
Sensor	getSensor(int sensorIndex) Gets the specified Sensor associated with the device.
int	getSensorCount() This method gets the number of sensors associated with the device.
boolean	initialize() This method initializes the device.
void	pollAndProcessInput() This method causes the device's sensor readings to be updated by the device driver.
void	processStreamInput() This method will not be called by the Java 3D implementation and should be implemented as an empty method.
void	setNominalPositionAndOrientation() This method sets the device's current position and orientation as the devices nominal position and orientation (establish its reference frame relative to the "Tracker base" reference frame).
void	setProcessingMode(int mode) This method sets the device's processing mode to one of: BLOCKING, NON_BLOCKING, or DEMAND_DRIVEN.

Methods inherited from class java.lang.Object

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

Constructor Detail

VirtualInputDevice

public VirtualInputDevice(java.lang.String[] args)

Method Detail

close

public void close()

Description copied from interface: InputDevice

Code to process the clean up of the device and relinquish associated resources. This method should be called after the device has been unregistered from Java 3D via the PhysicalEnvironment.removeInputDevice(InputDevice) method call.

Specified by:

close in interface InputDevice

getProcessingMode

public int getProcessingMode()

Description copied from interface: InputDevice

This method retrieves the device's processing mode: one of BLOCKING, NON_BLOCKING, or DEMAND_DRIVEN. The Java 3D implementation calls this method when PhysicalEnvironment.addInputDevice(InputDevice) is called to register the device with Java 3D. If this method returns any value other than BLOCKING, NON_BLOCKING, or DEMAND_DRIVEN, addInputDevice will throw an IllegalArgumentException.

Specified by:

getProcessingMode in interface InputDevice

Returns:

Returns the devices processing mode, one of BLOCKING, NON_BLOCKING, or DEMAND_DRIVEN

getSensorCount

public int getSensorCount()

Description copied from interface: InputDevice

This method gets the number of sensors associated with the device.

Specified by:

getSensorCount in interface InputDevice

Returns:

the device's sensor count.

getSensor

public Sensor getSensor(int sensorIndex)

Description copied from interface: InputDevice

Gets the specified Sensor associated with the device. Each InputDevice implementation is responsible for creating and managing its own set of sensors. The sensor indices begin at zero and end at number of sensors minus one. Each sensor should have had Sensor.setDevice(InputDevice) set properly before addInputDevice is called.

Specified by:

getSensor in interface InputDevice

Parameters:

sensorIndex - the sensor to retrieve

Returns:

Returns the specified sensor.

initialize

public boolean initialize()

Description copied from interface: InputDevice

This method initializes the device. A device should be initialized before it is registered with Java 3D via the PhysicalEnvironment.addInputDevice(InputDevice) method call.

Specified by:

initialize in interface InputDevice

Returns:

return true for succesful initialization, false for failure

pollAndProcessInput

public void pollAndProcessInput()

Description copied from interface: InputDevice

This method causes the device's sensor readings to be updated by the device driver. For BLOCKING and NON_BLOCKING drivers, this method is called regularly and the Java 3D implementation can cache the sensor values. For DEMAND_DRIVEN drivers this method is called each time one of the Sensor.getRead methods is called, and is not otherwise called.

Specified by:

pollAndProcessInput in interface InputDevice

processStreamInput

public void processStreamInput()

Description copied from interface: InputDevice

This method will not be called by the Java 3D implementation and should be implemented as an empty method.

Specified by:

processStreamInput in interface InputDevice

setNominalPositionAndOrientation

public void setNominalPositionAndOrientation()

Description copied from interface: InputDevice

This method sets the device's current position and orientation as the devices nominal position and orientation (establish its reference frame relative to the "Tracker base" reference frame).

Specified by:

setNominalPositionAndOrientation in interface InputDevice

setProcessingMode

public void setProcessingMode(int mode)

Description copied from interface: InputDevice

This method sets the device's processing mode to one of: BLOCKING, NON_BLOCKING, or DEMAND_DRIVEN. Many drivers will be written to run in only one mode. Applications using such drivers should not attempt to set the processing mode. This method should throw an IllegalArgumentException if there is an attempt to set the processing mode to anything other than the aforementioned three values.

NOTE: this method should not be called after the input device has been added to a PhysicalEnvironment. The processingMode must remain constant while a device is attached to a PhysicalEnvironment.

Specified by:

setProcessingMode in interface InputDevice

Parameters:

mode - One of BLOCKING, NON_BLOCKING, or DEMAND_DRIVEN