Interface ColorDamper

All Superinterfaces:
X3DChildNode, X3DDamperNode, X3DFollowerNode, X3DNode
All Known Implementing Classes:
ColorDamperObject

public interface ColorDamper
extends X3DDamperNode
ColorDamper generates a series of RGB color values that progressively change from initial value to destination value.

X3D node tooltip: (X3D version 3.2 or later) [X3DDamperNode] ColorDamper generates a series of RGB color values that progressively change from initial value to destination value.
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: ColorDamper, X3D Tooltips: ColorDamper, X3D Scene Authoring Hints
  • Method Summary

    Modifier and Type Method Description
    float[] getInitialDestination()
    Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from initializeOnly SFColor field named initialDestination.
    float[] getInitialValue()
    Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from initializeOnly SFColor field named initialValue.
    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.
    float[] getValue()
    Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from outputOnly SFColor field named value_changed.
    ColorDamper setInitialDestination​(float[] newValue)
    Accessor method to assign 3-tuple float array using RGB values [0..1] to initializeOnly SFColor field named initialDestination.
    ColorDamper setInitialValue​(float[] newValue)
    Accessor method to assign 3-tuple float array using RGB values [0..1] to initializeOnly SFColor field named initialValue.
    ColorDamper setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    ColorDamper setOrder​(int newValue)
    Accessor method to assign int value to initializeOnly SFInt32 field named order.
    ColorDamper setTau​(double newValue)
    Accessor method to assign double value in seconds to inputOutput SFTime field named tau.
    ColorDamper setTolerance​(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named tolerance.
  • Method Details

    • getInitialDestination

      float[] getInitialDestination()
      Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from initializeOnly SFColor field named initialDestination.

      Tooltip: Initial destination value for this node. *
      Returns:
      value of initialDestination field
    • setInitialDestination

      ColorDamper setInitialDestination​(float[] newValue)
      Accessor method to assign 3-tuple float array using RGB values [0..1] to initializeOnly SFColor field named initialDestination.

      Tooltip: Initial destination value for this node. *
      Parameters:
      newValue - is new value for the initialDestination field.
      Returns:
      ColorDamper - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getInitialValue

      float[] getInitialValue()
      Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from initializeOnly SFColor field named initialValue.

      Tooltip: Initial starting value for this node. *
      Returns:
      value of initialValue field
    • setInitialValue

      ColorDamper setInitialValue​(float[] newValue)
      Accessor method to assign 3-tuple float array using RGB values [0..1] to initializeOnly SFColor field named initialValue.

      Tooltip: Initial starting value for this node. *
      Parameters:
      newValue - is new value for the initialValue field.
      Returns:
      ColorDamper - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getIsActive

      boolean getIsActive()
      Provide boolean value from outputOnly SFBool field named isActive.

      Tooltip: isActive true/false events are sent when follower-node computation starts/stops.
      • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
      Specified by:
      getIsActive in interface X3DDamperNode
      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 X3DDamperNode
      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

      ColorDamper setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DDamperNode
      Specified by:
      setMetadata in interface X3DFollowerNode
      Specified by:
      setMetadata in interface X3DNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      ColorDamper - 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.

      Tooltip: [0,5] order defines the number of internal filters (larger means smoother response, longer delay). *
      Specified by:
      getOrder in interface X3DDamperNode
      Returns:
      value of order field
    • setOrder

      ColorDamper setOrder​(int newValue)
      Accessor method to assign int value to initializeOnly SFInt32 field named order.

      Tooltip: [0,5] order defines the number of internal filters (larger means smoother response, longer delay). *
      Specified by:
      setOrder in interface X3DDamperNode
      Parameters:
      newValue - is new value for the order field.
      Returns:
      ColorDamper - 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.

      Tooltip: [0,+infinity) tau is the exponential-decay time constant for filter response in seconds. *
      Specified by:
      getTau in interface X3DDamperNode
      Returns:
      value of tau field
    • setTau

      ColorDamper setTau​(double newValue)
      Accessor method to assign double value in seconds to inputOutput SFTime field named tau.

      Tooltip: [0,+infinity) tau is the exponential-decay time constant for filter response in seconds. *
      Specified by:
      setTau in interface X3DDamperNode
      Parameters:
      newValue - is new value for the tau field.
      Returns:
      ColorDamper - 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.

      Tooltip: [0,+infinity) or -1. Absolute value for satisfactory completion proximity (-1 lets browser choose). *
      Specified by:
      getTolerance in interface X3DDamperNode
      Returns:
      value of tolerance field
    • setTolerance

      ColorDamper setTolerance​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named tolerance.

      Tooltip: [0,+infinity) or -1. Absolute value for satisfactory completion proximity (-1 lets browser choose). *
      Specified by:
      setTolerance in interface X3DDamperNode
      Parameters:
      newValue - is new value for the tolerance field.
      Returns:
      ColorDamper - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getValue

      float[] getValue()
      Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from outputOnly SFColor field named value_changed.

      Tooltip: Computed output value that approaches within tolerance of destination value, as determined by elapsed time, order and tau.
      • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
      Returns:
      value of value_changed field