Class SegmentedVolumeDataObject

    • Field Detail

      • NAME

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

        public static final java.lang.String COMPONENT
        String constant COMPONENT defines X3D component for the SegmentedVolumeData 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).
      • 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).
      • 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).
      • SEGMENTENABLED_DEFAULT_VALUE

        public static final java.util.ArrayList<java.lang.Boolean> SEGMENTENABLED_DEFAULT_VALUE
        MFBool field named segmentEnabled has default value equal to an empty list.
      • SEGMENTIDENTIFIERS_DEFAULT_VALUE

        public static final X3DTexture3DNode SEGMENTIDENTIFIERS_DEFAULT_VALUE
        SFNode field named segmentIdentifiers has default value null (Java syntax) or NULL (XML syntax).
      • 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_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_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_SEGMENTENABLED

        public static final java.lang.String fromField_SEGMENTENABLED
        fromField ROUTE name for MFBool field named segmentEnabled.
        See Also:
        Constant Field Values
      • toField_SEGMENTENABLED

        public static final java.lang.String toField_SEGMENTENABLED
        toField ROUTE name for MFBool field named segmentEnabled.
        See Also:
        Constant Field Values
      • fromField_SEGMENTIDENTIFIERS

        public static final java.lang.String fromField_SEGMENTIDENTIFIERS
        fromField ROUTE name for SFNode field named segmentIdentifiers.
        See Also:
        Constant Field Values
      • toField_SEGMENTIDENTIFIERS

        public static final java.lang.String toField_SEGMENTIDENTIFIERS
        toField ROUTE name for SFNode field named segmentIdentifiers.
        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

      • SegmentedVolumeDataObject

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

        public SegmentedVolumeDataObject​(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: SegmentedVolumeData
        Specified by:
        getElementName in class X3DConcreteElement
        Returns:
        name of this element
      • getComponent

        public final java.lang.String getComponent()
        Defines X3D component for the SegmentedVolumeData 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 SegmentedVolumeDataObject 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:
        SegmentedVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setBboxCenter

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

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

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

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

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

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

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

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

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

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

        public SegmentedVolumeDataObject clearIS()
        Utility method to clear SFNode value of IS field.
        Returns:
        SegmentedVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • 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 SegmentedVolumeDataObject clearMetadata()
        Utility method to clear SFNode value of metadata field.
        Returns:
        SegmentedVolumeDataObject - 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 SegmentedVolumeData
        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 SegmentedVolumeDataObject 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 SegmentedVolumeData
        Parameters:
        newValue - is new value for the renderStyle field.
        Returns:
        SegmentedVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addRenderStyle

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

        public SegmentedVolumeDataObject 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:
        SegmentedVolumeDataObject - 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 SegmentedVolumeData
        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 SegmentedVolumeData
        Parameters:
        newValue - is new node for the renderStyle field (restricted to X3DVolumeRenderStyleNode)
      • clearRenderStyle

        public SegmentedVolumeDataObject clearRenderStyle()
        Utility method to clear MFNode value of renderStyle field.
        Returns:
        SegmentedVolumeDataObject - 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()
      • getSegmentEnabled

        public boolean[] getSegmentEnabled()
        Provide array of Boolean results from inputOutput MFBool field named segmentEnabled.
        Specified by:
        getSegmentEnabled in interface SegmentedVolumeData
        Returns:
        value of segmentEnabled field
      • getSegmentEnabledList

        public java.util.ArrayList<java.lang.Boolean> getSegmentEnabledList()
        Utility method to get ArrayList value of MFBool segmentEnabled field, similar to getSegmentEnabled().
        Returns:
        value of segmentEnabled field
      • setSegmentEnabled

        public SegmentedVolumeDataObject setSegmentEnabled​(boolean[] newValue)
        Accessor method to assign Boolean array to inputOutput MFBool field named segmentEnabled.
        Specified by:
        setSegmentEnabled in interface SegmentedVolumeData
        Parameters:
        newValue - is new value for the segmentEnabled field.
        Returns:
        SegmentedVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setSegmentEnabled

        public SegmentedVolumeDataObject setSegmentEnabled​(java.util.ArrayList<java.lang.Boolean> newValue)
        Assign ArrayList value of MFBool segmentEnabled field, similar to setSegmentEnabled(boolean[]).
        Parameters:
        newValue - is new value for the segmentEnabled field.
        Returns:
        SegmentedVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • clearSegmentEnabled

        public SegmentedVolumeDataObject clearSegmentEnabled()
        Utility method to clear MFBool value of segmentEnabled field.
        Returns:
        SegmentedVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • addSegmentEnabled

        public SegmentedVolumeDataObject addSegmentEnabled​(boolean newValue)
        Add singleton boolean value to MFBool segmentEnabled field.
        Parameters:
        newValue - is new value to add to the segmentEnabled field.
        Returns:
        SegmentedVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addSegmentEnabled

        public SegmentedVolumeDataObject addSegmentEnabled​(SFBoolObject newValue)
        Add singleton SFBoolObject value to MFBool segmentEnabled field.
        Parameters:
        newValue - is new value to add to the segmentEnabled field.
        Returns:
        SegmentedVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getSegmentIdentifiers

        public X3DTexture3DNode getSegmentIdentifiers()
        Provide X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field segmentIdentifiers.
        Specified by:
        getSegmentIdentifiers in interface SegmentedVolumeData
        Returns:
        value of segmentIdentifiers field
        See Also:
        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.
      • clearSegmentIdentifiers

        public SegmentedVolumeDataObject clearSegmentIdentifiers()
        Utility method to clear SFNode value of segmentIdentifiers field.
        Returns:
        SegmentedVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • hasSegmentIdentifiers

        public boolean hasSegmentIdentifiers()
        Indicate whether an object is available for inputOutput SFNode field segmentIdentifiers.
        Returns:
        whether a properly typed node or ProtoInstance or CommentsBlock is available.
        See Also:
        getSegmentIdentifiers(), getSegmentIdentifiersProtoInstance()
      • getVoxels

        public X3DTexture3DNode getVoxels()
        Provide X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field voxels.
        Specified by:
        getVoxels in interface SegmentedVolumeData
        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 SegmentedVolumeDataObject clearVoxels()
        Utility method to clear SFNode value of voxels field.
        Returns:
        SegmentedVolumeDataObject - 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 SegmentedVolumeDataObject 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:
        SegmentedVolumeDataObject - 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 SegmentedVolumeDataObject 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:
        SegmentedVolumeDataObject - 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 SegmentedVolumeDataObject 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:
        SegmentedVolumeDataObject - 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 SegmentedVolumeDataObject setUSE​(SegmentedVolumeDataObject 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:
        SegmentedVolumeDataObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addComments

        public SegmentedVolumeDataObject 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:
        SegmentedVolumeDataObject - 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)