ScalarDamper
The ScalarDamper calculates damper-animation for SFFloat values
Inheritance
Code
XML encoding
<ScalarDamper logFeature='' enabled='TRUE' description='' triggerName='Timer' order='1' tolerance='-1' tau='0' initialDestination='0' initialValue='0' />
Classic encoding
ScalarDamper { logFeature [""] enabled TRUE description "" triggerName "Timer" order 1 tolerance -1 tau 0 initialDestination 0 initialValue 0 }
Interface
Filter: X3D only | Avalon only | All
id | Name | DataType | PartType | Default | ValueType | Description |
---|---|---|---|---|---|---|
set_destination | SFFloat | inputOnly | The set_destination inputOnly field receives new destination values, resulting in the value_changed field sending output values in most cases. | |||
set_value | SFFloat | inputOnly | With the set_value inputOnly field, one can immediately force the current value towards a certain value | |||
value_changed | SFFloat | outputOnly | The value_changed outputOnly field outputs the current value of the internal state | |||
initialDestination | SFFloat | initializeOnly | 0 | initializes the internal destination state of the node | ||
initialValue | SFFloat | initializeOnly | 0 | initializes the internal value state of the node | ||
tau | SFTime | inputOutput | 0 | [0, Inf) | The field tau specifies the time-constant of the internal filters and thus the speed that the output of an X3DDamperNode responds to the input | |
tolerance | SFFloat | inputOutput | -1 | [0, Inf) | if tolerance is set to its default value -1, the browser implementation is allowed to find a good way for detecting the end of a transition. Browsers that do not have an elaborate algorithm can just use .001 as the tolerance value instead. If a value larger than zero is specified for tolerance, the browser shall calculate the difference between output and input for each internal filter being used and stop the animation only when all filters fall below that limit or are equal to it | |
order | SFInt32 | initializeOnly | 1 | [0, 5] | The field order specifies the number of such internal filters. Specifying zero for order means that no filter is used. In this case the events received on set_destination are forwarded directly to output_changed | |
triggerName | SFString | initializeOnly | Timer | 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. | ||
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 |