official documentation

  1. x3dom.org
  2. documentation
  3. Developer API

Class: ScalarDamper

X3D: 3.3
Component: Followers
Status:
experimental

Quick Links

➨ Fields
➨ Properties

.nodeTypes. ScalarDamper

The ScalarDamper animates transitions for single float values. If the value field is routed to a transparency field of a Material node, then, whenever the destination field receives a single float value, the ScalarDamper node creates a transition from its current value to the newly set value.

HTML Encoding and Default Values⤴

<ScalarDamper destination='0' initialDestination='0' initialValue='0' isActive='false' metadata='X3DMetadataObject' order='3' tau='0.3' tolerance='-1' value='0' ></ScalarDamper>

Inheritance⤴


Constructor⤴

ScalarDamper(ctx)⤴

Constructor for ScalarDamper

Parameters:
Name Type Argument Default Description
ctx Object <optional>
 null context object, containing initial settings like namespace

Fields⤴

These are the X3D / X3DOM fields of this node. Values should usually be received / set as strings via DOM functions (i.e., using setAttribute("myFieldName", "myFieldValue") and getAttribute("myFieldName")).
Name Type Default Value Range Inheritance Standard Description
destination SFFloat 0 The target value.
initialDestination SFFloat 0 The field initialDestination should be set to the same value than initialValue unless a transition to a certain value is to be created right after the scene is loaded or right after the ScalarDamper node is created dynamically.
initialValue SFFloat 0 The field initialValue can be used to set the initial value of the node.
isActive SFBool false X3DFollowerNode isActive shows if the sensor is active
metadata SFNode X3DMetadataObject X3DNode Field to add metadata information
order SFInt32 3 [0..5] X3DDamperNode The order field specifies the smoothness of the transition.
tau SFTime 0.3 [0,inf) X3DDamperNode 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. A value of zero for tau means immediate response and the events received on set_destination are forwarded directly. The field tau specifies how long it takes the output of an internal filter to reach the value of its input by 63% (1 - 1/e). The remainder after that period is reduced by 63% during another period of tau seconds provided that the input of the filter does not change. This behavior can be exposed if order is set to one.
tolerance SFFloat -1 -1 or [0,inf) X3DDamperNode 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. If zero is specified for tolerance, a transition should be stopped only if input and output match exactly for all internal filters.
value SFFloat 0 The current value.