Package org.web3d.vrml.renderer.ogl.nodes.environment

Class OGLProximitySensor

java.lang.Object

org.web3d.vrml.renderer.common.nodes.AbstractNode

org.web3d.vrml.renderer.common.nodes.BaseSensorNode

org.web3d.vrml.renderer.common.nodes.environment.BaseProximitySensor

org.web3d.vrml.renderer.ogl.nodes.environment.OGLProximitySensor

All Implemented Interfaces:

org.j3d.aviatrix3d.NodeUpdateListener, VRMLNode, FrameStateListener, VRMLChildNodeType, VRMLEnvironmentalSensorNodeType, VRMLNodeType, VRMLSensorNodeType, VRMLTimeDependentNodeType, VRMLWorldRootChildNodeType, AreaListener, OGLAreaListener, OGLVRMLNode

public class OGLProximitySensor
extends BaseProximitySensor
implements OGLVRMLNode, OGLAreaListener, org.j3d.aviatrix3d.NodeUpdateListener

OpenGL implementation of a ProximitySensor node.

Version:

$Revision: 1.7 $

Author:

Justin Couch

Field Summary

Fields inherited from class org.web3d.vrml.renderer.common.nodes.environment.BaseProximitySensor

FIELD_CENTER, FIELD_CENTEROFROTATION_CHANGED, FIELD_ENABLED, FIELD_ENTER_TIME, FIELD_EXIT_TIME, FIELD_IS_ACTIVE, FIELD_ORIENTATION_CHANGED, FIELD_POSITION_CHANGED, FIELD_SIZE, LAST_PROXIMITYSENSOR_INDEX, vfCenter, vfCenterOfRotationChanged, vfEnterTime, vfExitTime, vfOrientationChanged, vfPositionChanged, vfSize, vrmlClock

Fields inherited from class org.web3d.vrml.renderer.common.nodes.BaseSensorNode

LAST_SENSOR_INDEX, vfEnabled, vfIsActive

Fields inherited from class org.web3d.vrml.renderer.common.nodes.AbstractNode

errorReporter, FIELD_METADATA, fieldLocalData, hasChanged, inSetup, isDEF, isStatic, LAST_NODE_INDEX, layerIds, nodeName, pMetadata, refCounts, removedLayerIds, stateManager, STATIC_SCENE_GRAPH, vfMetadata, vrmlMajorVersion, vrmlMinorVersion

Constructor Summary

Constructors

Constructor	Description
OGLProximitySensor()	Construct a new proximity sensor object
OGLProximitySensor(VRMLNodeType node)	Construct a new instance of this node based on the details from the given node.

Method Summary

Modifier and Type	Method	Description
void	allEventsComplete()	Notification that the rendering of the event model is complete and that rendering is about to begin.
void	areaEntry(javax.vecmath.Point3f position, javax.vecmath.Vector3f orientation, javax.vecmath.Matrix4f vpMatrix, javax.vecmath.Matrix4f localPosition)	Invoked when the user enters an area.
void	areaExit()	Invoked when the tracked object exits on area.
org.j3d.aviatrix3d.SceneGraphObject	getSceneGraphObject()	Get the OpenGL scene graph object representation of this node.
protected void	setCenter(float[] val)	Update the center of the sensor.
void	setEnabled(boolean state)	Set the sensor enabled or disabled.
protected void	setSize(float[] val)	Update the size of the sensor.
void	setupFinished()	Notification that the construction phase of this node has finished.
void	setVRMLClock(VRMLClock clk)	Set the vrmlClock that this time dependent node will be running with.
void	updateNodeBoundsChanges(Object src)	Notification that its safe to update the node now with any operations that could potentially effect the node's bounds.
void	updateNodeDataChanges(Object src)	Notification that its safe to update the node now with any operations that only change the node's properties, but do not change the bounds.
void	userPositionChanged(javax.vecmath.Point3f position, javax.vecmath.Vector3f orientation, javax.vecmath.Matrix4f vpMatrix, javax.vecmath.Matrix4f localPosition)	Notification that the user is still in the area, but that the viewer reference point has changed.

Methods inherited from class org.web3d.vrml.renderer.common.nodes.environment.BaseProximitySensor

getFieldDeclaration, getFieldIndex, getFieldValue, getNodeFieldIndices, getNumFields, getPrimaryType, getSecondaryType, sendRoute, setValue, setValue

Methods inherited from class org.web3d.vrml.renderer.common.nodes.BaseSensorNode

copy, getEnabled, getIsActive

Methods inherited from class org.web3d.vrml.renderer.common.nodes.AbstractNode

addNodeListener, checkNodeType, checkSecondaryType, checkSecondaryType, clearRemovedLayerIds, fireFieldChanged, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, getUserData, getVRMLNodeName, hasFieldChanged, isDEF, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, setDEF, setErrorReporter, setFrameStateManager, setMetadataObject, setUserData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setVersion, throwInitOnlyWriteException, throwInputOnlyWriteException, throwInvalidNodeException, throwInvalidProtoException, throwOutputOnlyWriteException, updateRefCount, updateRefs

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.web3d.vrml.lang.VRMLNode

getFieldDeclaration, getFieldIndex, getNodeFieldIndices, getNumFields, getPrimaryType, getSecondaryType, getUserData, getVRMLNodeName, isDEF, setErrorReporter, setUserData, setVersion

Methods inherited from interface org.web3d.vrml.nodes.VRMLNodeType

addNodeListener, clearRemovedLayerIds, getFieldValue, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, hasFieldChanged, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, sendRoute, setDEF, setFrameStateManager, setMetadataObject, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, updateRefCount

Methods inherited from interface org.web3d.vrml.nodes.VRMLSensorNodeType

getEnabled, getIsActive

Constructor Details

OGLProximitySensor

public OGLProximitySensor()

Construct a new proximity sensor object

OGLProximitySensor

public OGLProximitySensor(VRMLNodeType node)

Construct a new instance of this node based on the details from the given node. If the node is not the right type, an exception will be thrown.

Parameters:

node - The node to copy

Throws:

IllegalArgumentException - The node is not the right type

Method Details

setEnabled

public void setEnabled(boolean state)

Set the sensor enabled or disabled.

Specified by:

setEnabled in interface VRMLSensorNodeType

Overrides:

setEnabled in class BaseSensorNode

Parameters:

state - true if the sensor is to be enabled

getSceneGraphObject

public org.j3d.aviatrix3d.SceneGraphObject getSceneGraphObject()

Get the OpenGL scene graph object representation of this node. This will need to be cast to the appropriate parent type when being used.

Specified by:

getSceneGraphObject in interface OGLVRMLNode

Returns:

The OGL representation.

setupFinished

public void setupFinished()

Notification that the construction phase of this node has finished. If the node would like to do any internal processing, such as setting up geometry, then go for it now.

Specified by:

setupFinished in interface VRMLNodeType

Overrides:

setupFinished in class AbstractNode

areaEntry

public void areaEntry(javax.vecmath.Point3f position,
 javax.vecmath.Vector3f orientation,
 javax.vecmath.Matrix4f vpMatrix,
 javax.vecmath.Matrix4f localPosition)

Invoked when the user enters an area.

Specified by:

areaEntry in interface OGLAreaListener

Parameters:

position - The new position of the user

orientation - The orientation of the user there

vpMatrix -

localPosition - The vworld transform object for the class that implemented this listener

userPositionChanged

public void userPositionChanged(javax.vecmath.Point3f position,
 javax.vecmath.Vector3f orientation,
 javax.vecmath.Matrix4f vpMatrix,
 javax.vecmath.Matrix4f localPosition)

Notification that the user is still in the area, but that the viewer reference point has changed.

Specified by:

userPositionChanged in interface OGLAreaListener

Parameters:

position - The new position of the user

orientation - The orientation of the user there

vpMatrix -

localPosition - The vworld transform object for the class that implemented this listener

areaExit

public void areaExit()

Invoked when the tracked object exits on area.

Specified by:

areaExit in interface OGLAreaListener

setVRMLClock

public void setVRMLClock(VRMLClock clk)

Set the vrmlClock that this time dependent node will be running with.

Specified by:

setVRMLClock in interface VRMLTimeDependentNodeType

Overrides:

setVRMLClock in class BaseProximitySensor

Parameters:

clk - The vrmlClock to use for this node

setSize

protected void setSize(float[] val)

Update the size of the sensor. May be overridden by derived classes but should make sure to call this as well

Overrides:

setSize in class BaseProximitySensor

Parameters:

val - The new size to use

setCenter

protected void setCenter(float[] val)

Update the center of the sensor. May be overridden by derived classes but should make sure to call this as well

Overrides:

setCenter in class BaseProximitySensor

Parameters:

val - The new center to use

allEventsComplete

public void allEventsComplete()

Notification that the rendering of the event model is complete and that rendering is about to begin. Used to update the transformation matrix only once per frame.

Specified by:

allEventsComplete in interface FrameStateListener

Overrides:

allEventsComplete in class AbstractNode

updateNodeBoundsChanges

public void updateNodeBoundsChanges(Object src)

Notification that its safe to update the node now with any operations that could potentially effect the node's bounds.

Specified by:

updateNodeBoundsChanges in interface org.j3d.aviatrix3d.NodeUpdateListener

Parameters:

src - The node or Node Component that is to be updated.

updateNodeDataChanges

public void updateNodeDataChanges(Object src)

Notification that its safe to update the node now with any operations that only change the node's properties, but do not change the bounds.

Specified by:

updateNodeDataChanges in interface org.j3d.aviatrix3d.NodeUpdateListener

Parameters:

src - The node or Node Component that is to be updated.