instantreality 1.0

Component:
EnvironmentalSensor
Status:
fully implemented
Structure type:
abstract
Standard:
X3D3.0

EnvironmentSensor

Environment sensors are nodes which emit events based on some event which occurs within the environment, usually an interaction between two elements within the world. Most environment sensors events occur because of an interaction between the viewer and the world. However, an environment sensor event may also occur because of an interaction between a non-manipulatable piece of hardware (e.g., a clock) and the world, or an event over the network.

Inheritance

Code

XML encoding
<EnvironmentSensor center='0 0 0'
size='0 0 0'
triggerName='Synchronize'
description=''
enabled='TRUE'
logFeature=''
 />
Classic encoding
EnvironmentSensor {
	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
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
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
SFNode metadata SFNode inputOutput MetadataObject container for payload metadata inside MetadataSet element
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
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.
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.
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.
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.