com.openinventor.inventor.vrmlnodes

Class SoVRMLProximitySensor

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.misc.SoBase

com.openinventor.inventor.fields.SoFieldContainer

com.openinventor.inventor.nodes.SoNode

com.openinventor.inventor.vrmlnodes.SoVRMLNode

com.openinventor.inventor.vrmlnodes.SoVRMLProximitySensor

All Implemented Interfaces:

SafeDisposable

Deprecated.

As of Open Inventor 9500 See documentation for more details

public class SoVRMLProximitySensor
extends SoVRMLNode

Generates events when the user moves into, out of, or within a specified region of space. The SoVRMLProximitySensor generates events when the user enters, exits, and moves within a region in space (defined by a box).

<font color="#0000FF">NOTE:</font> This class does not exist in Open Inventor 10.0 and later.

VRML97 SPECIFICATION

This section describes the expected behavior of the node in a conforming VRML97 browser application. In some cases, the application is responsible for implementing portions of the expected behavior. Open Inventor viewer classes and IVF classes implement some of the application behaviors.

This section may reference portions of the VRML97 specification that are not present in this help file. The complete VRML97 spec is available at http://www.web3d.org.

The SoVRMLProximitySensor generates events when the user enters, exits, and moves within a region in space (defined by a box). A proximity sensor can be enabled or disabled by sending it an enabled event with a value of true or false

• a disabled sensor does not send output events.

An SoVRMLProximitySensor generates isActive true/false events as the viewer enters and exits the rectangular box defined by its center and size fields. Browsers must interpolate user positions and timestamp the isActive events with the exact time the user first intersected the proximity region. The center field defines the center point of the proximity region in object space, and the size field specifies a vector which defines the width (x), height (y), and depth (z) of the box bounding the region. SoVRMLProximitySensor nodes are affected by the hierarchical transformations of its parents.

The enterTime event is generated whenever the isActive true event is generated (user enters the box), and exitTime events are generated whenever isActive false event is generated (user exits the box).

The position_changed and orientation_changed events send events whenever the position and orientation of the viewer changes with respect to the SoVRMLProximitySensor's coordinate system - this includes enter and exit times. Note that the user movement may be as a result of a variety of circumstances (e.g. browser navigation, proximity sensor's coordinate system changes, bound Viewpoint's position or orientation changes, or the SoVRMLProximitySensor's coordinate system changes).

Each SoVRMLProximitySensor behaves independently of all other SoVRMLProximitySensors - every enabled SoVRMLProximitySensor that is affected by the user's movement receives and sends events, possibly resulting in multiple SoVRMLProximitySensors receiving and sending events simultaneously. Unlike SoVRMLTouchSensors, there is no notion of an SoVRMLProximitySensor lower in the scene graph "grabbing" events.

Instanced (DEF/USE) SoVRMLProximitySensors use the union of all the boxes to check for enter and exit - an instanced SoVRMLProximitySensor will detect enter and exit for all instances of the box and send output events appropriately.

An SoVRMLProximitySensor that surrounds the entire world will have an enterTime equal to the time that the world was entered and can be used to start up animations or behaviors as soon as a world is loaded. A SoVRMLProximitySensor with a (0 0 0) size field cannot generate events - this is equivalent to setting the enabled field to false.

File format/default:

VRMLProximitySensor {

center	0 0 0
enabled	true
size	0 0 0
metadata	NULL

}

EVENTS

eventIn

SoSFVec3f	set_center
SoSFBool	set_enabled
SoSFVec3f	set_size
SoSFNode	set_metadata

eventOut

SoSFBool	isActive
SoSFVec3f	position_changed
SoSFRotation	orientation_changed
SoSFVec3f	centerOfRotation_changed (Note: Not implemented)
SoSFTime	enterTime
SoSFTime	exitTime
SoSFVec3f	center_changed
SoSFBool	enabled_changed
SoSFVec3f	size_changed
SoSFNode	metadata_changed

Deprecated since Open Inventor 9500
The VRML API is no longer supported. See section http://oivdoc95.vsg3d.com/content/compatibility-notes-4#Deprecation of the Reference Manual.

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
SoSFVec3f	center Deprecated.
SoSFVec3f	centerOfRotation_changed Deprecated. Output event sent when centerOfRotation changes.
SoSFBool	enabled Deprecated. Enable (true) or disable (false) the sensor.
SoSFTime	enterTime Deprecated. Output event sent when viewer enters.
SoSFTime	exitTime Deprecated. Output event sent when viewer leaves.
SoSFBool	isActive Deprecated. Output event sent when viewer enters/leaves.
SoSFRotation	orientation_changed Deprecated. Output event sent when viewer turns.
SoSFVec3f	position_changed Deprecated. Output event sent when viewer moves.
SoSFVec3f	size Deprecated. Define the rectangular box within which isActive event is generated.

Fields inherited from class com.openinventor.inventor.vrmlnodes.SoVRMLNode

metadata

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoVRMLProximitySensor() Deprecated. Constructor.

Method Summary

Modifier and Type	Method and Description
static void	enableEvents(boolean OnOffFlag) Deprecated. Enables/disables events for all SoVRMLProximitySensor objects.
static boolean	isEventsEnabled() Deprecated. Queries if events are enabled for all objects of this class.

Methods inherited from class com.openinventor.inventor.nodes.SoNode

affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderUnitID, GLRender, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, handleEvent, isBoundingBoxIgnoring, isOverride, pick, rayPick, search, setOverride, touch, write

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer

copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaults

Methods inherited from class com.openinventor.inventor.misc.SoBase

dispose, getEXTERNPROTO, getName, getPROTO, isDisposable, isSynchronizable, setName, setSynchronizable

Methods inherited from class com.openinventor.inventor.Inventor

getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

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

Field Detail

center

public final SoSFVec3f center

Deprecated.

size

public final SoSFVec3f size

Deprecated.

Define the rectangular box within which isActive event is generated.

enabled

public final SoSFBool enabled

Deprecated.

Enable (true) or disable (false) the sensor.

isActive

public final SoSFBool isActive

Deprecated.

Output event sent when viewer enters/leaves.

position_changed

public final SoSFVec3f position_changed

Deprecated.

Output event sent when viewer moves.

orientation_changed

public final SoSFRotation orientation_changed

Deprecated.

Output event sent when viewer turns.

centerOfRotation_changed

public final SoSFVec3f centerOfRotation_changed

Deprecated.

Output event sent when centerOfRotation changes.

enterTime

public final SoSFTime enterTime

Deprecated.

Output event sent when viewer enters.

exitTime

public final SoSFTime exitTime

Deprecated.

Output event sent when viewer leaves.

Constructor Detail

SoVRMLProximitySensor

public SoVRMLProximitySensor()

Deprecated.

Constructor.

Method Detail

isEventsEnabled

public static boolean isEventsEnabled()

Deprecated.

Queries if events are enabled for all objects of this class.

enableEvents

public static void enableEvents(boolean OnOffFlag)

Deprecated.

Enables/disables events for all SoVRMLProximitySensor objects. If you have created several objects of this class, you can disable/enable events for all of them with a single call to this method.