Package org.web3d.x3d.sai.Grouping

Interface X3DGroupingNode

All Superinterfaces:

X3DBoundedObject, X3DChildNode, X3DNode

All Known Subinterfaces:

Anchor, Billboard, CADAssembly, CADLayer, CADPart, Collision, EspduTransform, GeoLocation, GeoTransform, Group, HAnimSegment, HAnimSite, LayoutGroup, LOD, PickableGroup, ScreenGroup, Switch, Transform, Viewport, X3DViewportNode

All Known Implementing Classes:

Anchor, Billboard, CADAssembly, CADLayer, CADPart, Collision, EspduTransform, GeoLocation, GeoTransform, Group, HAnimSegment, HAnimSite, LayoutGroup, LOD, PickableGroup, ScreenGroup, Switch, Transform, Viewport

public interface X3DGroupingNode
extends X3DChildNode, X3DBoundedObject

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

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
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.
boolean	getBboxDisplay()	Provide boolean value from inputOutput SFBool field named bboxDisplay.
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 org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field children.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
boolean	getVisible()	Provide boolean value from inputOutput SFBool field named visible.
X3DGroupingNode	setBboxCenter(float[] newValue)	Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
X3DGroupingNode	setBboxDisplay(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named bboxDisplay.
X3DGroupingNode	setBboxSize(float[] newValue)	Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.
void	setChildren(X3DNode newValue)	Set single children node, replacing prior array of existing nodes (if any).
X3DGroupingNode	setChildren(X3DNode[] newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field children.
X3DGroupingNode	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
X3DGroupingNode	setVisible(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named visible.

Method Details

getBboxCenter

float[] getBboxCenter()

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

Specified by:

getBboxCenter in interface X3DBoundedObject

Returns:

value of bboxCenter field

setBboxCenter

X3DGroupingNode setBboxCenter(float[] newValue)

Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.

Specified by:

setBboxCenter in interface X3DBoundedObject

Parameters:

newValue - is new value for the bboxCenter field.

Returns:

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

getBboxDisplay

boolean getBboxDisplay()

Provide boolean value from inputOutput SFBool field named bboxDisplay.

Specified by:

getBboxDisplay in interface X3DBoundedObject

Returns:

value of bboxDisplay field

setBboxDisplay

X3DGroupingNode setBboxDisplay(boolean newValue)

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

Specified by:

setBboxDisplay in interface X3DBoundedObject

Parameters:

newValue - is new value for the bboxDisplay field.

Returns:

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

Returns:

value of bboxSize field

setBboxSize

X3DGroupingNode setBboxSize(float[] newValue)

Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.

Specified by:

setBboxSize in interface X3DBoundedObject

Parameters:

newValue - is new value for the bboxSize field.

Returns:

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

getChildren

X3DNode[] getChildren()

Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field children.

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

Returns:

value of children field

See Also:

• X3DChildNode

setChildren

X3DGroupingNode setChildren(X3DNode[] newValue)

Accessor method to assign org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field children.

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

Parameters:

newValue - is new value for the children field.

Returns:

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

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).

Parameters:

newValue - is new node for the children field

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

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

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

getVisible

boolean getVisible()

Provide boolean value from inputOutput SFBool field named visible.

Specified by:

getVisible in interface X3DBoundedObject

Returns:

value of visible field

setVisible

X3DGroupingNode setVisible(boolean newValue)

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

Specified by:

setVisible in interface X3DBoundedObject

Parameters:

newValue - is new value for the visible field.

Returns:

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