org.web3d.x3d.sai.EventUtilities

Interface X3DSequencerNode

All Superinterfaces:

X3DChildNode, X3DNode

All Known Subinterfaces:

BooleanSequencer, IntegerSequencer

All Known Implementing Classes:

BooleanSequencerObject, IntegerSequencerObject

public interface X3DSequencerNode
extends X3DChildNode

Base type from which all Sequencers 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

Modifier and Type	Method and Description
float[]	getKey() Provide array of float results from inputOutput MFFloat field named key.
X3DMetadataObject	getMetadata() Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
X3DSequencerNode	setCssClass(java.lang.String newValue) Assign String value to inputOutput SFString field named class.
X3DSequencerNode	setDEF(java.lang.String newValue) Assign String value to inputOutput SFString field named DEF.
X3DSequencerNode	setKey(float[] newValue) Assign float array to inputOutput MFFloat field named key.
X3DSequencerNode	setMetadata(X3DMetadataObject newValue) Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
X3DSequencerNode	setNext(boolean newValue) Assign boolean value to inputOnly SFBool field named next.
X3DSequencerNode	setPrevious(boolean newValue) Assign boolean value to inputOnly SFBool field named previous.
X3DSequencerNode	setUSE(java.lang.String newValue) Assign String value to inputOutput SFString field named USE.

Method Detail

getKey

float[] getKey()

Provide array of float results from inputOutput MFFloat field named key.

Returns:

value of key field

setKey

X3DSequencerNode setKey(float[] newValue)

Assign float array to inputOutput MFFloat field named key.

Parameters:

newValue - is new value for the key field.

Returns:

X3DSequencerNode - 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

X3DSequencerNode 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:

X3DSequencerNode - 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

setNext

X3DSequencerNode setNext(boolean newValue)

Assign boolean value to inputOnly SFBool field named next.

Parameters:

newValue - is new value for the next field.

Returns:

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

setPrevious

X3DSequencerNode setPrevious(boolean newValue)

Assign boolean value to inputOnly SFBool field named previous.

Parameters:

newValue - is new value for the previous field.

Returns:

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

setDEF

X3DSequencerNode 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:

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

setUSE

X3DSequencerNode 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:

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

setCssClass

X3DSequencerNode 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:

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