X3DTimeDependentNode (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DChildNode, X3DNode

All Known Subinterfaces:

AudioClip, MovieTexture, TimeSensor, X3DSoundSourceNode

All Known Implementing Classes:

AudioClipObject, MovieTextureObject, TimeSensorObject
```
public interface X3DTimeDependentNode
extends X3DChildNode
```
Base type from which all time-dependent nodes are derived.

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: TODO, X3D Tooltips, X3D Scene Authoring Hints

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`double`	`getElapsedTime()` Provide double value in seconds within allowed range of [0,infinity) from outputOnly SFTime field named elapsedTime.
`boolean`	`getIsActive()` Provide boolean value from outputOnly SFBool field named isActive.
`boolean`	`getIsPaused()` Provide boolean value from outputOnly SFBool field named isPaused.
`boolean`	`getLoop()` Provide boolean value from inputOutput SFBool field named loop.
`X3DMetadataObject`	`getMetadata()` Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`double`	`getPauseTime()` Provide double value in seconds from inputOutput SFTime field named pauseTime.
`double`	`getResumeTime()` Provide double value in seconds from inputOutput SFTime field named resumeTime.
`double`	`getStartTime()` Provide double value in seconds from inputOutput SFTime field named startTime.
`double`	`getStopTime()` Provide double value in seconds from inputOutput SFTime field named stopTime.
`X3DTimeDependentNode`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`X3DTimeDependentNode`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`X3DTimeDependentNode`	`setLoop(boolean newValue)` Assign boolean value to inputOutput SFBool field named loop.
`X3DTimeDependentNode`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`X3DTimeDependentNode`	`setPauseTime(double newValue)` Assign double value in seconds to inputOutput SFTime field named pauseTime.
`X3DTimeDependentNode`	`setResumeTime(double newValue)` Assign double value in seconds to inputOutput SFTime field named resumeTime.
`X3DTimeDependentNode`	`setStartTime(double newValue)` Assign double value in seconds to inputOutput SFTime field named startTime.
`X3DTimeDependentNode`	`setStopTime(double newValue)` Assign double value in seconds to inputOutput SFTime field named stopTime.
`X3DTimeDependentNode`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - getElapsedTime
```
double getElapsedTime()
```
    Provide double value in seconds within allowed range of [0,infinity) from outputOnly SFTime field named elapsedTime.
    
    Returns:
    
    value of elapsedTime field
  - getIsActive
```
boolean getIsActive()
```
    Provide boolean value from outputOnly SFBool field named isActive.
    
    Returns:
    
    value of isActive field
  - getIsPaused
```
boolean getIsPaused()
```
    Provide boolean value from outputOnly SFBool field named isPaused.
    
    Returns:
    
    value of isPaused field
  - getLoop
```
boolean getLoop()
```
    Provide boolean value from inputOutput SFBool field named loop.
    
    Returns:
    
    value of loop field
  - setLoop
```
X3DTimeDependentNode setLoop(boolean newValue)
```
    Assign boolean value to inputOutput SFBool field named loop.
    
    Parameters:
    
    newValue - is new value for the loop field.
    
    Returns:
    
    X3DTimeDependentNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - 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 X3DNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
X3DTimeDependentNode 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
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    X3DTimeDependentNode - 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
  - getPauseTime
```
double getPauseTime()
```
    Provide double value in seconds from inputOutput SFTime field named pauseTime.
    
    Returns:
    
    value of pauseTime field
  - setPauseTime
```
X3DTimeDependentNode setPauseTime(double newValue)
```
    Assign double value in seconds to inputOutput SFTime field named pauseTime.
    
    Parameters:
    
    newValue - is new value for the pauseTime field.
    
    Returns:
    
    X3DTimeDependentNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getResumeTime
```
double getResumeTime()
```
    Provide double value in seconds from inputOutput SFTime field named resumeTime.
    
    Returns:
    
    value of resumeTime field
  - setResumeTime
```
X3DTimeDependentNode setResumeTime(double newValue)
```
    Assign double value in seconds to inputOutput SFTime field named resumeTime.
    
    Parameters:
    
    newValue - is new value for the resumeTime field.
    
    Returns:
    
    X3DTimeDependentNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getStartTime
```
double getStartTime()
```
    Provide double value in seconds from inputOutput SFTime field named startTime.
    
    Returns:
    
    value of startTime field
  - setStartTime
```
X3DTimeDependentNode setStartTime(double newValue)
```
    Assign double value in seconds to inputOutput SFTime field named startTime.
    
    Parameters:
    
    newValue - is new value for the startTime field.
    
    Returns:
    
    X3DTimeDependentNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getStopTime
```
double getStopTime()
```
    Provide double value in seconds from inputOutput SFTime field named stopTime.
    
    Returns:
    
    value of stopTime field
  - setStopTime
```
X3DTimeDependentNode setStopTime(double newValue)
```
    Assign double value in seconds to inputOutput SFTime field named stopTime.
    
    Parameters:
    
    newValue - is new value for the stopTime field.
    
    Returns:
    
    X3DTimeDependentNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
X3DTimeDependentNode setDEF(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named DEF.
    
    Note that setting the DEF value clears the USE value.
    
    Specified by:
    
    setDEF in interface X3DChildNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    X3DTimeDependentNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
X3DTimeDependentNode setUSE(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named USE.
    
    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
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    X3DTimeDependentNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
X3DTimeDependentNode setCssClass(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named class.
    
    Specified by:
    
    setCssClass in interface X3DChildNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    X3DTimeDependentNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface X3DTimeDependentNode

Method Summary

Method Detail

getElapsedTime

getIsActive

getIsPaused

getLoop

setLoop

getMetadata

setMetadata

getPauseTime

setPauseTime

getResumeTime

setResumeTime

getStartTime

setStartTime

getStopTime

setStopTime

setDEF

setUSE

setCssClass