Class IsoSurfaceVolumeDataObject

  • All Implemented Interfaces:
    X3DChildNode, X3DNode, X3DBoundedObject, IsoSurfaceVolumeData, X3DVolumeDataNode

    public class IsoSurfaceVolumeDataObject
    extends X3DConcreteNode
    implements IsoSurfaceVolumeData
    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 org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
    See Also:
    X3D Abstract Specification: IsoSurfaceVolumeData, X3D Tooltips: IsoSurfaceVolumeData, X3D Scene Authoring Hints: Volume
    • Field Detail

      • NAME

        public static final java.lang.String NAME
        String constant NAME provides name of this element: IsoSurfaceVolumeData.
        See Also:
        Constant Field Values
      • COMPONENT

        public static final java.lang.String COMPONENT
        String constant COMPONENT defines X3D component for the IsoSurfaceVolumeData element: VolumeRendering
        See Also:
        Constant Field Values
      • LEVEL

        public static final int LEVEL
        Integer constant LEVEL provides default X3D VolumeRendering component level for this element: 2
        See Also:
        Constant Field Values
      • BBOXCENTER_DEFAULT_VALUE

        public static final float[] BBOXCENTER_DEFAULT_VALUE
        SFVec3f field named bboxCenter has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
      • BBOXSIZE_DEFAULT_VALUE

        public static final float[] BBOXSIZE_DEFAULT_VALUE
        SFVec3f field named bboxSize has default value {-1f,-1f,-1f} (Java syntax) or -1 -1 -1 (XML syntax).
      • CONTOURSTEPSIZE_DEFAULT_VALUE

        public static final float CONTOURSTEPSIZE_DEFAULT_VALUE
        SFFloat field named contourStepSize has default value 0f (Java syntax) or 0 (XML syntax).
        See Also:
        Constant Field Values
      • DIMENSIONS_DEFAULT_VALUE

        public static final float[] DIMENSIONS_DEFAULT_VALUE
        SFVec3f field named dimensions has default value {1f,1f,1f} (Java syntax) or 1 1 1 (XML syntax).
      • GRADIENTS_DEFAULT_VALUE

        public static final X3DTexture3DNode GRADIENTS_DEFAULT_VALUE
        SFNode field named gradients has default value null (Java syntax) or NULL (XML syntax).
      • IS_DEFAULT_VALUE

        public static final ISObject IS_DEFAULT_VALUE
        SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
      • METADATA_DEFAULT_VALUE

        public static final X3DMetadataObject METADATA_DEFAULT_VALUE
        SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
      • SURFACETOLERANCE_DEFAULT_VALUE

        public static final float SURFACETOLERANCE_DEFAULT_VALUE
        SFFloat field named surfaceTolerance has default value 0f (Java syntax) or 0 (XML syntax).
        See Also:
        Constant Field Values
      • SURFACEVALUES_DEFAULT_VALUE

        public static final java.util.ArrayList<java.lang.Float> SURFACEVALUES_DEFAULT_VALUE
        MFFloat field named surfaceValues has default value equal to an empty list.
      • VOXELS_DEFAULT_VALUE

        public static final X3DTexture3DNode VOXELS_DEFAULT_VALUE
        SFNode field named voxels has default value null (Java syntax) or NULL (XML syntax).
      • fromField_CONTOURSTEPSIZE

        public static final java.lang.String fromField_CONTOURSTEPSIZE
        fromField ROUTE name for SFFloat field named contourStepSize.
        See Also:
        Constant Field Values
      • toField_CONTOURSTEPSIZE

        public static final java.lang.String toField_CONTOURSTEPSIZE
        toField ROUTE name for SFFloat field named contourStepSize.
        See Also:
        Constant Field Values
      • fromField_DIMENSIONS

        public static final java.lang.String fromField_DIMENSIONS
        fromField ROUTE name for SFVec3f field named dimensions.
        See Also:
        Constant Field Values
      • toField_DIMENSIONS

        public static final java.lang.String toField_DIMENSIONS
        toField ROUTE name for SFVec3f field named dimensions.
        See Also:
        Constant Field Values
      • fromField_GRADIENTS

        public static final java.lang.String fromField_GRADIENTS
        fromField ROUTE name for SFNode field named gradients.
        See Also:
        Constant Field Values
      • toField_GRADIENTS

        public static final java.lang.String toField_GRADIENTS
        toField ROUTE name for SFNode field named gradients.
        See Also:
        Constant Field Values
      • fromField_IS

        public static final java.lang.String fromField_IS
        fromField ROUTE name for SFNode field named IS.
        See Also:
        Constant Field Values
      • fromField_METADATA

        public static final java.lang.String fromField_METADATA
        fromField ROUTE name for SFNode field named metadata.
        See Also:
        Constant Field Values
      • toField_METADATA

        public static final java.lang.String toField_METADATA
        toField ROUTE name for SFNode field named metadata.
        See Also:
        Constant Field Values
      • fromField_RENDERSTYLE

        public static final java.lang.String fromField_RENDERSTYLE
        fromField ROUTE name for MFNode field named renderStyle.
        See Also:
        Constant Field Values
      • toField_RENDERSTYLE

        public static final java.lang.String toField_RENDERSTYLE
        toField ROUTE name for MFNode field named renderStyle.
        See Also:
        Constant Field Values
      • fromField_SURFACETOLERANCE

        public static final java.lang.String fromField_SURFACETOLERANCE
        fromField ROUTE name for SFFloat field named surfaceTolerance.
        See Also:
        Constant Field Values
      • toField_SURFACETOLERANCE

        public static final java.lang.String toField_SURFACETOLERANCE
        toField ROUTE name for SFFloat field named surfaceTolerance.
        See Also:
        Constant Field Values
      • fromField_SURFACEVALUES

        public static final java.lang.String fromField_SURFACEVALUES
        fromField ROUTE name for MFFloat field named surfaceValues.
        See Also:
        Constant Field Values
      • toField_SURFACEVALUES

        public static final java.lang.String toField_SURFACEVALUES
        toField ROUTE name for MFFloat field named surfaceValues.
        See Also:
        Constant Field Values
      • fromField_VOXELS

        public static final java.lang.String fromField_VOXELS
        fromField ROUTE name for SFNode field named voxels.
        See Also:
        Constant Field Values
      • toField_VOXELS

        public static final java.lang.String toField_VOXELS
        toField ROUTE name for SFNode field named voxels.
        See Also:
        Constant Field Values
    • Constructor Detail

      • IsoSurfaceVolumeDataObject

        public IsoSurfaceVolumeDataObject()
        Constructor for IsoSurfaceVolumeDataObject to initialize member variables with default values.
      • IsoSurfaceVolumeDataObject

        public IsoSurfaceVolumeDataObject​(java.lang.String DEFlabel)
        Utility constructor that assigns DEF label after initializing member variables with default values.
        Parameters:
        DEFlabel - unique DEF name for this X3D node
    • Method Detail

      • getElementName

        public final java.lang.String getElementName()
        Provides name of this element: IsoSurfaceVolumeData
        Specified by:
        getElementName in class X3DConcreteElement
        Returns:
        name of this element
      • getComponent

        public final java.lang.String getComponent()
        Defines X3D component for the IsoSurfaceVolumeData element: VolumeRendering
        Specified by:
        getComponent in class X3DConcreteElement
        Returns:
        X3D component for this element
      • getComponentLevel

        public final int getComponentLevel()
        Provides default X3D component level for this element: 2
        Specified by:
        getComponentLevel in class X3DConcreteElement
        Returns:
        default X3D component level for this element
      • getFieldType

        public java.lang.String getFieldType​(java.lang.String fieldName)
        Indicate type corresponding to given fieldName.
        Specified by:
        getFieldType in class X3DConcreteElement
        Parameters:
        fieldName - name of field in this X3D node
        Returns:
        X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
        See Also:
        ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
      • getAccessType

        public java.lang.String getAccessType​(java.lang.String fieldName)
        Indicate accessType corresponding to given fieldName.
        Specified by:
        getAccessType in class X3DConcreteElement
        Parameters:
        fieldName - name of field in this X3D node
        Returns:
        X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
        See Also:
        ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
      • initialize

        public final void initialize()
        Initialize all member variables to default values.
        Overrides:
        initialize in class X3DConcreteNode
      • setBboxCenter

        public IsoSurfaceVolumeDataObject setBboxCenter​(float x,
                                                        float y,
                                                        float z)
        Assign values to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
        Parameters:
        x - first component
        y - second component
        z - third component
        Returns:
        IsoSurfaceVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setBboxCenter

        public IsoSurfaceVolumeDataObject setBboxCenter​(double x,
                                                        double y,
                                                        double z)
        Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxCenter(float[]).
        Parameters:
        x - first component
        y - second component
        z - third component
        Returns:
        IsoSurfaceVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setBboxCenter

        public IsoSurfaceVolumeDataObject setBboxCenter​(double[] newArray)
        Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBboxCenter(float[]).
        Parameters:
        newArray - is new value for field
        Returns:
        IsoSurfaceVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getBboxSize

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

        public IsoSurfaceVolumeDataObject 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 IsoSurfaceVolumeData
        Specified by:
        setBboxSize in interface X3DBoundedObject
        Specified by:
        setBboxSize in interface X3DVolumeDataNode
        Parameters:
        newValue - is new value for the bboxSize field.
        Returns:
        IsoSurfaceVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setBboxSize

        public IsoSurfaceVolumeDataObject setBboxSize​(float x,
                                                      float y,
                                                      float z)
        Assign values to SFVec3f bboxSize field, similar to setBboxSize(float[]).
        Parameters:
        x - first component
        y - second component
        z - third component
        Returns:
        IsoSurfaceVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setBboxSize

        public IsoSurfaceVolumeDataObject setBboxSize​(double x,
                                                      double y,
                                                      double z)
        Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxSize(float[]).
        Parameters:
        x - first component
        y - second component
        z - third component
        Returns:
        IsoSurfaceVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setBboxSize

        public IsoSurfaceVolumeDataObject setBboxSize​(double[] newArray)
        Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBboxSize(float[]).
        Parameters:
        newArray - is new value for field
        Returns:
        IsoSurfaceVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getContourStepSize

        public 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.
        Specified by:
        getContourStepSize in interface IsoSurfaceVolumeData
        Returns:
        value of contourStepSize field
      • setContourStepSize

        public IsoSurfaceVolumeDataObject 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.
        Specified by:
        setContourStepSize in interface IsoSurfaceVolumeData
        Parameters:
        newValue - is new value for the contourStepSize field.
        Returns:
        IsoSurfaceVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setContourStepSize

        public IsoSurfaceVolumeDataObject setContourStepSize​(double newValue)
        Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setContourStepSize(float).
        Parameters:
        newValue - is new value for field
        Returns:
        IsoSurfaceVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getDimensions

        public 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 IsoSurfaceVolumeData
        Specified by:
        getDimensions in interface X3DVolumeDataNode
        Returns:
        value of dimensions field
      • setDimensions

        public IsoSurfaceVolumeDataObject 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 IsoSurfaceVolumeData
        Specified by:
        setDimensions in interface X3DVolumeDataNode
        Parameters:
        newValue - is new value for the dimensions field.
        Returns:
        IsoSurfaceVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setDimensions

        public IsoSurfaceVolumeDataObject setDimensions​(float x,
                                                        float y,
                                                        float z)
        Assign values to SFVec3f dimensions field, similar to setDimensions(float[]).
        Parameters:
        x - first component
        y - second component
        z - third component
        Returns:
        IsoSurfaceVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setDimensions

        public IsoSurfaceVolumeDataObject setDimensions​(double x,
                                                        double y,
                                                        double z)
        Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setDimensions(float[]).
        Parameters:
        x - first component
        y - second component
        z - third component
        Returns:
        IsoSurfaceVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setDimensions

        public IsoSurfaceVolumeDataObject setDimensions​(double[] newArray)
        Utility method: double-precision set-array accessor for X3D floating-point type, similar to setDimensions(float[]).
        Parameters:
        newArray - is new value for field
        Returns:
        IsoSurfaceVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getGradients

        public X3DTexture3DNode getGradients()
        Provide X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field gradients.
        Specified by:
        getGradients in interface IsoSurfaceVolumeData
        Returns:
        value of gradients field
        See Also:
        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. *
      • clearGradients

        public IsoSurfaceVolumeDataObject clearGradients()
        Utility method to clear SFNode value of gradients field.
        Returns:
        IsoSurfaceVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • hasGradients

        public boolean hasGradients()
        Indicate whether an object is available for inputOutput SFNode field gradients.
        Returns:
        whether a properly typed node or ProtoInstance or CommentsBlock is available.
        See Also:
        getGradients(), getGradientsProtoInstance()
      • hasIS

        public boolean hasIS()
        Indicate whether an object is available for inputOutput SFNode field IS.
        Returns:
        whether a concrete statement or CommentsBlock is available.
        See Also:
        getIS()
      • clearMetadata

        public IsoSurfaceVolumeDataObject clearMetadata()
        Utility method to clear SFNode value of metadata field.
        Returns:
        IsoSurfaceVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • hasMetadata

        public boolean hasMetadata()
        Indicate whether an object is available for inputOutput SFNode field metadata.
        Returns:
        whether a properly typed node or ProtoInstance or CommentsBlock is available.
        See Also:
        getMetadata(), getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
      • getRenderStyle

        public X3DNode[] getRenderStyle()
        Provide array of X3DVolumeRenderStyleNode 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.
        Specified by:
        getRenderStyle in interface IsoSurfaceVolumeData
        Returns:
        value of renderStyle field
        See Also:
        X3DVolumeRenderStyleNode
      • getRenderStyleList

        public java.util.ArrayList<X3DNode> getRenderStyleList()
        Utility method to get ArrayList value of MFNode renderStyle field, similar to getRenderStyle().
        Returns:
        value of renderStyle field
      • setRenderStyle

        public IsoSurfaceVolumeDataObject setRenderStyle​(X3DNode[] newValue)
        Accessor method to assign X3DVolumeRenderStyleNode 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.
        Specified by:
        setRenderStyle in interface IsoSurfaceVolumeData
        Parameters:
        newValue - is new value for the renderStyle field.
        Returns:
        IsoSurfaceVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addRenderStyle

        public IsoSurfaceVolumeDataObject addRenderStyle​(X3DNode newValue)
        Add single child node to existing array of renderStyle nodes (if any).

        Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DVolumeRenderStyleNode and ProtoInstance.
        Parameters:
        newValue - is new value to be appended the renderStyle field.
        Returns:
        IsoSurfaceVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addRenderStyle

        public IsoSurfaceVolumeDataObject addRenderStyle​(ProtoInstanceObject newValue)
        Add single ProtoInstanceObject (with appropriate node type and containerField value) to MFNode array for renderStyle field.

        Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to ShaderPart and ProtoInstance.
        Parameters:
        newValue - is new value to be appended the parts field.
        Returns:
        IsoSurfaceVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addRenderStyle

        public 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.
        Specified by:
        addRenderStyle in interface IsoSurfaceVolumeData
        Parameters:
        newValue - is new value array to be appended the renderStyle field.
      • setRenderStyle

        public void setRenderStyle​(X3DNode newValue)
        Set single child renderStyle node, replacing prior array of existing nodes (if any).

        Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to X3DVolumeRenderStyleNode.
        Specified by:
        setRenderStyle in interface IsoSurfaceVolumeData
        Parameters:
        newValue - is new node for the renderStyle field (restricted to X3DVolumeRenderStyleNode)
      • clearRenderStyle

        public IsoSurfaceVolumeDataObject clearRenderStyle()
        Utility method to clear MFNode value of renderStyle field.
        Returns:
        IsoSurfaceVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • hasRenderStyle

        public boolean hasRenderStyle()
        Indicate whether an object is available for inputOutput MFNode field renderStyle.
        Returns:
        whether a properly typed node or ProtoInstance array or CommentsBlock is available.
        See Also:
        getRenderStyle()
      • getSurfaceTolerance

        public 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.
        Specified by:
        getSurfaceTolerance in interface IsoSurfaceVolumeData
        Returns:
        value of surfaceTolerance field
      • setSurfaceTolerance

        public IsoSurfaceVolumeDataObject 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.
        Specified by:
        setSurfaceTolerance in interface IsoSurfaceVolumeData
        Parameters:
        newValue - is new value for the surfaceTolerance field.
        Returns:
        IsoSurfaceVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setSurfaceTolerance

        public IsoSurfaceVolumeDataObject setSurfaceTolerance​(double newValue)
        Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setSurfaceTolerance(float).
        Parameters:
        newValue - is new value for field
        Returns:
        IsoSurfaceVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getSurfaceValues

        public 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. *
        Specified by:
        getSurfaceValues in interface IsoSurfaceVolumeData
        Returns:
        value of surfaceValues field
      • getSurfaceValuesList

        public java.util.ArrayList<java.lang.Float> getSurfaceValuesList()
        Utility method to get ArrayList value of MFFloat surfaceValues field, similar to getSurfaceValues().
        Returns:
        value of surfaceValues field
      • setSurfaceValues

        public IsoSurfaceVolumeDataObject 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. *
        Specified by:
        setSurfaceValues in interface IsoSurfaceVolumeData
        Parameters:
        newValue - is new value for the surfaceValues field.
        Returns:
        IsoSurfaceVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setSurfaceValues

        public IsoSurfaceVolumeDataObject setSurfaceValues​(java.util.ArrayList<java.lang.Float> newValue)
        Assign ArrayList value of MFFloat surfaceValues field, similar to setSurfaceValues(float[]).
        Parameters:
        newValue - is new value for the surfaceValues field.
        Returns:
        IsoSurfaceVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • clearSurfaceValues

        public IsoSurfaceVolumeDataObject clearSurfaceValues()
        Utility method to clear MFFloat value of surfaceValues field.
        Returns:
        IsoSurfaceVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • setSurfaceValues

        public IsoSurfaceVolumeDataObject setSurfaceValues​(int[] newValue)
        Assign floating-point array value of MFFloat surfaceValues field, similar to setSurfaceValues(float[]).
        Parameters:
        newValue - is new value for the surfaceValues field.
        Returns:
        IsoSurfaceVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addSurfaceValues

        public IsoSurfaceVolumeDataObject addSurfaceValues​(float newValue)
        Add singleton float value to MFFloat surfaceValues field.
        Parameters:
        newValue - is new value to add to the surfaceValues field.
        Returns:
        IsoSurfaceVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addSurfaceValues

        public IsoSurfaceVolumeDataObject addSurfaceValues​(SFFloatObject newValue)
        Add singleton SFFloatObject value to MFFloat surfaceValues field.
        Parameters:
        newValue - is new value to add to the surfaceValues field.
        Returns:
        IsoSurfaceVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setSurfaceValues

        public IsoSurfaceVolumeDataObject setSurfaceValues​(double[] newArray)
        Utility method: double-precision set-array accessor for X3D floating-point type, similar to setSurfaceValues(float[]).
        Parameters:
        newArray - is new value for field
        Returns:
        IsoSurfaceVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getVoxels

        public X3DTexture3DNode getVoxels()
        Provide X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field voxels.
        Specified by:
        getVoxels in interface IsoSurfaceVolumeData
        Returns:
        value of voxels field
        See Also:
        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. *
      • clearVoxels

        public IsoSurfaceVolumeDataObject clearVoxels()
        Utility method to clear SFNode value of voxels field.
        Returns:
        IsoSurfaceVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • hasVoxels

        public boolean hasVoxels()
        Indicate whether an object is available for inputOutput SFNode field voxels.
        Returns:
        whether a properly typed node or ProtoInstance or CommentsBlock is available.
        See Also:
        getVoxels(), getVoxelsProtoInstance()
      • setDEF

        public final IsoSurfaceVolumeDataObject setDEF​(java.lang.String newValue)
        Accessor method to assign String value to inputOutput SFString field named DEF.

        Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.

        Note that setting the DEF value clears the USE value.
        Specified by:
        setDEF in class X3DConcreteNode
        Parameters:
        newValue - is new value for the DEF field.
        Returns:
        IsoSurfaceVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getUSE

        public java.lang.String getUSE()
        Provide String value from 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.
        Overrides:
        getUSE in class X3DConcreteNode
        Returns:
        value of USE field
        See Also:
        X3D Scene Authoring Hints: Naming Conventions
      • setUSE

        public final IsoSurfaceVolumeDataObject setUSE​(java.lang.String newValue)
        Accessor method to 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 class X3DConcreteNode
        Parameters:
        newValue - is new value for the USE field.
        Returns:
        IsoSurfaceVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getCssClass

        public java.lang.String getCssClass()
        Provide String value from 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
        Overrides:
        getCssClass in class X3DConcreteNode
        Returns:
        value of class field
        See Also:
        W3C Cascading Style Sheets
      • setCssClass

        public final IsoSurfaceVolumeDataObject setCssClass​(java.lang.String newValue)
        Accessor method to 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 class X3DConcreteNode
        Parameters:
        newValue - is new value for the class field.
        Returns:
        IsoSurfaceVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        W3C Cascading Style Sheets
      • setUSE

        public IsoSurfaceVolumeDataObject setUSE​(IsoSurfaceVolumeDataObject DEFnode)
        Assign a USE reference to another DEF node of same node type, similar to setUSE(String).

        Warning: note that 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.
        Parameters:
        DEFnode - must have a DEF value defined
        Returns:
        IsoSurfaceVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addComments

        public IsoSurfaceVolumeDataObject addComments​(java.lang.String[] newComments)
        Add comments as String[] array to contained commentsList.
        Specified by:
        addComments in class X3DConcreteElement
        Parameters:
        newComments - array of comments
        Returns:
        IsoSurfaceVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • findElementByNameValue

        public X3DConcreteElement findElementByNameValue​(java.lang.String nameValue)
        Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

        Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

        Warning: more than one element may be found that has the same name, this method does not handle that case.
        Specified by:
        findElementByNameValue in class X3DConcreteElement
        Parameters:
        nameValue - is value of the name field being searched for in this element and child elements(if any)
        Returns:
        object reference to found element, null otherwise
        See Also:
        findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
      • findElementByNameValue

        public X3DConcreteElement findElementByNameValue​(java.lang.String nameValue,
                                                         java.lang.String elementName)
        Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

        Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

        Warning: more than one element may be found that has the same name, this method does not handle that case.
        Specified by:
        findElementByNameValue in class X3DConcreteElement
        Parameters:
        nameValue - is value of the name field being searched for in this element and child elements(if any)
        elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
        Returns:
        object reference to found element, null otherwise
        See Also:
        findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
      • hasElementByNameValue

        public boolean hasElementByNameValue​(java.lang.String nameValue,
                                             java.lang.String elementName)
        Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
        Parameters:
        nameValue - is value of the name field being searched for in this element and child elements(if any)
        elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
        Returns:
        whether node is found
        See Also:
        findElementByNameValue(String, String)
      • hasNodeByDEF

        public boolean hasNodeByDEF​(java.lang.String DEFvalue)
        Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
        Parameters:
        DEFvalue - is value of the name field being searched for in this element and child elements(if any)
        Returns:
        whether node is found
        See Also:
        findNodeByDEF(String)
      • validate

        public java.lang.String validate()
        Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.
        Specified by:
        validate in class X3DConcreteElement
        Returns:
        validation results (if any)