Package org.web3d.x3d.sai.VolumeRendering

Interface X3DVolumeDataNode

All Superinterfaces:

X3DBoundedObject, X3DChildNode, X3DNode

All Known Subinterfaces:

IsoSurfaceVolumeData, SegmentedVolumeData, VolumeData

All Known Implementing Classes:

IsoSurfaceVolumeData, SegmentedVolumeData, VolumeData

public interface X3DVolumeDataNode
extends X3DChildNode, X3DBoundedObject

The X3DVolumeDataNode abstract node type is the base type for all node types that describe volumetric data to be rendered.

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

Method Summary

Modifier and Type	Method	Description
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.
float[]	getDimensions()	Provide array of 3-tuple float results within allowed range of (0,infinity) from inputOutput SFVec3f field named dimensions.
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.
X3DVolumeDataNode	setBboxCenter(float[] newValue)	Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
X3DVolumeDataNode	setBboxDisplay(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named bboxDisplay.
X3DVolumeDataNode	setBboxSize(float[] newValue)	Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.
X3DVolumeDataNode	setDimensions(float[] newValue)	Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named dimensions.
X3DVolumeDataNode	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
X3DVolumeDataNode	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

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

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

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

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

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

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

getDimensions

float[] getDimensions()

Provide array of 3-tuple float results within allowed range of (0,infinity) from inputOutput SFVec3f field named dimensions.

Returns:

value of dimensions field

setDimensions

X3DVolumeDataNode setDimensions(float[] newValue)

Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named dimensions.

Parameters:

newValue - is new value for the dimensions field.

Returns:

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

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

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

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

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