Interface VolumeData
- All Superinterfaces:
X3DBoundedObject,X3DChildNode,X3DNode,X3DVolumeDataNode
- All Known Implementing Classes:
VolumeDataObject
public interface VolumeData extends X3DVolumeDataNode
VolumeData displays a simple non-segmented voxel dataset with a single RenderStyle node.
X3D node tooltip: (X3D version 3.3 or later) [X3DVolumeDataNode] VolumeData displays a simple non-segmented voxel dataset with a single RenderStyle node.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
X3D node tooltip: (X3D version 3.3 or later) [X3DVolumeDataNode] VolumeData displays a simple non-segmented voxel dataset with a single RenderStyle node.
- Hint: VolumeData can contain a single Texture3D node with containerField='voxels' and a single RenderStyle node.
- Warning: requires X3D profile='Full' or else include <component name='VolumeRendering' level='1'/>
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
-
Method Summary
Modifier and Type Method Description 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.float[]getDimensions()Provide array of 3-tuple float results within allowed range of (0,infinity) from inputOutput SFVec3f field named dimensions.booleangetDisplayBBox()Provide boolean value from inputOutput SFBool field named displayBBox.X3DMetadataObjectgetMetadata()Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.X3DVolumeRenderStyleNodegetRenderStyle()Provide X3DVolumeRenderStyleNode instance (using a properly typed node) from inputOutput SFNode field renderStyle.booleangetVisible()Provide boolean value from inputOutput SFBool field named visible.X3DTexture3DNodegetVoxels()Provide X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field voxels.VolumeDatasetBboxCenter(float[] newValue)Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.VolumeDatasetBboxSize(float[] newValue)Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.VolumeDatasetDimensions(float[] newValue)Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named dimensions.VolumeDatasetDisplayBBox(boolean newValue)Accessor method to assign boolean value to inputOutput SFBool field named displayBBox.VolumeDatasetMetadata(X3DMetadataObject newValue)Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.VolumeDatasetRenderStyle(X3DVolumeRenderStyleNode newValue)Accessor method to assign X3DVolumeRenderStyleNode instance (using a properly typed node) to inputOutput SFNode field renderStyle.VolumeDatasetVisible(boolean newValue)Accessor method to assign boolean value to inputOutput SFBool field named visible.VolumeDatasetVoxels(X3DTexture3DNode newValue)Accessor method to assign X3DTexture3DNode instance (using a properly typed node) to inputOutput SFNode field voxels.
-
Method Details
-
getBboxCenter
float[] getBboxCenter()Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.
Tooltip: Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system.- Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
- Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
- Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
- Specified by:
getBboxCenterin interfaceX3DBoundedObject- Specified by:
getBboxCenterin interfaceX3DVolumeDataNode- Returns:
- value of bboxCenter field
-
setBboxCenter
Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
Tooltip: Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system.- Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
- Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
- Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
- Specified by:
setBboxCenterin interfaceX3DBoundedObject- Specified by:
setBboxCenterin interfaceX3DVolumeDataNode- Parameters:
newValue- is new value for the bboxCenter field.- Returns:
VolumeData- 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.
Tooltip: Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.- Hint: can be useful for collision computations or inverse-kinematics (IK) engines.
- Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
- Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
- Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
- Specified by:
getBboxSizein interfaceX3DBoundedObject- Specified by:
getBboxSizein interfaceX3DVolumeDataNode- Returns:
- value of bboxSize field
-
setBboxSize
Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.
Tooltip: Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.- Hint: can be useful for collision computations or inverse-kinematics (IK) engines.
- Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
- Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
- Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
- Specified by:
setBboxSizein interfaceX3DBoundedObject- Specified by:
setBboxSizein interfaceX3DVolumeDataNode- Parameters:
newValue- is new value for the bboxSize field.- Returns:
VolumeData- 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.
Tooltip: Actual-size X-Y-Z dimensions of volume data in local coordinate system. *- Specified by:
getDimensionsin interfaceX3DVolumeDataNode- Returns:
- value of dimensions field
-
setDimensions
Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named dimensions.
Tooltip: Actual-size X-Y-Z dimensions of volume data in local coordinate system. *- Specified by:
setDimensionsin interfaceX3DVolumeDataNode- Parameters:
newValue- is new value for the dimensions field.- Returns:
VolumeData- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getDisplayBBox
boolean getDisplayBBox()Provide boolean value from inputOutput SFBool field named displayBBox.- Specified by:
getDisplayBBoxin interfaceX3DBoundedObject- Specified by:
getDisplayBBoxin interfaceX3DVolumeDataNode- Returns:
- value of displayBBox field
-
setDisplayBBox
Accessor method to assign boolean value to inputOutput SFBool field named displayBBox.- Specified by:
setDisplayBBoxin interfaceX3DBoundedObject- Specified by:
setDisplayBBoxin interfaceX3DVolumeDataNode- Parameters:
newValue- is new value for the displayBBox field.- Returns:
VolumeData- 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.
Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.- Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
- Specified by:
getMetadatain interfaceX3DChildNode- Specified by:
getMetadatain interfaceX3DNode- Specified by:
getMetadatain interfaceX3DVolumeDataNode- Returns:
- value of metadata field
- See Also:
- X3D Scene Authoring Hints: Metadata Nodes
-
setMetadata
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.- Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
- Specified by:
setMetadatain interfaceX3DChildNode- Specified by:
setMetadatain interfaceX3DNode- Specified by:
setMetadatain interfaceX3DVolumeDataNode- Parameters:
newValue- is new value for the metadata field.- Returns:
VolumeData- 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
-
getRenderStyle
X3DVolumeRenderStyleNode getRenderStyle()Provide X3DVolumeRenderStyleNode instance (using a properly typed node) from inputOutput SFNode field renderStyle.
Tooltip: [X3DVolumeRenderStyleNode] Single contained X3DVolumeRenderStyleNode node that defines specific rendering technique for this volumetric object. If field is not defined, default is OpacityMapVolumeStyle node. *- Returns:
- value of renderStyle field
-
setRenderStyle
Accessor method to assign X3DVolumeRenderStyleNode instance (using a properly typed node) to inputOutput SFNode field renderStyle.
Tooltip: [X3DVolumeRenderStyleNode] Single contained X3DVolumeRenderStyleNode node that defines specific rendering technique for this volumetric object. If field is not defined, default is OpacityMapVolumeStyle node. *- Parameters:
newValue- is new value for the renderStyle field.- Returns:
VolumeData- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getVisible
boolean getVisible()Provide boolean value from inputOutput SFBool field named visible.- Specified by:
getVisiblein interfaceX3DBoundedObject- Specified by:
getVisiblein interfaceX3DVolumeDataNode- Returns:
- value of visible field
-
setVisible
Accessor method to assign boolean value to inputOutput SFBool field named visible.- Specified by:
setVisiblein interfaceX3DBoundedObject- Specified by:
setVisiblein interfaceX3DVolumeDataNode- Parameters:
newValue- is new value for the visible field.- Returns:
VolumeData- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getVoxels
X3DTexture3DNode getVoxels()Provide X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field voxels.
Tooltip: [X3DTexture3DNode] Single contained X3DTexture3DNode (ComposedTexture3D, ImageTexture3D, PixelTexture3D) that provides raw voxel information utilized by corresponding rendering styles. Any number of color components (1-4) may be defined. *- Returns:
- value of voxels field
-
setVoxels
Accessor method to assign X3DTexture3DNode instance (using a properly typed node) to inputOutput SFNode field voxels.
Tooltip: [X3DTexture3DNode] Single contained X3DTexture3DNode (ComposedTexture3D, ImageTexture3D, PixelTexture3D) that provides raw voxel information utilized by corresponding rendering styles. Any number of color components (1-4) may be defined. *- Parameters:
newValue- is new value for the voxels field.- Returns:
VolumeData- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-