SegmentedVolumeData (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DBoundedObject, X3DChildNode, X3DNode, X3DVolumeDataNode

All Known Implementing Classes:

SegmentedVolumeDataObject
```
public interface SegmentedVolumeData
extends X3DVolumeDataNode
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

X3D node tooltip: (X3D version 3.3 or later) [X3DVolumeDataNode] SegmentedVolumeData displays a segmented voxel dataset with different RenderStyle nodes.
- Hint: SegmentedVolumeData can contain a single ComposedTexture3D, ImageTexture3D or PixelTexture3D node with containerField='segmentIdentifiers' and another with containerField='voxels'.
- Hint: SegmentedVolumeData can contain multiple RenderStyle nodes.
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: SegmentedVolumeData, X3D Tooltips: SegmentedVolumeData, X3D Scene Authoring Hints: Volume

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addRenderStyle(X3DNode[] newValue)` Add array of child renderStyle 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.
`float[]`	`getDimensions()` Provide array of 3-tuple float results within allowed range of (0,infinity) from inputOutput SFVec3f field named dimensions.
`X3DMetadataObject`	`getMetadata()` Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`X3DNode[]`	`getRenderStyle()` Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field renderStyle.
`boolean[]`	`getSegmentEnabled()` Provide array of boolean results from inputOutput MFBool field named segmentEnabled.
`X3DTexture3DNode`	`getSegmentIdentifiers()` Provide X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field segmentIdentifiers.
`X3DTexture3DNode`	`getVoxels()` Provide X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field voxels.
`SegmentedVolumeData`	`setBboxCenter(float[] newValue)` Assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
`SegmentedVolumeData`	`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.
`SegmentedVolumeData`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`SegmentedVolumeData`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`SegmentedVolumeData`	`setDimensions(float[] newValue)` Assign 3-tuple float array within allowed range of (0,infinity) to inputOutput SFVec3f field named dimensions.
`SegmentedVolumeData`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`void`	`setRenderStyle(X3DNode newValue)` Set single child renderStyle node, replacing prior array of existing nodes (if any).
`SegmentedVolumeData`	`setRenderStyle(X3DNode[] newValue)` Assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field renderStyle.
`SegmentedVolumeData`	`setSegmentEnabled(boolean[] newValue)` Assign boolean array to inputOutput MFBool field named segmentEnabled.
`SegmentedVolumeData`	`setSegmentIdentifiers(X3DTexture3DNode newValue)` Assign X3DTexture3DNode instance (using a properly typed node) to inputOutput SFNode field segmentIdentifiers.
`SegmentedVolumeData`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.
`SegmentedVolumeData`	`setVoxels(X3DTexture3DNode newValue)` Assign X3DTexture3DNode instance (using a properly typed node) to inputOutput SFNode field voxels.

- Method Detail
  - 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
      http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
    Specified by:
    
    getBboxCenter in interface X3DBoundedObject
    
    Specified by:
    
    getBboxCenter in interface X3DVolumeDataNode
    
    Returns:
    
    value of bboxCenter field
  - setBboxCenter
```
SegmentedVolumeData setBboxCenter(float[] newValue)
```
    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 http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
    
    Specified by:
    
    setBboxCenter in interface X3DBoundedObject
    
    Specified by:
    
    setBboxCenter in interface X3DVolumeDataNode
    
    Parameters:
    
    newValue - is new value for the bboxCenter field.
    
    Returns:
    
    SegmentedVolumeData - 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
      http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
    Specified by:
    
    getBboxSize in interface X3DBoundedObject
    
    Specified by:
    
    getBboxSize in interface X3DVolumeDataNode
    
    Returns:
    
    value of bboxSize field
  - setBboxSize
```
SegmentedVolumeData 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.
    
    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 http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
    
    Specified by:
    
    setBboxSize in interface X3DBoundedObject
    
    Specified by:
    
    setBboxSize in interface X3DVolumeDataNode
    
    Parameters:
    
    newValue - is new value for the bboxSize field.
    
    Returns:
    
    SegmentedVolumeData - 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:
    
    getDimensions in interface X3DVolumeDataNode
    
    Returns:
    
    value of dimensions field
  - setDimensions
```
SegmentedVolumeData setDimensions(float[] newValue)
```
    Assign 3-tuple float array within allowed range of (0,infinity) to inputOutput SFVec3f field named dimensions.
    
    Tooltip: Actual-size X-Y-Z dimensions of volume data in local coordinate system.
    
    Specified by:
    
    setDimensions in interface X3DVolumeDataNode
    
    Parameters:
    
    newValue - is new value for the dimensions field.
    
    Returns:
    
    SegmentedVolumeData - 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 X3DChildNode
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Specified by:
    
    getMetadata in interface X3DVolumeDataNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
SegmentedVolumeData 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 X3DNode
    
    Specified by:
    
    setMetadata in interface X3DVolumeDataNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    SegmentedVolumeData - 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
```
X3DNode[] getRenderStyle()
```
    Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field renderStyle.
    
    Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DVolumeRenderStyleNode.
    
    Returns:
    
    value of renderStyle field
    
    See Also:
    
    X3DVolumeRenderStyleNode
  - setRenderStyle
```
SegmentedVolumeData setRenderStyle(X3DNode[] newValue)
```
    Assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field renderStyle.
    
    Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DVolumeRenderStyleNode.
    
    Parameters:
    
    newValue - is new value for the renderStyle field.
    
    Returns:
    
    SegmentedVolumeData - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - addRenderStyle
```
void addRenderStyle(X3DNode[] newValue)
```
    Add array of child renderStyle nodes to array of existing nodes (if any).
    
    Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DVolumeRenderStyleNode.
    
    Parameters:
    
    newValue - is new value array to be appended the renderStyle field.
  - setRenderStyle
```
void setRenderStyle(X3DNode newValue)
```
    Set single child renderStyle node, replacing prior array of existing nodes (if any).
    
    Parameters:
    
    newValue - is new node for the renderStyle field
  - getSegmentEnabled
```
boolean[] getSegmentEnabled()
```
    Provide array of boolean results from inputOutput MFBool field named segmentEnabled.
    
    Returns:
    
    value of segmentEnabled field
  - setSegmentEnabled
```
SegmentedVolumeData setSegmentEnabled(boolean[] newValue)
```
    Assign boolean array to inputOutput MFBool field named segmentEnabled.
    
    Parameters:
    
    newValue - is new value for the segmentEnabled field.
    
    Returns:
    
    SegmentedVolumeData - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getSegmentIdentifiers
```
X3DTexture3DNode getSegmentIdentifiers()
```
    Provide X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field segmentIdentifiers.
    
    Returns:
    
    value of segmentIdentifiers field
  - setSegmentIdentifiers
```
SegmentedVolumeData setSegmentIdentifiers(X3DTexture3DNode newValue)
```
    Assign X3DTexture3DNode instance (using a properly typed node) to inputOutput SFNode field segmentIdentifiers.
    
    Parameters:
    
    newValue - is new value for the segmentIdentifiers field.
    
    Returns:
    
    SegmentedVolumeData - 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.
    
    Returns:
    
    value of voxels field
  - setVoxels
```
SegmentedVolumeData setVoxels(X3DTexture3DNode newValue)
```
    Assign X3DTexture3DNode instance (using a properly typed node) to inputOutput SFNode field voxels.
    
    Parameters:
    
    newValue - is new value for the voxels field.
    
    Returns:
    
    SegmentedVolumeData - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
SegmentedVolumeData setDEF(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named DEF.
    
    Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
    
    Note that setting the DEF value clears the USE value.
    
    Specified by:
    
    setDEF in interface X3DChildNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Specified by:
    
    setDEF in interface X3DVolumeDataNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    SegmentedVolumeData - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
SegmentedVolumeData setUSE(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named USE.
    
    Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value). Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance. Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute. Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
    
    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 X3DNode
    
    Specified by:
    
    setUSE in interface X3DVolumeDataNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    SegmentedVolumeData - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
SegmentedVolumeData setCssClass(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named class.
    
    Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets. Warning: currently the class attribute is only supported in XML encoding of X3D scenes. Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
    
    Specified by:
    
    setCssClass in interface X3DChildNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Specified by:
    
    setCssClass in interface X3DVolumeDataNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    SegmentedVolumeData - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface SegmentedVolumeData

Method Summary

Method Detail

getBboxCenter

setBboxCenter

getBboxSize

setBboxSize

getDimensions

setDimensions

getMetadata

setMetadata

getRenderStyle

setRenderStyle

addRenderStyle

setRenderStyle

getSegmentEnabled

setSegmentEnabled

getSegmentIdentifiers

setSegmentIdentifiers

getVoxels

setVoxels

setDEF

setUSE

setCssClass