Interface PositionChaser

All Superinterfaces:
X3DChaserNode, X3DChildNode, X3DFollowerNode, X3DNode
All Known Implementing Classes:
PositionChaser
public interface PositionChaser extends X3DChaserNode
PositionChaser generates a series of position values that progressively change from initial value to destination value.

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes. PositionChaser node tooltip: (X3D version 3.2 or later) [X3DChaserNode] PositionChaser generates a series of position values that progressively change from initial value to destination value.
  • Hint: ROUTE value_changed output events to a <Transform> node's translation field, for example.

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
    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 from initializeOnly SFVec3f field named initialDestination.
    float[]
    getInitialValue()
    Provide array of 3-tuple float results from initializeOnly SFVec3f field named initialValue.
    boolean
    getIsActive()
    Provide boolean value from outputOnly SFBool field named isActive.
    X3DMetadataObject
    getMetadata()
    Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    float[]
    getValue()
    Provide array of 3-tuple float results from outputOnly SFVec3f field named value_changed.
    PositionChaser
    setDuration(double newValue)
    Accessor method to assign double value in seconds to initializeOnly SFTime field named duration.
    PositionChaser
    setInitialDestination(float[] newValue)
    Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named initialDestination.
    PositionChaser
    setInitialValue(float[] newValue)
    Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named initialValue.
    PositionChaser
    setMetadata(X3DMetadataObject newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

  • Method Details

    • 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

      PositionChaser 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:
      PositionChaser - 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 from initializeOnly SFVec3f field named initialDestination.

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

    • setInitialDestination

      PositionChaser setInitialDestination(float[] newValue)
      Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named initialDestination.

      Tooltip: Initial destination value for this node. *
      Parameters:
      newValue - is new value for the initialDestination field.
      Returns:
      PositionChaser - 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 from initializeOnly SFVec3f field named initialValue.

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

    • setInitialValue

      PositionChaser setInitialValue(float[] newValue)
      Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named initialValue.

      Tooltip: Initial starting value for this node. *
      Parameters:
      newValue - is new value for the initialValue field.
      Returns:
      PositionChaser - 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

    • getMetadata

      X3DMetadataObject getMetadata()
      Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
      Specified by:
      getMetadata in interface X3DChaserNode
      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

      PositionChaser setMetadata(X3DMetadataObject newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
      Specified by:
      setMetadata in interface X3DChaserNode
      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:
      PositionChaser - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • getValue

      float[] getValue()
      Provide array of 3-tuple float results from outputOnly SFVec3f 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