documentationHTML Encoding and Default Values⤴
<PositionDamper2D
destination='0,0'
initialDestination='0,0'
initialValue='0,0'
isActive='false'
metadata='X3DMetadataObject'
order='3'
tau='0.3'
tolerance='-1'
value='0,0'
></PositionDamper2D>
Inheritance⤴
- X3DNode(18)
- X3DChildNode(12)
- X3DFollowerNode(2)
- X3DDamperNode(7)
- PositionDamper2D
Constructor⤴
-
PositionDamper2D(ctx)⤴
-
Constructor for PositionDamper2D
Parameters:
Name Type Argument Default Description ctxObject <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 | SFVec2f | 0,0 |
|
The target 2D position value. | ||
| initialDestination | SFVec2f | 0,0 |
|
The field initialDestination should be set to the same value than initialValue unless a transition to a certain 2D vector value is to be created right after the scene is loaded or right after the PositinChaser2D node is created dynamically. | ||
| initialValue | SFVec2f | 0,0 |
|
The field initialValue can be used to set the initial initial value. | ||
| 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 | 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 | SFVec2f | 0,0 |
|
The current 2D position value. |