instantreality 1.0

Component:
Geospatial
Status:
fully implemented
Structure type:
concrete
Standard:
X3D3.0

GeoProximitySensor

The ProximitySensor node generates events when the viewer enters, exits, and moves within a region in space (defined by a box).

Inheritance

Code

XML encoding
<GeoProximitySensor geoCenter='0 0 0'
geoSystem=''GD','WE''
center='0 0 0'
size='0 0 0'
triggerName='Synchronize'
description=''
enabled='TRUE'
logFeature=''
 />
Classic encoding
GeoProximitySensor {
	geoCenter 0 0 0
	geoSystem ["'GD','WE'"]
	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 center SFVec3f inputOutput 0 0 0 Translation offset from origin of local coordinate system.
SFVec3f centerOfRotation_changed SFVec3f outputOnly sends events whenever the user is contained within the proximity region and the center of rotation of the viewer for EXAMINE mode changes with respect to the ProximitySensor node's coordinate system
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.
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.
SFVec3d geoCenter SFVec3d inputOutput 0 0 0 (-inf, inf) Center of the sensor box in geographic coordinates.
SFVec3d geoCoord_changed SFVec3d outputOnly Corresponds to position_changed but is transform into the given geoSystem
SFNode geoOrigin SFNode initializeOnly NULL [GeoOrigin] A local coordinate frame for extended precision.
MFString geoSystem MFString initializeOnly 'GD','WE' Defines the geographic coordinate system that will be used for the geospatial coordinates in that node.
SFBool isActive SFBool outputOnly FALSE isActive true/false events are sent when the sensor gets active
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
SFRotation orientation_changed SFRotation outputOnly orientation of camera in the local coordinate frame of the sensor
SFVec3f position_changed SFVec3f outputOnly position of camera in the local coordinate frame of the sensor
SFVec3f size SFVec3f inputOutput 0 0 0 size of visibility box, measured from center in meters.
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 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.