org.web3d.x3d.sai.Core

Interface X3DBindableNode

All Superinterfaces:

X3DChildNode, X3DNode

All Known Subinterfaces:

Background, Fog, GeoViewpoint, NavigationInfo, OrthoViewpoint, TextureBackground, Viewpoint, X3DBackgroundNode, X3DViewpointNode

All Known Implementing Classes:

BackgroundObject, FogObject, GeoViewpointObject, NavigationInfoObject, OrthoViewpointObject, TextureBackgroundObject, ViewpointObject

public interface X3DBindableNode
extends X3DChildNode

Bindable nodes implement the binding stack, so that only one of each node type is active at a given time.


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
double	getBindTime() Provide double value in seconds from outputOnly SFTime field named bindTime.
boolean	getIsBound() Provide boolean value from outputOnly SFBool field named isBound.
X3DMetadataObject	getMetadata() Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
X3DBindableNode	setCssClass(java.lang.String newValue) Assign String value to inputOutput SFString field named class.
X3DBindableNode	setDEF(java.lang.String newValue) Assign String value to inputOutput SFString field named DEF.
X3DBindableNode	setMetadata(X3DMetadataObject newValue) Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
X3DBindableNode	setUSE(java.lang.String newValue) Assign String value to inputOutput SFString field named USE.

Method Detail

getBindTime

double getBindTime()

Provide double value in seconds from outputOnly SFTime field named bindTime.

Returns:

value of bindTime field

getIsBound

boolean getIsBound()

Provide boolean value from outputOnly SFBool field named isBound.

Returns:

value of isBound field

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

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

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

setDEF

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

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

setUSE

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

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

setCssClass

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

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