SnapLocator
SnapLocator is the base class for SnapIn and SnapSensor. It defines the location and visualization of those sensors.
Inheritance
Code
XML encoding
<SnapLocator locationOffset='identity' locationTranslation='0 0 0' locationRotation='0 0 0 1' visibleSize='1.0' description='' enabled='TRUE' logFeature='' />
Classic encoding
SnapLocator { locationOffset identity locationTranslation 0 0 0 locationRotation 0 0 0 1 visibleSize 1.0 description "" enabled TRUE logFeature [""] }
Interface
Filter: X3D only | Avalon only | All
id | Name | DataType | PartType | Default | ValueType | Description |
---|---|---|---|---|---|---|
locationOffset | SFMatrix4f | initializeOnly | identity | offset of the SnapSomething relative to its parent node | ||
locationTranslation | SFVec3f | initializeOnly | 0 0 0 | translation of the SnapSomething relative to its parent node | ||
locationRotation | SFRotation | initializeOnly | 0 0 0 1 | rotation of the SnapSomething relative to its parent node | ||
visibleSize | SFFloat | initializeOnly | 1.0 | (-inf, inf) | the scalation for the indicator nodes | |
indicatorNode | SFNode | initializeOnly | Node | If two SnapSomethings are matched as compatible the indicatorNode is shown. Default is a green sphere. | ||
highlightNode | SFNode | initializeOnly | Node | If two SnapSomethings are matched as compatible AND are close enough to "snap", the highlightNode is shown. Default is a red sphere. | ||
standbyNode | SFNode | initializeOnly | Node | the standbyNode is selected when neither of indicator/highlight is shown. It defaults to nothing, so that it is invisible. | ||
highlightActivated | SFBool | outputOnly | Indicates if highlight is activated or not. | |||
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 | |||
enabled | SFBool | inputOutput | TRUE | Enables/disables the sensor node. | ||
isActive | SFBool | outputOnly | FALSE | isActive true/false events are sent when the sensor gets active | ||
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. | |||
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 | ||
metadata | SFNode | inputOutput | MetadataObject | container for payload metadata inside MetadataSet element |