All Superinterfaces:: X3DChildNode, X3DDamperNode, X3DFollowerNode, X3DNode

All Known Implementing Classes:: PositionDamper

public interface PositionDamper extends X3DDamperNode

PositionDamper 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. PositionDamper node tooltip: (X3D version 3.2 or later) [X3DDamperNode] PositionDamper 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

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.

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 from outputOnly SFVec3f field named value_changed.

PositionDamper

setInitialDestination(float[] newValue)

Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named initialDestination.

PositionDamper

setInitialValue(float[] newValue)

Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named initialValue.

PositionDamper

setMetadata(X3DMetadataObject newValue)

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

PositionDamper

setOrder(int newValue)

Accessor method to assign int value to initializeOnly SFInt32 field named order.

PositionDamper

setTau(double newValue)

Accessor method to assign double value in seconds to inputOutput SFTime field named tau.

PositionDamper

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 from initializeOnly SFVec3f field named initialDestination.
  
  Tooltip: Initial destination value for this node. *
  
  Returns:
  
  value of initialDestination field
- setInitialDestination
  
  PositionDamper 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:
  
  PositionDamper - 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
  
  PositionDamper 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:
  
  PositionDamper - 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 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.
  
  Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#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
  PositionDamper 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.
  
  Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#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:
  
  PositionDamper - 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
  
  PositionDamper 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:
  
  PositionDamper - 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
  
  PositionDamper 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:
  
  PositionDamper - 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
  
  PositionDamper 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:
  
  PositionDamper - 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 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

Interface PositionDamper

Method Summary

Method Details

getInitialDestination

setInitialDestination

getInitialValue

setInitialValue

getIsActive

getMetadata

setMetadata

getOrder

setOrder

getTau

setTau

getTolerance

setTolerance

getValue