Class ComposedVolumeStyleObject

    • Field Detail

      • NAME

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

        public static final java.lang.String COMPONENT
        String constant COMPONENT defines X3D component for the ComposedVolumeStyle 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: 3
        See Also:
        Constant Field Values
      • ENABLED_DEFAULT_VALUE

        public static final boolean ENABLED_DEFAULT_VALUE
        SFBool field named enabled has default value true (Java syntax) or true (XML syntax).
        See Also:
        Constant Field Values
      • 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).
      • fromField_ENABLED

        public static final java.lang.String fromField_ENABLED
        fromField ROUTE name for SFBool field named enabled.
        See Also:
        Constant Field Values
      • toField_ENABLED

        public static final java.lang.String toField_ENABLED
        toField ROUTE name for SFBool field named enabled.
        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
    • Constructor Detail

      • ComposedVolumeStyleObject

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

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

        public final java.lang.String getComponent()
        Defines X3D component for the ComposedVolumeStyle 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: 3
        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
      • clearIS

        public ComposedVolumeStyleObject clearIS()
        Utility method to clear SFNode value of IS field.
        Returns:
        ComposedVolumeStyleObject - 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 ComposedVolumeStyleObject clearMetadata()
        Utility method to clear SFNode value of metadata field.
        Returns:
        ComposedVolumeStyleObject - 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 X3DComposableVolumeRenderStyleNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field renderStyle.

        Tooltip: [X3DComposableVolumeRenderStyleNode] List of contributing rendering style nodes or node references that can be applied to the object. Each rendering style is applied strictly in the order declared, starting with the first rendering style in the renderStyle field. *


        Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DComposableVolumeRenderStyleNode.
        Specified by:
        getRenderStyle in interface ComposedVolumeStyle
        Returns:
        value of renderStyle field
        See Also:
        X3DComposableVolumeRenderStyleNode
      • 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 ComposedVolumeStyleObject setRenderStyle​(X3DNode[] newValue)
        Accessor method to assign X3DComposableVolumeRenderStyleNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field renderStyle.

        Tooltip: [X3DComposableVolumeRenderStyleNode] List of contributing rendering style nodes or node references that can be applied to the object. Each rendering style is applied strictly in the order declared, starting with the first rendering style in the renderStyle field. *


        Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DComposableVolumeRenderStyleNode.
        Specified by:
        setRenderStyle in interface ComposedVolumeStyle
        Parameters:
        newValue - is new value for the renderStyle field.
        Returns:
        ComposedVolumeStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addRenderStyle

        public ComposedVolumeStyleObject 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 X3DComposableVolumeRenderStyleNode and ProtoInstance.
        Parameters:
        newValue - is new value to be appended the renderStyle field.
        Returns:
        ComposedVolumeStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addRenderStyle

        public ComposedVolumeStyleObject 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:
        ComposedVolumeStyleObject - 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 X3DComposableVolumeRenderStyleNode.
        Specified by:
        addRenderStyle in interface ComposedVolumeStyle
        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 X3DComposableVolumeRenderStyleNode.
        Specified by:
        setRenderStyle in interface ComposedVolumeStyle
        Parameters:
        newValue - is new node for the renderStyle field (restricted to X3DComposableVolumeRenderStyleNode)
      • clearRenderStyle

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

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

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