ColorDamper
The ColorDamper calculates damper-animation for SFColor values
Inheritance
Code
XML encoding
<ColorDamper initialDestination='0 0 0' initialValue='0 0 0' tau='0' tolerance='-1' order='1' triggerName='Timer' description='' enabled='TRUE' logFeature='' />
Classic encoding
ColorDamper { initialDestination 0 0 0 initialValue 0 0 0 tau 0 tolerance -1 order 1 triggerName "Timer" description "" enabled TRUE logFeature [""] }
Interface
Filter: X3D only | Avalon only | All
id | Name | DataType | PartType | Default | ValueType | Description |
---|---|---|---|---|---|---|
enabled | SFBool | inputOutput | TRUE | Enables/disables the sensor node. | ||
isActive | SFBool | outputOnly | FALSE | isActive true/false events are sent when the sensor gets active | ||
initialDestination | SFColor | initializeOnly | 0 0 0 | initializes the internal destination state of the node | ||
initialValue | SFColor | initializeOnly | 0 0 0 | initializes the internal value state of the node | ||
set_destination | SFColor | inputOnly | The set_destination inputOnly field receives new destination values, resulting in the value_changed field sending output values in most cases. | |||
set_value | SFColor | inputOnly | With the set_value inputOnly field, one can immediately force the current value towards a certain value | |||
value_changed | SFColor | outputOnly | The value_changed outputOnly field outputs the current value of the internal state | |||
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 | |
metadata | SFNode | inputOutput | MetadataObject | container for payload metadata inside MetadataSet element | ||
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 | |||
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 |