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.
  • Hint: VolumeData can contain a single Texture3D node with containerField='voxels' and a single RenderStyle node.

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: VolumeData, X3D Tooltips: VolumeData, 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.
    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.
    X3DVolumeRenderStyleNode getRenderStyle()
    Provide X3DVolumeRenderStyleNode instance (using a properly typed node) from inputOutput SFNode field renderStyle.
    X3DTexture3DNode getVoxels()
    Provide X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field voxels.
    VolumeData setBboxCenter​(float[] newValue)
    Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
    VolumeData setBboxSize​(float[] newValue)
    Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.
    VolumeData setDimensions​(float[] newValue)
    Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named dimensions.
    VolumeData setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    VolumeData setRenderStyle​(X3DVolumeRenderStyleNode newValue)
    Accessor method to assign X3DVolumeRenderStyleNode instance (using a properly typed node) to inputOutput SFNode field renderStyle.
    VolumeData 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.
      Specified by:
      getBboxCenter in interface X3DBoundedObject
      Specified by:
      getBboxCenter in interface X3DVolumeDataNode
      Returns:
      value of bboxCenter field
    • setBboxCenter

      VolumeData 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.
      Specified by:
      setBboxCenter in interface X3DBoundedObject
      Specified by:
      setBboxCenter in interface X3DVolumeDataNode
      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.
      Specified by:
      getBboxSize in interface X3DBoundedObject
      Specified by:
      getBboxSize in interface X3DVolumeDataNode
      Returns:
      value of bboxSize field
    • setBboxSize

      VolumeData 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.
      Specified by:
      setBboxSize in interface X3DBoundedObject
      Specified by:
      setBboxSize in interface X3DVolumeDataNode
      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:
      getDimensions in interface X3DVolumeDataNode
      Returns:
      value of dimensions field
    • setDimensions

      VolumeData 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:
      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.
      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

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

      VolumeData setRenderStyle​(X3DVolumeRenderStyleNode newValue)
      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).
    • 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

      VolumeData 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:
      VolumeData - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).