All Superinterfaces:: X3DBoundedObject, X3DChildNode, X3DNode, X3DVolumeDataNode

All Known Implementing Classes:: SegmentedVolumeDataObject

public interface SegmentedVolumeData
extends X3DVolumeDataNode

SegmentedVolumeData displays a segmented voxel dataset with different RenderStyle nodes.

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

Modifier and Type	Method	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)`	Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
`SegmentedVolumeData`	`setBboxSize(float[] newValue)`	Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.
`SegmentedVolumeData`	`setDimensions(float[] newValue)`	Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named dimensions.
`SegmentedVolumeData`	`setMetadata(X3DMetadataObject newValue)`	Accessor method to 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)`	Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field renderStyle.
`SegmentedVolumeData`	`setSegmentEnabled(boolean[] newValue)`	Accessor method to assign boolean array to inputOutput MFBool field named segmentEnabled.
`SegmentedVolumeData`	`setSegmentIdentifiers(X3DTexture3DNode newValue)`	Accessor method to assign X3DTexture3DNode instance (using a properly typed node) to inputOutput SFNode field segmentIdentifiers.
`SegmentedVolumeData`	`setVoxels(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 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)
  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 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)
  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 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)
  
  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:
  
  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)
  
  Accessor method to 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.
  
  Tooltip: [X3DVolumeRenderStyleNode] Multiple contained X3DVolumeRenderStyleNode nodes corresponding to each isosurface that define specific rendering technique for this volumetric object.
  
  Hint: Warning: if not defined, no default renderStryle is defined.
  
  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)
  Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field renderStyle.
  
  Tooltip: [X3DVolumeRenderStyleNode] Multiple contained X3DVolumeRenderStyleNode nodes corresponding to each isosurface that define specific rendering technique for this volumetric object.
  
  Hint: Warning: if not defined, no default renderStryle is defined.
  
  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)
  
  Accessor method to 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.
  
  Tooltip: [X3DTexture3DNode] Single contained X3DTexture3DNode (ComposedTexture3D, ImageTexture3D, PixelTexture3D) holds component texture that provides corresponding segment identifier.
  
  Hint: if more than one color component is contained, only initial color component defines the segment identifier.
  
  Warning: if segmentIdentifiers texture is not identical in size to the main voxels, it shall be ignored.
  Returns:
  
  value of segmentIdentifiers field
- setSegmentIdentifiers
  
  SegmentedVolumeData setSegmentIdentifiers(X3DTexture3DNode newValue)
  Accessor method to assign X3DTexture3DNode instance (using a properly typed node) to inputOutput SFNode field segmentIdentifiers.
  
  Tooltip: [X3DTexture3DNode] Single contained X3DTexture3DNode (ComposedTexture3D, ImageTexture3D, PixelTexture3D) holds component texture that provides corresponding segment identifier.
  
  Hint: if more than one color component is contained, only initial color component defines the segment identifier.
  
  Warning: if segmentIdentifiers texture is not identical in size to the main voxels, it shall be ignored.
  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.
  
  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
  
  SegmentedVolumeData setVoxels(X3DTexture3DNode newValue)
  
  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:
  
  SegmentedVolumeData - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface SegmentedVolumeData

Method Summary

Method Details