CoordinateDamperObject (X3DJSAIL, X3D Java Scene Access Interface Library)

java.lang.Object
- org.web3d.x3d.jsail.X3DConcreteElement
- - org.web3d.x3d.jsail.X3DConcreteNode
  - - org.web3d.x3d.jsail.Followers.CoordinateDamperObject

All Implemented Interfaces:

X3DChildNode, X3DNode, CoordinateDamper, X3DDamperNode, X3DFollowerNode
```
public class CoordinateDamperObject
extends X3DConcreteNode
implements CoordinateDamper
```
X3D node tooltip: (X3D version 3.2 or later) [X3DDamperNode] CoordinateDamper generates a series of coordinate arrays that progressively change from initial value to destination value.
- Hint: ROUTE value_changed output events to a <Coordinate> node's point field, for example.
Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
See Also:

X3D Abstract Specification: CoordinateDamper, X3D Tooltips: CoordinateDamper, X3D Scene Authoring Hints

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COMPONENT` String constant COMPONENT defines X3D component for the CoordinateDamper element: Followers
`static java.lang.String`	`containerField_DEFAULT_VALUE` containerField describes typical field relationship of a node to its parent.
`static java.lang.String`	`fromField_ISACTIVE` fromField ROUTE name for SFBool field named isActive.
`static java.lang.String`	`fromField_METADATA` fromField ROUTE name for SFNode field named metadata.
`static java.lang.String`	`fromField_TAU` fromField ROUTE name for SFTime field named tau.
`static java.lang.String`	`fromField_TOLERANCE` fromField ROUTE name for SFFloat field named tolerance.
`static java.lang.String`	`fromField_VALUE_CHANGED` fromField ROUTE name for MFVec3f field named value_changed.
`static float[]`	`INITIALDESTINATION_DEFAULT_VALUE` MFVec3f field named initialDestination has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
`static float[]`	`INITIALVALUE_DEFAULT_VALUE` MFVec3f field named initialValue has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
`static int`	`LEVEL` Integer constant LEVEL provides default X3D Followers component level for this element: 1
`static java.lang.String`	`NAME` String constant NAME provides name of this element: CoordinateDamper.
`static int`	`ORDER_DEFAULT_VALUE` SFInt32 field named order has default value 3 (Java syntax) or 3 (XML syntax).
`static double`	`TAU_DEFAULT_VALUE` SFTime field named tau has default value 0.3 (Java syntax) or 0.3 (XML syntax).
`static java.lang.String`	`toField_METADATA` toField ROUTE name for SFNode field named metadata.
`static java.lang.String`	`toField_SET_DESTINATION` toField ROUTE name for MFVec3f field named set_destination.
`static java.lang.String`	`toField_SET_VALUE` toField ROUTE name for MFVec3f field named set_value.
`static java.lang.String`	`toField_TAU` toField ROUTE name for SFTime field named tau.
`static java.lang.String`	`toField_TOLERANCE` toField ROUTE name for SFFloat field named tolerance.
`static float`	`TOLERANCE_DEFAULT_VALUE` SFFloat field named tolerance has default value -1f (Java syntax) or -1 (XML syntax).

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement
validationResult

Constructor Summary

Constructors
Constructor and Description
`CoordinateDamperObject()` Constructor for CoordinateDamperObject to initialize member variables with default values.
`CoordinateDamperObject(java.lang.String DEFlabel)` Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CoordinateDamperObject`	`addComments(CommentsBlock newCommentsBlock)` Add CommentsBlock to contained commentsList.
`CoordinateDamperObject`	`addComments(java.lang.String newComment)` Add comment as String to contained commentsList.
`CoordinateDamperObject`	`addComments(java.lang.String[] newComments)` Add comments as String[] array to contained commentsList.
`CoordinateDamperObject`	`addInitialDestination(SFVec3fObject newValue)` Add singleton SFVec3fObject value to MFVec3f initialDestination field.
`CoordinateDamperObject`	`addInitialValue(SFVec3fObject newValue)` Add singleton SFVec3fObject value to MFVec3f initialValue field.
`CoordinateDamperObject`	`clearMetadata()` Utility method to clear SFNode value of metadata field.
`X3DConcreteElement`	`findElementByNameValue(java.lang.String nameValue)` Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
`X3DConcreteElement`	`findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)` Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
`X3DConcreteNode`	`findNodeByDEF(java.lang.String DEFvalue)` Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
`java.lang.String`	`getAccessType(java.lang.String fieldName)` Indicate accessType corresponding to given fieldName.
`java.lang.String`	`getComponent()` Defines X3D component for the CoordinateDamper element: Followers
`int`	`getComponentLevel()` Provides default X3D component level for this element: 1
`java.lang.String`	`getContainerFieldDefault()` containerField describes typical field relationship of a node to its parent.
`java.lang.String`	`getElementName()` Provides name of this element: CoordinateDamper
`java.lang.String`	`getFieldType(java.lang.String fieldName)` Indicate type corresponding to given fieldName.
`float[]`	`getInitialDestination()` Provide array of 3-tuple float results from initializeOnly MFVec3f field named initialDestination.
`float[]`	`getInitialValue()` Provide array of 3-tuple float results from initializeOnly MFVec3f field named initialValue.
`ISObject`	`getIS()` Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
`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 from outputOnly MFVec3f field named value_changed.
`boolean`	`hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName)` Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
`boolean`	`hasMetadata()` Indicate whether an object is available for inputOutput SFNode field metadata.
`boolean`	`hasNodeByDEF(java.lang.String DEFvalue)` Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
`void`	`initialize()` Initialize all member variables to default values.
`CoordinateDamperObject`	`setCssClass(SFStringObject newValue)` Assign typed object value to SFString cssClass field, similar to `setCssClass(String)`.
`CoordinateDamperObject`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`CoordinateDamperObject`	`setDEF(SFStringObject newValue)` Assign typed object value to SFString DEF field, similar to `setDEF(String)`.
`CoordinateDamperObject`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`CoordinateDamperObject`	`setInitialDestination(float[] newValue)` Assign 3-tuple float array to initializeOnly MFVec3f field named initialDestination.
`CoordinateDamperObject`	`setInitialDestination(MFVec3fObject newValue)` Assign typed object value to MFVec3f initialDestination field, similar to `setInitialDestination(float[])`.
`CoordinateDamperObject`	`setInitialValue(float[] newValue)` Assign 3-tuple float array to initializeOnly MFVec3f field named initialValue.
`CoordinateDamperObject`	`setInitialValue(MFVec3fObject newValue)` Assign typed object value to MFVec3f initialValue field, similar to `setInitialValue(float[])`.
`CoordinateDamperObject`	`setIS(ISObject newValue)` Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
`CoordinateDamperObject`	`setMetadata(ProtoInstanceObject newValue)` Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
`CoordinateDamperObject`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`CoordinateDamperObject`	`setOrder(int newValue)` Assign int value within allowed range of [0,5] to initializeOnly SFInt32 field named order.
`CoordinateDamperObject`	`setOrder(SFInt32Object newValue)` Assign typed object value to SFInt32 order field, similar to `setOrder(int)`.
`CoordinateDamperObject`	`setTau(double newValue)` Assign double value in seconds within allowed range of [0,infinity) to inputOutput SFTime field named tau.
`CoordinateDamperObject`	`setTau(SFTimeObject newValue)` Assign typed object value to SFTime tau field, similar to `setTau(double)`.
`CoordinateDamperObject`	`setTolerance(float newValue)` Assign float value to inputOutput SFFloat field named tolerance.
`CoordinateDamperObject`	`setTolerance(SFFloatObject newValue)` Assign typed object value to SFFloat tolerance field, similar to `setTolerance(float)`.
`CoordinateDamperObject`	`setUSE(CoordinateDamperObject DEFnode)` Assign a USE reference to another DEF node of same node type, similar to `setUSE(String)`.
`CoordinateDamperObject`	`setUSE(SFStringObject newValue)` Assign typed object value to SFString USE field, similar to `setUSE(String)`.
`CoordinateDamperObject`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.
`java.lang.String`	`toStringClassicVRML(int indentLevel)` Recursive method to provide ClassicVRML string serialization.
`java.lang.String`	`toStringVRML97(int indentLevel)` Recursive method to provide VRML97 string serialization.
`java.lang.String`	`toStringX3D(int indentLevel)` Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
`java.lang.String`	`validate()` Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode
getContainerFieldAlternateValues, getContainerFieldOverride, getCssClass, getDEF, getUSE, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NAME
```
public static final java.lang.String NAME
```
    String constant NAME provides name of this element: CoordinateDamper.
    
    See Also:
    
    Constant Field Values
  - COMPONENT
```
public static final java.lang.String COMPONENT
```
    String constant COMPONENT defines X3D component for the CoordinateDamper element: Followers
    
    See Also:
    
    Constant Field Values
  - LEVEL
```
public static final int LEVEL
```
    Integer constant LEVEL provides default X3D Followers component level for this element: 1
    
    See Also:
    
    Constant Field Values
  - INITIALDESTINATION_DEFAULT_VALUE
```
public static final float[] INITIALDESTINATION_DEFAULT_VALUE
```
    MFVec3f field named initialDestination has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
  - INITIALVALUE_DEFAULT_VALUE
```
public static final float[] INITIALVALUE_DEFAULT_VALUE
```
    MFVec3f field named initialValue has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
  - ORDER_DEFAULT_VALUE
```
public static final int ORDER_DEFAULT_VALUE
```
    SFInt32 field named order has default value 3 (Java syntax) or 3 (XML syntax).
    
    See Also:
    
    Constant Field Values
  - TAU_DEFAULT_VALUE
```
public static final double TAU_DEFAULT_VALUE
```
    SFTime field named tau has default value 0.3 (Java syntax) or 0.3 (XML syntax).
    
    See Also:
    
    Constant Field Values
  - TOLERANCE_DEFAULT_VALUE
```
public static final float TOLERANCE_DEFAULT_VALUE
```
    SFFloat field named tolerance has default value -1f (Java syntax) or -1 (XML syntax).
    
    See Also:
    
    Constant Field Values
  - containerField_DEFAULT_VALUE
```
public static final java.lang.String containerField_DEFAULT_VALUE
```
    containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
    
    See Also:
    
    X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM), Constant Field Values
  - fromField_ISACTIVE
```
public static final java.lang.String fromField_ISACTIVE
```
    fromField ROUTE name for SFBool field named isActive.
    
    See Also:
    
    Constant Field Values
  - fromField_METADATA
```
public static final java.lang.String fromField_METADATA
```
    fromField ROUTE name for SFNode field named metadata.
    
    See Also:
    
    Constant Field Values
  - toField_METADATA
```
public static final java.lang.String toField_METADATA
```
    toField ROUTE name for SFNode field named metadata.
    
    See Also:
    
    Constant Field Values
  - toField_SET_DESTINATION
```
public static final java.lang.String toField_SET_DESTINATION
```
    toField ROUTE name for MFVec3f field named set_destination.
    
    See Also:
    
    Constant Field Values
  - toField_SET_VALUE
```
public static final java.lang.String toField_SET_VALUE
```
    toField ROUTE name for MFVec3f field named set_value.
    
    See Also:
    
    Constant Field Values
  - fromField_TAU
```
public static final java.lang.String fromField_TAU
```
    fromField ROUTE name for SFTime field named tau.
    
    See Also:
    
    Constant Field Values
  - toField_TAU
```
public static final java.lang.String toField_TAU
```
    toField ROUTE name for SFTime field named tau.
    
    See Also:
    
    Constant Field Values
  - fromField_TOLERANCE
```
public static final java.lang.String fromField_TOLERANCE
```
    fromField ROUTE name for SFFloat field named tolerance.
    
    See Also:
    
    Constant Field Values
  - toField_TOLERANCE
```
public static final java.lang.String toField_TOLERANCE
```
    toField ROUTE name for SFFloat field named tolerance.
    
    See Also:
    
    Constant Field Values
  - fromField_VALUE_CHANGED
```
public static final java.lang.String fromField_VALUE_CHANGED
```
    fromField ROUTE name for MFVec3f field named value_changed.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CoordinateDamperObject
```
public CoordinateDamperObject()
```
    Constructor for CoordinateDamperObject to initialize member variables with default values.
  - CoordinateDamperObject
```
public CoordinateDamperObject(java.lang.String DEFlabel)
```
    Utility constructor that assigns DEF label after initializing member variables with default values.
    
    Parameters:
    
    DEFlabel - unique DEF name for this X3D node
- Method Detail
  - getElementName
```
public final java.lang.String getElementName()
```
    Provides name of this element: CoordinateDamper
    
    Specified by:
    
    getElementName in class X3DConcreteElement
    
    Returns:
    
    name of this element
  - getComponent
```
public final java.lang.String getComponent()
```
    Defines X3D component for the CoordinateDamper element: Followers
    
    Specified by:
    
    getComponent in class X3DConcreteElement
    
    Returns:
    
    X3D component for this element
  - getComponentLevel
```
public final int getComponentLevel()
```
    Provides default X3D component level for this element: 1
    
    Specified by:
    
    getComponentLevel in class X3DConcreteElement
    
    Returns:
    
    default X3D component level for this element
  - getFieldType
```
public java.lang.String getFieldType(java.lang.String fieldName)
```
    Indicate type corresponding to given fieldName.
    
    Specified by:
    
    getFieldType in class X3DConcreteElement
    
    Parameters:
    
    fieldName - name of field in this X3D node
    
    Returns:
    
    X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
    
    See Also:
    
    ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
  - getAccessType
```
public java.lang.String getAccessType(java.lang.String fieldName)
```
    Indicate accessType corresponding to given fieldName.
    
    Specified by:
    
    getAccessType in class X3DConcreteElement
    
    Parameters:
    
    fieldName - name of field in this X3D node
    
    Returns:
    
    X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
    
    See Also:
    
    ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
  - getContainerFieldDefault
```
public final java.lang.String getContainerFieldDefault()
```
    containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
    
    Specified by:
    
    getContainerFieldDefault in class X3DConcreteNode
    
    Returns:
    
    default containerField value
    
    See Also:
    
    X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)
  - initialize
```
public final void initialize()
```
    Initialize all member variables to default values.
    
    Overrides:
    
    initialize in class X3DConcreteNode
  - getInitialDestination
```
public float[] getInitialDestination()
```
    Provide array of 3-tuple float results from initializeOnly MFVec3f field named initialDestination.
    
    Tooltip: Initial destination value for this node. *
    
    Specified by:
    
    getInitialDestination in interface CoordinateDamper
    
    Returns:
    
    value of initialDestination field
  - setInitialDestination
```
public CoordinateDamperObject setInitialDestination(float[] newValue)
```
    Assign 3-tuple float array to initializeOnly MFVec3f field named initialDestination.
    
    Tooltip: Initial destination value for this node.
    
    Specified by:
    
    setInitialDestination in interface CoordinateDamper
    
    Parameters:
    
    newValue - is new value for the initialDestination field.
    
    Returns:
    
    CoordinateDamperObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setInitialDestination
```
public CoordinateDamperObject setInitialDestination(MFVec3fObject newValue)
```
    Assign typed object value to MFVec3f initialDestination field, similar to setInitialDestination(float[]).
    
    Parameters:
    
    newValue - is new value for the initialDestination field.
    
    Returns:
    
    CoordinateDamperObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - addInitialDestination
```
public CoordinateDamperObject addInitialDestination(SFVec3fObject newValue)
```
    Add singleton SFVec3fObject value to MFVec3f initialDestination field.
    
    Parameters:
    
    newValue - is new value to add to the initialDestination field.
    
    Returns:
    
    CoordinateDamperObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getInitialValue
```
public float[] getInitialValue()
```
    Provide array of 3-tuple float results from initializeOnly MFVec3f field named initialValue.
    
    Tooltip: Initial starting value for this node. *
    
    Specified by:
    
    getInitialValue in interface CoordinateDamper
    
    Returns:
    
    value of initialValue field
  - setInitialValue
```
public CoordinateDamperObject setInitialValue(float[] newValue)
```
    Assign 3-tuple float array to initializeOnly MFVec3f field named initialValue.
    
    Tooltip: Initial starting value for this node.
    
    Specified by:
    
    setInitialValue in interface CoordinateDamper
    
    Parameters:
    
    newValue - is new value for the initialValue field.
    
    Returns:
    
    CoordinateDamperObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setInitialValue
```
public CoordinateDamperObject setInitialValue(MFVec3fObject newValue)
```
    Assign typed object value to MFVec3f initialValue field, similar to setInitialValue(float[]).
    
    Parameters:
    
    newValue - is new value for the initialValue field.
    
    Returns:
    
    CoordinateDamperObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - addInitialValue
```
public CoordinateDamperObject addInitialValue(SFVec3fObject newValue)
```
    Add singleton SFVec3fObject value to MFVec3f initialValue field.
    
    Parameters:
    
    newValue - is new value to add to the initialValue field.
    
    Returns:
    
    CoordinateDamperObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getIsActive
```
public 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.
    Specified by:
    
    getIsActive in interface CoordinateDamper
    
    Specified by:
    
    getIsActive in interface X3DDamperNode
    
    Specified by:
    
    getIsActive in interface X3DFollowerNode
    
    Returns:
    
    value of isActive field
  - getMetadata
```
public 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 X3DNode
    
    Specified by:
    
    getMetadata in interface CoordinateDamper
    
    Specified by:
    
    getMetadata in interface X3DDamperNode
    
    Specified by:
    
    getMetadata in interface X3DFollowerNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
public CoordinateDamperObject setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DChildNode
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Specified by:
    
    setMetadata in interface CoordinateDamper
    
    Specified by:
    
    setMetadata in interface X3DDamperNode
    
    Specified by:
    
    setMetadata in interface X3DFollowerNode
    
    Specified by:
    
    setMetadata in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    CoordinateDamperObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    setMetadata(ProtoInstanceObject), X3D Scene Authoring Hints: Metadata Nodes
  - clearMetadata
```
public CoordinateDamperObject clearMetadata()
```
    Utility method to clear SFNode value of metadata field.
    
    Returns:
    
    CoordinateDamperObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - setMetadata
```
public CoordinateDamperObject setMetadata(ProtoInstanceObject newValue)
```
    Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    CoordinateDamperObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    setMetadata(X3DMetadataObject)
  - hasMetadata
```
public boolean hasMetadata()
```
    Indicate whether an object is available for inputOutput SFNode field metadata.
    
    Returns:
    
    whether a properly typed node or ProtoInstance or CommentsBlock is available.
    
    See Also:
    
    getMetadata(), getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
  - getOrder
```
public 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 CoordinateDamper
    
    Specified by:
    
    getOrder in interface X3DDamperNode
    
    Returns:
    
    value of order field
  - setOrder
```
public CoordinateDamperObject setOrder(int newValue)
```
    Assign int value within allowed range of [0,5] 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 CoordinateDamper
    
    Specified by:
    
    setOrder in interface X3DDamperNode
    
    Parameters:
    
    newValue - is new value for the order field.
    
    Returns:
    
    CoordinateDamperObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setOrder
```
public CoordinateDamperObject setOrder(SFInt32Object newValue)
```
    Assign typed object value to SFInt32 order field, similar to setOrder(int).
    
    Parameters:
    
    newValue - is new value for the order field.
    
    Returns:
    
    CoordinateDamperObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getTau
```
public 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 CoordinateDamper
    
    Specified by:
    
    getTau in interface X3DDamperNode
    
    Returns:
    
    value of tau field
  - setTau
```
public CoordinateDamperObject setTau(double newValue)
```
    Assign double value in seconds within allowed range of [0,infinity) 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 CoordinateDamper
    
    Specified by:
    
    setTau in interface X3DDamperNode
    
    Parameters:
    
    newValue - is new value for the tau field.
    
    Returns:
    
    CoordinateDamperObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setTau
```
public CoordinateDamperObject setTau(SFTimeObject newValue)
```
    Assign typed object value to SFTime tau field, similar to setTau(double).
    
    Parameters:
    
    newValue - is new value for the tau field.
    
    Returns:
    
    CoordinateDamperObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getTolerance
```
public 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 CoordinateDamper
    
    Specified by:
    
    getTolerance in interface X3DDamperNode
    
    Returns:
    
    value of tolerance field
  - setTolerance
```
public CoordinateDamperObject setTolerance(float newValue)
```
    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 CoordinateDamper
    
    Specified by:
    
    setTolerance in interface X3DDamperNode
    
    Parameters:
    
    newValue - is new value for the tolerance field.
    
    Returns:
    
    CoordinateDamperObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setTolerance
```
public CoordinateDamperObject setTolerance(SFFloatObject newValue)
```
    Assign typed object value to SFFloat tolerance field, similar to setTolerance(float).
    
    Parameters:
    
    newValue - is new value for the tolerance field.
    
    Returns:
    
    CoordinateDamperObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getValue
```
public float[] getValue()
```
    Provide array of 3-tuple float results from outputOnly MFVec3f 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.
    Specified by:
    
    getValue in interface CoordinateDamper
    
    Returns:
    
    value of value_changed field
  - setDEF
```
public final CoordinateDamperObject setDEF(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named DEF.
    
    Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
    
    Note that setting the DEF value clears the USE value.
    
    Specified by:
    
    setDEF in interface X3DChildNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Specified by:
    
    setDEF in interface CoordinateDamper
    
    Specified by:
    
    setDEF in interface X3DDamperNode
    
    Specified by:
    
    setDEF in interface X3DFollowerNode
    
    Specified by:
    
    setDEF in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    CoordinateDamperObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
public CoordinateDamperObject setDEF(SFStringObject newValue)
```
    Assign typed object value to SFString DEF field, similar to setDEF(String).
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    CoordinateDamperObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
public final CoordinateDamperObject setUSE(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named USE.
    
    Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value). Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance. Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute. Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
    
    Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.
    
    Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
    
    Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
    
    Specified by:
    
    setUSE in interface X3DChildNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Specified by:
    
    setUSE in interface CoordinateDamper
    
    Specified by:
    
    setUSE in interface X3DDamperNode
    
    Specified by:
    
    setUSE in interface X3DFollowerNode
    
    Specified by:
    
    setUSE in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    CoordinateDamperObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
public CoordinateDamperObject setUSE(SFStringObject newValue)
```
    Assign typed object value to SFString USE field, similar to setUSE(String).
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    CoordinateDamperObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
public final CoordinateDamperObject setCssClass(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named class.
    
    Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets. Warning: currently the class attribute is only supported in XML encoding of X3D scenes. Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
    
    Specified by:
    
    setCssClass in interface X3DChildNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Specified by:
    
    setCssClass in interface CoordinateDamper
    
    Specified by:
    
    setCssClass in interface X3DDamperNode
    
    Specified by:
    
    setCssClass in interface X3DFollowerNode
    
    Specified by:
    
    setCssClass in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    CoordinateDamperObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    W3C Cascading Style Sheets
  - setCssClass
```
public CoordinateDamperObject setCssClass(SFStringObject newValue)
```
    Assign typed object value to SFString cssClass field, similar to setCssClass(String).
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    CoordinateDamperObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setIS
```
public CoordinateDamperObject setIS(ISObject newValue)
```
    Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.
    
    Specified by:
    
    setIS in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the description field.
    
    Returns:
    
    CoordinateDamperObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    X3D Tooltips: IS, X3D Tooltips: connect
  - getIS
```
public ISObject getIS()
```
    Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.
    
    Specified by:
    
    getIS in class X3DConcreteNode
    
    Returns:
    
    current ISObject, if any.
    
    See Also:
    
    X3D Tooltips: IS, X3D Tooltips: connect
  - setUSE
```
public CoordinateDamperObject setUSE(CoordinateDamperObject DEFnode)
```
    Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
    
    Warning: note that the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
    
    Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
    
    Parameters:
    
    DEFnode - must have a DEF value defined
    
    Returns:
    
    CoordinateDamperObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - addComments
```
public CoordinateDamperObject addComments(java.lang.String newComment)
```
    Add comment as String to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newComment - initial value
    
    Returns:
    
    CoordinateDamperObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addComments
```
public CoordinateDamperObject addComments(java.lang.String[] newComments)
```
    Add comments as String[] array to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newComments - array of comments
    
    Returns:
    
    CoordinateDamperObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addComments
```
public CoordinateDamperObject addComments(CommentsBlock newCommentsBlock)
```
    Add CommentsBlock to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newCommentsBlock - block of comments to add
    
    Returns:
    
    CoordinateDamperObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - toStringX3D
```
public java.lang.String toStringX3D(int indentLevel)
```
    Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
    
    Specified by:
    
    toStringX3D in class X3DConcreteElement
    
    Parameters:
    
    indentLevel - number of levels of indentation for this element
    
    Returns:
    
    X3D string
    
    See Also:
    
    X3DObject.FILE_EXTENSION_X3D, X3DObject.FILE_EXTENSION_XML, X3DObject.toStringXML(), X3DObject.toFileXML(String), X3DObject.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form
  - toStringClassicVRML
```
public java.lang.String toStringClassicVRML(int indentLevel)
```
    Recursive method to provide ClassicVRML string serialization.
    
    Specified by:
    
    toStringClassicVRML in class X3DConcreteElement
    
    Parameters:
    
    indentLevel - number of levels of indentation for this element
    
    Returns:
    
    ClassicVRML string
    
    See Also:
    
    X3DObject.FILE_EXTENSION_CLASSICVRML, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
  - toStringVRML97
```
public java.lang.String toStringVRML97(int indentLevel)
```
    Recursive method to provide VRML97 string serialization.
    
    Specified by:
    
    toStringVRML97 in class X3DConcreteElement
    
    Parameters:
    
    indentLevel - number of levels of indentation for this element
    
    Returns:
    
    VRML97 string
    
    See Also:
    
    X3DObject.FILE_EXTENSION_VRML97, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
  - findElementByNameValue
```
public X3DConcreteElement findElementByNameValue(java.lang.String nameValue)
```
    Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
    
    Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
    
    Warning: more than one element may be found that has the same name, this method does not handle that case.
    
    Specified by:
    
    findElementByNameValue in class X3DConcreteElement
    
    Parameters:
    
    nameValue - is value of the name field being searched for in this element and child elements(if any)
    
    Returns:
    
    object reference to found element, null otherwise
    
    See Also:
    
    findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
  - findElementByNameValue
```
public X3DConcreteElement findElementByNameValue(java.lang.String nameValue,
                                                 java.lang.String elementName)
```
    Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
    
    Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
    
    Warning: more than one element may be found that has the same name, this method does not handle that case.
    
    Specified by:
    
    findElementByNameValue in class X3DConcreteElement
    
    Parameters:
    
    nameValue - is value of the name field being searched for in this element and child elements(if any)
    
    elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
    
    Returns:
    
    object reference to found element, null otherwise
    
    See Also:
    
    findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
  - hasElementByNameValue
```
public boolean hasElementByNameValue(java.lang.String nameValue,
                                     java.lang.String elementName)
```
    Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
    
    Parameters:
    
    nameValue - is value of the name field being searched for in this element and child elements(if any)
    
    elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
    
    Returns:
    
    whether node is found
    
    See Also:
    
    findElementByNameValue(String, String)
  - findNodeByDEF
```
public X3DConcreteNode findNodeByDEF(java.lang.String DEFvalue)
```
    Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
    
    Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
    
    Warning: more than one element may be found that has the same DEF, this method does not handle that case.
    
    Specified by:
    
    findNodeByDEF in class X3DConcreteElement
    
    Parameters:
    
    DEFvalue - is value of the name field being searched for in this element and child elements(if any)
    
    Returns:
    
    object reference to found node, null otherwise
    
    See Also:
    
    findElementByNameValue(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
  - hasNodeByDEF
```
public boolean hasNodeByDEF(java.lang.String DEFvalue)
```
    Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
    
    Parameters:
    
    DEFvalue - is value of the name field being searched for in this element and child elements(if any)
    
    Returns:
    
    whether node is found
    
    See Also:
    
    findNodeByDEF(String)
  - validate
```
public java.lang.String validate()
```
    Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.
    
    Specified by:
    
    validate in class X3DConcreteElement
    
    Returns:
    
    validation results (if any)

Class CoordinateDamperObject

Field Summary

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement

Constructor Summary

Method Summary

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement

Methods inherited from class java.lang.Object

Field Detail

NAME

COMPONENT

LEVEL

INITIALDESTINATION_DEFAULT_VALUE

INITIALVALUE_DEFAULT_VALUE

ORDER_DEFAULT_VALUE

TAU_DEFAULT_VALUE

TOLERANCE_DEFAULT_VALUE

containerField_DEFAULT_VALUE

fromField_ISACTIVE

fromField_METADATA

toField_METADATA

toField_SET_DESTINATION

toField_SET_VALUE

fromField_TAU

toField_TAU

fromField_TOLERANCE

toField_TOLERANCE

fromField_VALUE_CHANGED

Constructor Detail

CoordinateDamperObject

CoordinateDamperObject

Method Detail

getElementName

getComponent

getComponentLevel

getFieldType

getAccessType

getContainerFieldDefault

initialize

getInitialDestination

setInitialDestination

setInitialDestination

addInitialDestination

getInitialValue

setInitialValue

setInitialValue

addInitialValue

getIsActive

getMetadata

setMetadata

clearMetadata

setMetadata

hasMetadata

getOrder

setOrder

setOrder

getTau

setTau

setTau

getTolerance

setTolerance

setTolerance

getValue

setDEF

setDEF

setUSE

setUSE

setCssClass

setCssClass

setIS

getIS

setUSE

addComments

addComments

addComments

toStringX3D

toStringClassicVRML

toStringVRML97

findElementByNameValue