Xj3D 2.0 VRML/X3D Code API

org.web3d.vrml.renderer.ogl.nodes
Interface OGLAreaListener

All Superinterfaces:
AreaListener

public interface OGLAreaListener
extends AreaListener

The listener interface for receiving notice of the viewpoint on entry or exit from an area.

Each method receives both the user's current position and orientation in V-world coordinates but also the transform of the object that was picked and representing this interface. The idea of this is to save internal calls to getLocalToVWorld() and the extra capability bits required for this. The transform is available from the initial pick SceneGraphPath anyway, so this comes for free and leads to better performance. In addition, it saves needing to pass in a scene graph path for dealing with the getLocalToVWorld() case when we are under a SharedGroup.

Version:
$Revision: 1.3 $
Author:
Alan Hudson, Justin Couch

Method Summary
 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.
 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.
 

Method Detail

areaEntry

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.

Parameters:
position - The new position of the user
orientation - The orientation of the user there
localPosition - The vworld transform object for the class that implemented this listener

userPositionChanged

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.

Parameters:
position - The new position of the user
orientation - The orientation of the user there
localPosition - The vworld transform object for the class that implemented this listener

areaExit

void areaExit()
Invoked when the tracked object exits on area.


Xj3D 2.0 VRML/X3D Code API

Copyright © 2001 - 2006 Web3D Consortium