instantreality 1.0

Component:
PickingSensor
Status:
interface only
Structure type:
concrete
Standard:
X3D3.2

VolumePicker

The VolumePicker picks against an arbitrary volume defined by the geometry. The volume is defined by the convex hull of the enclosing planes of the provided geometry.

Inheritance

Code

XML encoding
<VolumePicker objectType='ALL'
intersectionType='BOUNDS'
sortOrder='CLOSEST'
detectionLevel='exact'
triggerName='Collision'
description=''
enabled='TRUE'
logFeature=''
 />
Classic encoding
VolumePicker {
	objectType ["ALL"]
	intersectionType "BOUNDS"
	sortOrder "CLOSEST"
	detectionLevel "exact"
	triggerName "Collision"
	description ""
	enabled TRUE
	logFeature [""]
}

Interface

Filter: X3D only | Avalon only | All
id Name DataType PartType Default ValueType Description
MFNode pickedGeometry MFNode outputOnly The pickedGeometry field communicates the node or nodes that have been found to intersect with the picking geometry from the last time this node performed a picking operation.
MFNode pickTarget MFNode inputOutput BoundedNode The pickTarget field specifies the list of nodes against which the picking operation should be performed.
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
MFString objectType MFString inputOutput ALL The objectType field lists the types of object that are to be tested for intersections. An arbitrary label may be specified here in addition to the predefined types.
SFBool collide SFBool outputOnly If the collide state chanages this slot sends a new event. TRUE if the trees collide and FALSE if the do not collide anymore.
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
SFNode object1 SFNode outputOnly Node sends the first object on collision
SFNode object2 SFNode outputOnly Node sends the second object on collision
SFNode pickingGeometry SFNode inputOutput NULL Geometry The pickingGeometry field specifies the exact coordinates of the geometry that will be performing the intersection testing. The acceptable range of node types and how they are to be interpreted shall be defined by the individual concrete nodes.
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 detectionLevel SFString inputOutput exact box, hull, exact defines the detections level. Valid values are box, hull and axact
SFString intersectionType SFString initializeOnly BOUNDS [GEOMETRY, BOUNDS] The intersectionType field specifies the precision of the collision computation. The intersectionType constants may be extended by the individual concrete node to provide addtional options.
SFString sortOrder SFString initializeOnly CLOSEST [CLOSEST, ALL, ALL_SORTED] The values provided by pickedGeometry shall be dependent on the setting of the sortOrder field.
SFString triggerName SFString initializeOnly Collision 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 collideTime SFTime outputOnly Everytime the sensor detects a collision the eventout sends the current timeStamp
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 normal1 SFVec3f outputOnly sends the global collide normal for the first object
SFVec3f normal2 SFVec3f outputOnly sends the global collide normal for the second object
SFVec3f point SFVec3f outputOnly This slot sends the global collide point
SFVec3f point1 SFVec3f outputOnly This slot sends the local collide point for the first object
SFVec3f point2 SFVec3f outputOnly This slot sends the local collide point for the second object