NAME
SoVRMLProximitySensor -
The SoVRMLProximitySensor class is used to generate events when the
viewer enters or exits a region.
The detailed class documentation is taken verbatim from the VRML97
standard (ISO/IEC 14772-1:1997). It is copyright The Web3D Consortium,
and is used by permission of the Consortium:
SYNOPSIS
#include <Inventor/VRMLnodes/SoVRMLProximitySensor.h>
Inherits SoNode.
Public Member Functions
SoVRMLProximitySensor (void)
virtual SbBool affectsState (void) const
virtual void doAction (SoAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void callback (SoCallbackAction *action)
virtual void rayPick (SoRayPickAction *action)
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
Static Public Member Functions
static void initClass (void)
Public Attributes
SoSFVec3f center
SoSFVec3f size
SoSFBool enabled
SoSFBool isActive
SoSFVec3f position_changed
SoSFRotation orientation_changed
SoSFTime enterTime
SoSFTime exitTime
Protected Member Functions
virtual ~SoVRMLProximitySensor ()
virtual void notify (SoNotList *list)
Detailed Description
The SoVRMLProximitySensor class is used to generate events when the
viewer enters or exits a region.
The detailed class documentation is taken verbatim from the VRML97
standard (ISO/IEC 14772-1:1997). It is copyright The Web3D Consortium,
and is used by permission of the Consortium:
ProximitySensor {
exposedField SFVec3f center 0 0 0 # (-,)
exposedField SFVec3f size 0 0 0 # [0,)
exposedField SFBool enabled TRUE
eventOut SFBool isActive
eventOut SFVec3f position_changed
eventOut SFRotation orientation_changed
eventOut SFTime enterTime
eventOut SFTime exitTime
}
.fi
The ProximitySensor node generates events when the viewer enters, exits, and moves within a region in space (defined by a box).
A proximity sensor is enabled or disabled by sending it an enabled event with a value of TRUE or FALSE. A disabled sensor does not send events.
A ProximitySensor node generates isActive TRUE/FALSE events as the viewer enters and exits the rectangular box defined by its center and size fields. Browsers shall interpolate viewer positions and timestamp the isActive events with the exact time the viewer first intersected the proximity region.
The center field defines the centre point of the proximity region in object space. The size field specifies a vector which defines the width (x), height (y), and depth (z) of the box bounding the region. The components of the size field shall be greater than or equal to zero. ProximitySensor nodes are affected by the hierarchical transformations of their parents.
The enterTime event is generated whenever the isActive TRUE event is generated (user enters the box), and exitTime events are generated whenever an isActive FALSE event is generated (user exits the box).
The position_changed and orientation_changed eventOuts send events whenever the user is contained within the proximity region and the position and orientation of the viewer changes with respect to the ProximitySensor node’s coordinate system including enter and exit times.
The viewer movement may be a result of a variety of circumstances resulting from browser navigation, ProximitySensor node’s coordinate system changes, or bound Viewpoint node’s position or orientation changes.
Each ProximitySensor node behaves independently of all other ProximitySensor nodes. Every enabled ProximitySensor node that is affected by the viewer’s movement receives and sends events, possibly resulting in multiple
ProximitySensor nodes receiving and sending events simultaneously. Unlike TouchSensor nodes, there is no notion of a ProximitySensor node lower in the scene graph ’grabbing’ events.
Instanced (DEF/USE) ProximitySensor nodes use the union of all the boxes to check for enter and exit. A multiply instanced ProximitySensor node will detect enter and exit for all instances of the box and send enter/exit events appropriately. However, the results are undefined if the any of the boxes of a multiply instanced ProximitySensor node overlap.
A ProximitySensor node that surrounds the entire world has an enterTime equal to the time that the world was entered and can be used to start up animations or behaviours as soon as a world is loaded.
A ProximitySensor node with a box containing zero volume (i.e., any size field element of 0.0) cannot generate events. This is equivalent to setting the enabled field to FALSE.
A ProximitySensor read from a VRML file shall generate isActive TRUE, position_changed, orientation_changed and enterTime events if the sensor is enabled and the viewer is inside the proximity region.
A ProximitySensor inserted into the transformation hierarchy shall generate isActive TRUE, position_changed, orientation_changed and enterTime events if the sensor is enabled and the viewer is inside the proximity region.
A ProximitySensor removed from the transformation hierarchy shall generate isActive FALSE, position_changed, orientation_changed and exitTime events if the sensor is enabled and the viewer is inside the proximity region.
Constructor & Destructor Documentation
SoVRMLProximitySensor::SoVRMLProximitySensor (void) Constructor.
SoVRMLProximitySensor::~SoVRMLProximitySensor () [protected, virtual]
Destructor.
Member Function Documentation
void SoVRMLProximitySensor::initClass (void) [static] Sets up
initialization for data common to all instances of this class, like
submitting necessary information to the Coin type system.
Reimplemented from SoNode.
SbBool SoVRMLProximitySensor::affectsState (void) const [virtual] Returns
TRUE if the node could have any effect on the state during traversal.
If it returns FALSE, no data in the traversal-state will change from
the pre-traversal state to the post-traversal state. The SoSeparator
node will for instance return FALSE, as it pushes and pops the state
before and after traversal of its children. All SoShape nodes will also
return FALSE, as just pushing out geometry data to the rendering engine
won’t affect the actual rendering state.
The default method returns TRUE, on a ’better safe than sorry’
philosophy.
Reimplemented from SoNode.
void SoVRMLProximitySensor::doAction (SoAction * action) [virtual] This
function performs the typical operation of a node for any action.
Reimplemented from SoNode.
void SoVRMLProximitySensor::GLRender (SoGLRenderAction * action) [virtual]
Action method for the SoGLRenderAction.
This is called during rendering traversals. Nodes influencing the
rendering state in any way or who wants to throw geometry primitives at
OpenGL overrides this method.
Reimplemented from SoNode.
void SoVRMLProximitySensor::callback (SoCallbackAction * action) [virtual]
Action method for SoCallbackAction.
Simply updates the state according to how the node behaves for the
render action, so the application programmer can use the
SoCallbackAction for extracting information about the scene graph.
Reimplemented from SoNode.
void SoVRMLProximitySensor::rayPick (SoRayPickAction * action) [virtual]
Action method for SoRayPickAction.
Checks the ray specification of the action and tests for intersection
with the data of the node.
Nodes influencing relevant state variables for how picking is done also
overrides this method.
Reimplemented from SoNode.
void SoVRMLProximitySensor::getBoundingBox (SoGetBoundingBoxAction *
action) [virtual] Action method for the SoGetBoundingBoxAction.
Calculates bounding box and center coordinates for node and modifies
the values of the action to encompass the bounding box for this node
and to shift the center point for the scene more towards the one for
this node.
Nodes influencing how geometry nodes calculates their bounding box also
overrides this method to change the relevant state variables.
Reimplemented from SoNode.
void SoVRMLProximitySensor::notify (SoNotList * l) [protected, virtual]
Notifies all auditors for this instance when changes are made.
Reimplemented from SoNode.
Member Data Documentation
SoSFVec3f SoVRMLProximitySensor::center The center of the region. Default
value is (0,0,0).
SoSFVec3f SoVRMLProximitySensor::size The region size. Default value is (0,
0, 0).
SoSFBool SoVRMLProximitySensor::enabled Enable/disable sensor. Default
value is TRUE.
SoSFBool SoVRMLProximitySensor::isActive An eventOut that is sent every
time the sensor changes state.
SoSFVec3f SoVRMLProximitySensor::position_changed An eventOut that is sent
when the viewer is inside the region and the viewer position or
orientation is changed.
SoSFRotation SoVRMLProximitySensor::orientation_changed An eventOut that is
sent when the viewer is inside the region and the viewer position or
orientation is changed.
SoSFTime SoVRMLProximitySensor::enterTime An eventOut that is sent when the
viewer enters the region.
SoSFTime SoVRMLProximitySensor::exitTime An eventOut that is sent when the
viewer exits the region.
Author
Generated automatically by Doxygen for Coin from the source code.