SFImageSensor
Sensor used to send SFImage values to or to receive SFImage values from external components.
Inheritance
Code
XML encoding
<SFImageSensor value='0 0 0' label='' triggerName='Interaction' bufferSize='1' out='FALSE' description='' enabled='TRUE' logFeature='' />
Classic encoding
SFImageSensor { value 0 0 0 label "" triggerName "Interaction" bufferSize 1 out FALSE description "" enabled TRUE logFeature [""] }
Interface
Filter: X3D only | Avalon only | All
id | Name | DataType | PartType | Default | ValueType | Description |
---|---|---|---|---|---|---|
value | SFImage | inputOutput | 0 0 0 | Exposed field used to send SFImage values to or to receive SFImage values from external components. | ||
label | SFString | initializeOnly | A label that is used to map this sensor to an external data source or sink. Use a label that describes what the data is used for, e.g. "gas" or "wheel" when the sensor is used to control the speed or the driving direction of a car. | |||
triggerName | SFString | initializeOnly | Interaction | 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. | ||
bufferSize | SFInt32 | initializeOnly | 1 | Determines the number of values that are buffered by this sensor. When the sensor receives more data values between two frames than there is free space in the buffer, the oldest data values get lost. By default, the buffer size is 1, which means that data values are not buffered. This is ok for tracker data where you are only interested in the most recent position value, but it is not ok for button press events, because you might loose button press events. | ||
out | SFBool | initializeOnly | FALSE | Determines if the the sensor is used to receive data values from external components (out = FALSE) or to send data values to external components (out = TRUE). | ||
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 |