Package org.web3d.x3d.sai.Time

Interface X3DTimeDependentNode

All Superinterfaces:

X3DChildNode, X3DNode

All Known Subinterfaces:

Analyser, AudioClip, BiquadFilter, BufferAudioSource, Convolver, Delay, DynamicsCompressor, Gain, ListenerPointSource, MicrophoneSource, MovieTexture, OscillatorSource, StreamAudioSource, TimeSensor, WaveShaper, X3DSoundProcessingNode, X3DSoundSourceNode

All Known Implementing Classes:

Analyser, AudioClip, BiquadFilter, BufferAudioSource, Convolver, Delay, DynamicsCompressor, Gain, ListenerPointSource, MicrophoneSource, MovieTexture, OscillatorSource, StreamAudioSource, TimeSensor, WaveShaper

public interface X3DTimeDependentNode
extends X3DChildNode

Base type from which all time-dependent nodes are derived.

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.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).

See Also:

• SAI Java Specification
• X3D Abstract Specification
• X3D Tooltips
• X3D Scene Authoring Hints

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Provide String value from inputOutput SFString field named 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.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.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	setDescription(String newValue)	Accessor method to assign String value to inputOutput SFString field named description.
X3DTimeDependentNode	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
X3DTimeDependentNode	setPauseTime(double newValue)	Accessor method to assign double value in seconds to inputOutput SFTime field named pauseTime.
X3DTimeDependentNode	setResumeTime(double newValue)	Accessor method to assign double value in seconds to inputOutput SFTime field named resumeTime.
X3DTimeDependentNode	setStartTime(double newValue)	Accessor method to assign double value in seconds to inputOutput SFTime field named startTime.
X3DTimeDependentNode	setStopTime(double newValue)	Accessor method to assign double value in seconds to inputOutput SFTime field named stopTime.

Method Details

getDescription

String getDescription()

Provide String value from inputOutput SFString field named description.

Returns:

value of description field

setDescription

X3DTimeDependentNode setDescription(String newValue)

Accessor method to assign String value to inputOutput SFString field named description.

Parameters:

newValue - is new value for the description field.

Returns:

X3DTimeDependentNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

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

getMetadata

X3DMetadataObject getMetadata()

Provide org.web3d.x3d.sai.Core.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)

Accessor method to assign org.web3d.x3d.sai.Core.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)

Accessor method to 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)

Accessor method to 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)

Accessor method to 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)

Accessor method to 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).