Interface X3DDamperNode

All Superinterfaces:
X3DChildNode, X3DFollowerNode, X3DNode
All Known Subinterfaces:
ColorDamper, CoordinateDamper, OrientationDamper, PositionDamper, PositionDamper2D, ScalarDamper, TexCoordDamper2D
All Known Implementing Classes:
ColorDamper, CoordinateDamper, OrientationDamper, PositionDamper, PositionDamper2D, ScalarDamper, TexCoordDamper2D

public interface X3DDamperNode extends X3DFollowerNode
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.


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

    Modifier and Type
    Method
    Description
    boolean
    Provide boolean value from outputOnly SFBool field named isActive.
    Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    int
    Provide int value within allowed range of [0,5] from initializeOnly SFInt32 field named order.
    double
    Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named tau.
    float
    Provide float value from inputOutput SFFloat field named tolerance.
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    setOrder(int newValue)
    Accessor method to assign int value to initializeOnly SFInt32 field named order.
    setTau(double newValue)
    Accessor method to assign double value in seconds to inputOutput SFTime field named tau.
    setTolerance(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named tolerance.
  • Method Details

    • 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 org.web3d.x3d.sai.Core.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:
    • setMetadata

      X3DDamperNode setMetadata(X3DMetadataObject newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.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:
    • 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)
      Accessor method to assign int value 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)
      Accessor method to assign double value in seconds 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)
      Accessor method to 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).