org.web3d.x3d.sai.Layering

Interface X3DLayerNode

All Superinterfaces:

X3DNode

All Known Subinterfaces:

Layer, LayoutLayer

All Known Implementing Classes:

LayerObject, LayoutLayerObject

public interface X3DLayerNode
extends X3DNode

Abstract node interface, defined by X3D specification to support X3D Java interoperability.


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
boolean	getIsPickable() Provide boolean value from inputOutput SFBool field named isPickable.
X3DMetadataObject	getMetadata() Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
X3DViewportNode	getViewport() Provide X3DViewportNode instance (using a properly typed node) from inputOutput SFNode field viewport.
X3DLayerNode	setCssClass(java.lang.String newValue) Assign String value to inputOutput SFString field named class.
X3DLayerNode	setDEF(java.lang.String newValue) Assign String value to inputOutput SFString field named DEF.
X3DLayerNode	setIsPickable(boolean newValue) Assign boolean value to inputOutput SFBool field named isPickable.
X3DLayerNode	setMetadata(X3DMetadataObject newValue) Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
X3DLayerNode	setUSE(java.lang.String newValue) Assign String value to inputOutput SFString field named USE.
X3DLayerNode	setViewport(X3DViewportNode newValue) Assign X3DViewportNode instance (using a properly typed node) to inputOutput SFNode field viewport.

Method Detail

getIsPickable

boolean getIsPickable()

Provide boolean value from inputOutput SFBool field named isPickable.

Returns:

value of isPickable field

setIsPickable

X3DLayerNode setIsPickable(boolean newValue)

Assign boolean value to inputOutput SFBool field named isPickable.

Parameters:

newValue - is new value for the isPickable field.

Returns:

X3DLayerNode - 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 X3DNode

Returns:

value of metadata field

See Also:

X3D Scene Authoring Hints: Metadata Nodes

setMetadata

X3DLayerNode setMetadata(X3DMetadataObject newValue)

Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

Specified by:

setMetadata in interface X3DNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

getViewport

X3DViewportNode getViewport()

Provide X3DViewportNode instance (using a properly typed node) from inputOutput SFNode field viewport.

Returns:

value of viewport field

setViewport

X3DLayerNode setViewport(X3DViewportNode newValue)

Assign X3DViewportNode instance (using a properly typed node) to inputOutput SFNode field viewport.

Parameters:

newValue - is new value for the viewport field.

Returns:

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

setDEF

X3DLayerNode 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 X3DNode

Parameters:

newValue - is new value for the DEF field.

Returns:

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

setUSE

X3DLayerNode 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 X3DNode

Parameters:

newValue - is new value for the USE field.

Returns:

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

setCssClass

X3DLayerNode setCssClass(java.lang.String newValue)

Assign String value to inputOutput SFString field named class.

Specified by:

setCssClass in interface X3DNode

Parameters:

newValue - is new value for the class field.

Returns:

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