X3DDamperNode (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DChildNode, X3DFollowerNode, X3DNode

All Known Subinterfaces:

ColorDamper, CoordinateDamper, OrientationDamper, PositionDamper, PositionDamper2D, ScalarDamper, TexCoordDamper2D

All Known Implementing Classes:

ColorDamperObject, CoordinateDamperObject, OrientationDamperObject, PositionDamper2DObject, PositionDamperObject, ScalarDamperObject, TexCoordDamper2DObject
```
public interface X3DDamperNode
extends X3DFollowerNode
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).

See Also:

SAI Java Specification: TODO, X3D Abstract Specification: TODO, X3D Tooltips, X3D Scene Authoring Hints

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`getIsActive()` Provide boolean value from outputOnly SFBool field named isActive.
`X3DMetadataObject`	`getMetadata()` Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`int`	`getOrder()` Provide int value within allowed range of [0,5] from initializeOnly SFInt32 field named order.
`double`	`getTau()` Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named tau.
`float`	`getTolerance()` Provide float value from inputOutput SFFloat field named tolerance.
`X3DDamperNode`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`X3DDamperNode`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`X3DDamperNode`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`X3DDamperNode`	`setOrder(int newValue)` Assign int value within allowed range of [0,5] to initializeOnly SFInt32 field named order.
`X3DDamperNode`	`setTau(double newValue)` Assign double value in seconds within allowed range of [0,infinity) to inputOutput SFTime field named tau.
`X3DDamperNode`	`setTolerance(float newValue)` Assign float value to inputOutput SFFloat field named tolerance.
`X3DDamperNode`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - getIsActive
```
boolean getIsActive()
```
    Provide boolean value from outputOnly SFBool field named isActive.
    
    Specified by:
    
    getIsActive in interface X3DFollowerNode
    
    Returns:
    
    value of isActive field
  - getMetadata
```
X3DMetadataObject getMetadata()
```
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    
    Specified by:
    
    getMetadata in interface X3DChildNode
    
    Specified by:
    
    getMetadata in interface X3DFollowerNode
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
X3DDamperNode setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DChildNode
    
    Specified by:
    
    setMetadata in interface X3DFollowerNode
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    X3DDamperNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - getOrder
```
int getOrder()
```
    Provide int value within allowed range of [0,5] from initializeOnly SFInt32 field named order.
    
    Returns:
    
    value of order field
  - setOrder
```
X3DDamperNode setOrder(int newValue)
```
    Assign int value within allowed range of [0,5] to initializeOnly SFInt32 field named order.
    
    Parameters:
    
    newValue - is new value for the order field.
    
    Returns:
    
    X3DDamperNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getTau
```
double getTau()
```
    Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named tau.
    
    Returns:
    
    value of tau field
  - setTau
```
X3DDamperNode setTau(double newValue)
```
    Assign double value in seconds within allowed range of [0,infinity) to inputOutput SFTime field named tau.
    
    Parameters:
    
    newValue - is new value for the tau field.
    
    Returns:
    
    X3DDamperNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getTolerance
```
float getTolerance()
```
    Provide float value from inputOutput SFFloat field named tolerance.
    
    Returns:
    
    value of tolerance field
  - setTolerance
```
X3DDamperNode setTolerance(float newValue)
```
    Assign float value to inputOutput SFFloat field named tolerance.
    
    Parameters:
    
    newValue - is new value for the tolerance field.
    
    Returns:
    
    X3DDamperNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
X3DDamperNode setDEF(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named DEF.
    
    Note that setting the DEF value clears the USE value.
    
    Specified by:
    
    setDEF in interface X3DChildNode
    
    Specified by:
    
    setDEF in interface X3DFollowerNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    X3DDamperNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
X3DDamperNode setUSE(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named USE.
    
    Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.
    
    Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
    
    Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
    
    Specified by:
    
    setUSE in interface X3DChildNode
    
    Specified by:
    
    setUSE in interface X3DFollowerNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    X3DDamperNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
X3DDamperNode setCssClass(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named class.
    
    Specified by:
    
    setCssClass in interface X3DChildNode
    
    Specified by:
    
    setCssClass in interface X3DFollowerNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    X3DDamperNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface X3DDamperNode

Method Summary

Method Detail

getIsActive

getMetadata

setMetadata

getOrder

setOrder

getTau

setTau

getTolerance

setTolerance

setDEF

setUSE

setCssClass