Interface IsoSurfaceVolumeData

All Superinterfaces:
X3DBoundedObject, X3DChildNode, X3DNode, X3DVolumeDataNode
All Known Implementing Classes:
IsoSurfaceVolumeDataObject

public interface IsoSurfaceVolumeData
extends X3DVolumeDataNode
IsoSurfaceVolumeData displays one or more surfaces extracted from a voxel dataset.

X3D node tooltip: (X3D version 3.3 or later) [X3DVolumeDataNode] IsoSurfaceVolumeData displays one or more surfaces extracted from a voxel dataset. A surface is defined as the boundary between regions in the volume where the voxel values are larger than a given value (the iso value) on one side of the boundary and smaller on the other side, and the gradient magnitude is larger than surfaceTolerance.
  • Hint: IsoSurfaceVolumeData can contain a single Texture3D node with containerField='gradients' that is used to provide explicit per-voxel gradient direction information for determining surface boundaries, rather than having values implicitly calculated by the implementation.
  • Hint: IsoSurfaceVolumeData can contain another Texture3D node with containerField='voxels' containing voxel data.
  • Hint: IsoSurfaceVolumeData can contain multiple VolumeStyle nodes.
  • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.

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: IsoSurfaceVolumeData, X3D Tooltips: IsoSurfaceVolumeData, 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 getContourStepSize()
    Provide float value from inputOutput SFFloat field named contourStepSize.
    float[] getDimensions()
    Provide array of 3-tuple float results within allowed range of (0,infinity) from inputOutput SFVec3f field named dimensions.
    X3DTexture3DNode getGradients()
    Provide X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field gradients.
    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.
    float getSurfaceTolerance()
    Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named surfaceTolerance.
    float[] getSurfaceValues()
    Provide array of float results from inputOutput MFFloat field named surfaceValues.
    X3DTexture3DNode getVoxels()
    Provide X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field voxels.
    IsoSurfaceVolumeData setBboxCenter​(float[] newValue)
    Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
    IsoSurfaceVolumeData setBboxSize​(float[] newValue)
    Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.
    IsoSurfaceVolumeData setContourStepSize​(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named contourStepSize.
    IsoSurfaceVolumeData setDimensions​(float[] newValue)
    Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named dimensions.
    IsoSurfaceVolumeData setGradients​(X3DTexture3DNode newValue)
    Accessor method to assign X3DTexture3DNode instance (using a properly typed node) to inputOutput SFNode field gradients.
    IsoSurfaceVolumeData 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).
    IsoSurfaceVolumeData setRenderStyle​(X3DNode[] newValue)
    Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field renderStyle.
    IsoSurfaceVolumeData setSurfaceTolerance​(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named surfaceTolerance.
    IsoSurfaceVolumeData setSurfaceValues​(float[] newValue)
    Accessor method to assign float array to inputOutput MFFloat field named surfaceValues.
    IsoSurfaceVolumeData 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

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

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

      float getContourStepSize()
      Provide float value from inputOutput SFFloat field named contourStepSize.

      Tooltip: If contourStepSize is non-zero, also render all isosurfaces that are multiples of that step size from initial surface value.
      • Hint: contourStepSize can be negative so that steppping can proceed in a negative direction.
      Returns:
      value of contourStepSize field
    • setContourStepSize

      IsoSurfaceVolumeData setContourStepSize​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named contourStepSize.

      Tooltip: If contourStepSize is non-zero, also render all isosurfaces that are multiples of that step size from initial surface value.
      • Hint: contourStepSize can be negative so that steppping can proceed in a negative direction.
      Parameters:
      newValue - is new value for the contourStepSize field.
      Returns:
      IsoSurfaceVolumeData - 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

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

      X3DTexture3DNode getGradients()
      Provide X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field gradients.

      Tooltip: [X3DTexture3DNode] Single contained X3DTexture3DNode (ComposedTexture3D, ImageTexture3D, PixelTexture3D) that provides explicit per-voxel gradient direction information for determining surface boundaries, rather than having it implicitly calculated by the implementation. *
      Returns:
      value of gradients field
    • setGradients

      IsoSurfaceVolumeData setGradients​(X3DTexture3DNode newValue)
      Accessor method to assign X3DTexture3DNode instance (using a properly typed node) to inputOutput SFNode field gradients.

      Tooltip: [X3DTexture3DNode] Single contained X3DTexture3DNode (ComposedTexture3D, ImageTexture3D, PixelTexture3D) that provides explicit per-voxel gradient direction information for determining surface boundaries, rather than having it implicitly calculated by the implementation. *
      Parameters:
      newValue - is new value for the gradients field.
      Returns:
      IsoSurfaceVolumeData - 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

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

      IsoSurfaceVolumeData 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:
      IsoSurfaceVolumeData - 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
    • getSurfaceTolerance

      float getSurfaceTolerance()
      Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named surfaceTolerance.

      Tooltip: [0,+infinity) Threshold for gradient magnitude for voxel inolusion in isosurface.
      • Hint: contained Texture3D node with containerField='gradients' can provide explicit per-voxel gradient direction information for determining surface boundaries.
      Returns:
      value of surfaceTolerance field
    • setSurfaceTolerance

      IsoSurfaceVolumeData setSurfaceTolerance​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named surfaceTolerance.

      Tooltip: [0,+infinity) Threshold for gradient magnitude for voxel inolusion in isosurface.
      • Hint: contained Texture3D node with containerField='gradients' can provide explicit per-voxel gradient direction information for determining surface boundaries.
      Parameters:
      newValue - is new value for the surfaceTolerance field.
      Returns:
      IsoSurfaceVolumeData - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getSurfaceValues

      float[] getSurfaceValues()
      Provide array of float results from inputOutput MFFloat field named surfaceValues.

      Tooltip: If surfaceValues has one value defined, render corresponding isosurface plus any isosurfaces based on contourStepSize. If surfaceValues has more than one value defined, ignore contourStepSize and render surfaces corresponding to listed surfaceValues. *
      Returns:
      value of surfaceValues field
    • setSurfaceValues

      IsoSurfaceVolumeData setSurfaceValues​(float[] newValue)
      Accessor method to assign float array to inputOutput MFFloat field named surfaceValues.

      Tooltip: If surfaceValues has one value defined, render corresponding isosurface plus any isosurfaces based on contourStepSize. If surfaceValues has more than one value defined, ignore contourStepSize and render surfaces corresponding to listed surfaceValues. *
      Parameters:
      newValue - is new value for the surfaceValues field.
      Returns:
      IsoSurfaceVolumeData - 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

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