ScalarDamper
Overview
ScalarDamper generates a series of floating-point values that progressively change from initial value to destination value.
The ScalarDamper node belongs to the Followers component and requires at least level 1, its default container field is children. It is available from X3D version 3.3 or higher.
Hierarchy
1
2
3
4
5
+ X3DNode
+ X3DChildNode
+ X3DFollowerNode
+ X3DDamperNode
+ ScalarDamper
Fields
SFNode [in, out] metadata NULL [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint
SFFloat [in] set_value (-∞,∞)
set_value resets current value of this node.
Warning
- It is an error to define this transient inputOnly field in an X3D file, instead only use it a destination for ROUTE events.
SFFloat [in] set_destination (-∞,∞)
set_destination resets destination value of this node.
Warning
- It is an error to define this transient inputOnly field in an X3D file, instead only use it a destination for ROUTE events.
SFFloat [ ] initialValue 0 (-∞,∞)
Initial starting value for this node.
SFFloat [ ] initialDestination 0 (-∞,∞)
Initial destination value for this node.
SFInt32 [ ] order 3 [0..5]
order defines the number of internal filters (larger means smoother response, longer delay).
SFTime [in, out] tau 0.3 [0,∞)
tau is the exponential-decay time constant for filter response in seconds.
SFFloat [in, out] tolerance -1 -1 or [0,∞)
Absolute value for satisfactory completion proximity (-1 lets browser choose).
SFBool [out] isActive
isActive true/false events are sent when follower-node computation starts/stops.
Warning
- It is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
SFFloat [out] value_changed
Computed output value that approaches within tolerance of destination value, as determined by elapsed time, order and tau.
Warning
- It is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
Advice
Hint
- ROUTE value_changed output events to an interpolator node’s set_fraction field, for example.