instantreality 1.0

Component:
EnvironmentalSensor
Status:
fully implemented
Structure type:
concrete
Standard:
X3D2.0

ProximitySensor

ProximitySensor generates events when the viewer enters, exits and moves within a region of space (defined by a box). Hint: multiple USEd instances are cumulative, but avoid overlaps. Hint: can first use Transform to relocate/reorient box. Hint: surround entire world to start behaviors once scene is loaded.

Inheritance

Code

XML encoding
<ProximitySensor center='0 0 0'
size='0 0 0'
triggerName='Synchronize'
description=''
enabled='TRUE'
logFeature=''
 />
Classic encoding
ProximitySensor {
	center 0 0 0
	size 0 0 0
	triggerName "Synchronize"
	description ""
	enabled TRUE
	logFeature [""]
}

Interface

Filter: X3D only | Avalon only | All
id Name DataType PartType Default ValueType Description
SFVec3f position_changed SFVec3f outputOnly Sends translation event relative to center.
SFRotation orientation_changed SFRotation outputOnly Sends rotation event relative to center.
SFVec3f centerOfRotation_changed SFVec3f outputOnly Sends changed centerOfRotation values, likely caused by user interaction.
SFVec3f center SFVec3f inputOutput 0 0 0 Translation offset from origin of local coordinate system.
SFVec3f size SFVec3f inputOutput 0 0 0 size of visibility box, measured from center in meters.
SFTime enterTime SFTime outputOnly Time event generated when user's camera enters visibility region for sensor.
SFTime exitTime SFTime outputOnly Time event generated when user's camera exits visibility region for sensor.
SFString triggerName SFString initializeOnly Synchronize name of the dynamic context-slot which is used by the run-time environment (e.g. Jobs) to trigger the node. Life-Nodes will automatically connect the context-eventOutut to the triggerSlot-eventInput Slot.
SFString description SFString inputOutput Text description to comment the sensor task. Can be used in run-time systems to give usefull feedback to the user and developer
SFBool enabled SFBool inputOutput TRUE Enables/disables the sensor node.
SFBool isActive SFBool outputOnly FALSE isActive true/false events are sent when the sensor gets active
SFTime triggerSlot SFTime inputOnly slot which is used internally to connect a dynamic context-slot which name is set by the triggerName value. Its used automatically to install run-time environment trigger.
MFString logFeature MFString inputOutput state, child, parent, route, eventIn, eventOut controls the logging of changes, state: log state changes (e.g. live), child: log child add/remove, parent: log parent add/remove, route: log route add/remove; eventIn: log receiving of events, eventOut: log sending of events: guiView, runtime system should create node-view, guiEdit: runtime system should create node-editeverything: log everything
SFNode metadata SFNode inputOutput MetadataObject container for payload metadata inside MetadataSet element