org.web3d.x3d.sai.Layering

Interface X3DViewportNode

All Superinterfaces:

X3DBoundedObject, X3DChildNode, X3DGroupingNode, X3DNode

All Known Subinterfaces:

Viewport

All Known Implementing Classes:

ViewportObject

public interface X3DViewportNode
extends X3DGroupingNode

Grouping nodes can contain other nodes as children, thus making up the backbone of a scene graph.


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
void	addChildren(X3DNode[] newValue) Add array of children nodes to array of existing nodes (if any).
float[]	getBboxCenter() Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.
float[]	getBboxSize() Provide array of 3-tuple float results within allowed range of [0,infinity), or default value [-1 -1 -1], from initializeOnly SFVec3f field named bboxSize.
X3DNode[]	getChildren() Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field children.
X3DMetadataObject	getMetadata() Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
X3DViewportNode	setBboxCenter(float[] newValue) Assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
X3DViewportNode	setBboxSize(float[] newValue) Assign 3-tuple float array within allowed range of [0,infinity), or default value [-1 -1 -1], to initializeOnly SFVec3f field named bboxSize.
void	setChildren(X3DNode newValue) Set single children node, replacing prior array of existing nodes (if any).
X3DViewportNode	setChildren(X3DNode[] newValue) Assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field children.
X3DViewportNode	setCssClass(java.lang.String newValue) Assign String value to inputOutput SFString field named class.
X3DViewportNode	setDEF(java.lang.String newValue) Assign String value to inputOutput SFString field named DEF.
X3DViewportNode	setMetadata(X3DMetadataObject newValue) Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
X3DViewportNode	setUSE(java.lang.String newValue) Assign String value to inputOutput SFString field named USE.

Method Detail

getBboxCenter

float[] getBboxCenter()

Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.

Specified by:

getBboxCenter in interface X3DBoundedObject

Specified by:

getBboxCenter in interface X3DGroupingNode

Returns:

value of bboxCenter field

setBboxCenter

X3DViewportNode setBboxCenter(float[] newValue)

Assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.

Specified by:

setBboxCenter in interface X3DBoundedObject

Specified by:

setBboxCenter in interface X3DGroupingNode

Parameters:

newValue - is new value for the bboxCenter field.

Returns:

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

getBboxSize

float[] getBboxSize()

Provide array of 3-tuple float results within allowed range of [0,infinity), or default value [-1 -1 -1], from initializeOnly SFVec3f field named bboxSize.

Specified by:

getBboxSize in interface X3DBoundedObject

Specified by:

getBboxSize in interface X3DGroupingNode

Returns:

value of bboxSize field

setBboxSize

X3DViewportNode setBboxSize(float[] newValue)

Assign 3-tuple float array within allowed range of [0,infinity), or default value [-1 -1 -1], to initializeOnly SFVec3f field named bboxSize.

Specified by:

setBboxSize in interface X3DBoundedObject

Specified by:

setBboxSize in interface X3DGroupingNode

Parameters:

newValue - is new value for the bboxSize field.

Returns:

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

getChildren

X3DNode[] getChildren()

Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field children.

Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode.

Specified by:

getChildren in interface X3DGroupingNode

Returns:

value of children field

See Also:

X3DChildNode

setChildren

X3DViewportNode setChildren(X3DNode[] newValue)

Assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field children.

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode.

Specified by:

setChildren in interface X3DGroupingNode

Parameters:

newValue - is new value for the children field.

Returns:

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

addChildren

void addChildren(X3DNode[] newValue)

Add array of children nodes to array of existing nodes (if any).

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode.

Specified by:

addChildren in interface X3DGroupingNode

Parameters:

newValue - is new value array to be appended the children field.

setChildren

void setChildren(X3DNode newValue)

Set single children node, replacing prior array of existing nodes (if any).

Specified by:

setChildren in interface X3DGroupingNode

Parameters:

newValue - is new node for the children 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 X3DGroupingNode

Specified by:

getMetadata in interface X3DNode

Returns:

value of metadata field

See Also:

X3D Scene Authoring Hints: Metadata Nodes

setMetadata

X3DViewportNode 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 X3DGroupingNode

Specified by:

setMetadata in interface X3DNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

X3DViewportNode 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 X3DGroupingNode

Specified by:

setDEF in interface X3DNode

Parameters:

newValue - is new value for the DEF field.

Returns:

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

setUSE

X3DViewportNode 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 X3DGroupingNode

Specified by:

setUSE in interface X3DNode

Parameters:

newValue - is new value for the USE field.

Returns:

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

setCssClass

X3DViewportNode 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 X3DGroupingNode

Specified by:

setCssClass in interface X3DNode

Parameters:

newValue - is new value for the class field.

Returns:

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