Class: X3DDamperNode

X3D: 3.3
Component: Followers
Status:
experimental

x3dom.nodeTypes. X3DDamperNode

The X3DDamperNode abstract node type creates an IIR response that approaches the destination value according to the shape of the e-function only asymptotically but very quickly. An X3DDamperNode node is parameterized by the tau, order and tolerance fields. Internally, it consists of a set of linear first-order filters each of which processes the output of the previous filter.

HTML Encoding and Default Values

<X3DDamperNode isActive='false' metadata='X3DMetadataObject' order='3' tau='0.3' tolerance='-1' ></X3DDamperNode>

Inheritance


Constructor

X3DDamperNode(ctx)

Constructor for X3DDamperNode

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
isActive SFBool false X3DFollowerNode isActive shows if the sensor is active
metadata SFNode X3DMetadataObject X3DFollowerNode Field to add metadata information
order SFInt32 3 [0..5] The order field specifies the smoothness of the transition.
tau SFTime 3 [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. 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) 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.