Package org.web3d.x3d.sai.Scripting

Interface X3DScriptNode

All Superinterfaces:

X3DChildNode, X3DNode, X3DUrlObject

All Known Subinterfaces:

Script

All Known Implementing Classes:

Script

public interface X3DScriptNode
extends X3DChildNode, X3DUrlObject

Base type for scripting nodes (but not shader nodes).

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
double	getAutoRefresh()	Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named autoRefresh.
double	getAutoRefreshTimeLimit()	Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named autoRefreshTimeLimit.
String	getDescription()	Provide String value from inputOutput SFString field named description.
boolean	getLoad()	Provide boolean value from inputOutput SFBool field named load.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
String[]	getUrl()	Provide array of String results from inputOutput MFString field named url.
X3DScriptNode	setAutoRefresh(double newValue)	Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefresh.
X3DScriptNode	setAutoRefreshTimeLimit(double newValue)	Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefreshTimeLimit.
X3DScriptNode	setDescription(String newValue)	Accessor method to assign String value to inputOutput SFString field named description.
X3DScriptNode	setLoad(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named load.
X3DScriptNode	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
X3DScriptNode	setUrl(String[] newValue)	Accessor method to assign String array to inputOutput MFString field named url.

Method Details

getAutoRefresh

double getAutoRefresh()

Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named autoRefresh.

Specified by:

getAutoRefresh in interface X3DUrlObject

Returns:

value of autoRefresh field

setAutoRefresh

X3DScriptNode setAutoRefresh(double newValue)

Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefresh.

Specified by:

setAutoRefresh in interface X3DUrlObject

Parameters:

newValue - is new value for the autoRefresh field.

Returns:

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

getAutoRefreshTimeLimit

double getAutoRefreshTimeLimit()

Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named autoRefreshTimeLimit.

Specified by:

getAutoRefreshTimeLimit in interface X3DUrlObject

Returns:

value of autoRefreshTimeLimit field

setAutoRefreshTimeLimit

X3DScriptNode setAutoRefreshTimeLimit(double newValue)

Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefreshTimeLimit.

Specified by:

setAutoRefreshTimeLimit in interface X3DUrlObject

Parameters:

newValue - is new value for the autoRefreshTimeLimit field.

Returns:

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

getDescription

String getDescription()

Provide String value from inputOutput SFString field named description.

Specified by:

getDescription in interface X3DUrlObject

Returns:

value of description field

setDescription

X3DScriptNode setDescription(String newValue)

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

Specified by:

setDescription in interface X3DUrlObject

Parameters:

newValue - is new value for the description field.

Returns:

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

getLoad

boolean getLoad()

Provide boolean value from inputOutput SFBool field named load.

Specified by:

getLoad in interface X3DUrlObject

Returns:

value of load field

setLoad

X3DScriptNode setLoad(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named load.

Specified by:

setLoad in interface X3DUrlObject

Parameters:

newValue - is new value for the load field.

Returns:

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

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

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

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

getUrl

String[] getUrl()

Provide array of String results from inputOutput MFString field named url.

Specified by:

getUrl in interface X3DUrlObject

Returns:

value of url field

setUrl

X3DScriptNode setUrl(String[] newValue)

Accessor method to assign String array to inputOutput MFString field named url.

Specified by:

setUrl in interface X3DUrlObject

Parameters:

newValue - is new value for the url field.

Returns:

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