Interface ColorChaser

    • Method Summary

      Modifier and Type Method Description
      double getDuration()
      Provide double value in seconds within allowed range of [0,infinity) from initializeOnly SFTime field named duration.
      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.
      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.
      ColorChaser setDuration​(double newValue)
      Accessor method to assign double value in seconds to initializeOnly SFTime field named duration.
      ColorChaser setInitialDestination​(float[] newValue)
      Accessor method to assign 3-tuple float array using RGB values [0..1] to initializeOnly SFColor field named initialDestination.
      ColorChaser setInitialValue​(float[] newValue)
      Accessor method to assign 3-tuple float array using RGB values [0..1] to initializeOnly SFColor field named initialValue.
      ColorChaser setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    • Method Detail

      • getDuration

        double getDuration()
        Provide double value in seconds within allowed range of [0,infinity) from initializeOnly SFTime field named duration.

        Tooltip: [0,+infinity) duration is the time interval for filter response in seconds.
        • Hint: duration is a nonnegative SFTime duration interval, not an absolute clock time.
        Specified by:
        getDuration in interface X3DChaserNode
        Returns:
        value of duration field
      • setDuration

        ColorChaser setDuration​(double newValue)
        Accessor method to assign double value in seconds to initializeOnly SFTime field named duration.

        Tooltip: [0,+infinity) duration is the time interval for filter response in seconds.
        • Hint: duration is a nonnegative SFTime duration interval, not an absolute clock time.
        Specified by:
        setDuration in interface X3DChaserNode
        Parameters:
        newValue - is new value for the duration field.
        Returns:
        ColorChaser - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • 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

        ColorChaser 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:
        ColorChaser - 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

        ColorChaser 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:
        ColorChaser - 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 X3DChaserNode
        Specified by:
        getIsActive in interface X3DFollowerNode
        Returns:
        value of isActive field
      • 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