Class CartoonVolumeStyleObject

    • Field Detail

      • NAME

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

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

        public static final int COLORSTEPS_DEFAULT_VALUE
        SFInt32 field named colorSteps has default value 4 (Java syntax) or 4 (XML syntax).
        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).
      • ORTHOGONALCOLOR_DEFAULT_VALUE

        public static final float[] ORTHOGONALCOLOR_DEFAULT_VALUE
        SFColorRGBA field named orthogonalColor has default value {1f,1f,1f,1f} (Java syntax) or 1 1 1 1 (XML syntax).
      • PARALLELCOLOR_DEFAULT_VALUE

        public static final float[] PARALLELCOLOR_DEFAULT_VALUE
        SFColorRGBA field named parallelColor has default value {0f,0f,0f,1f} (Java syntax) or 0 0 0 1 (XML syntax).
      • SURFACENORMALS_DEFAULT_VALUE

        public static final X3DTexture3DNode SURFACENORMALS_DEFAULT_VALUE
        SFNode field named surfaceNormals has default value null (Java syntax) or NULL (XML syntax).
      • fromField_COLORSTEPS

        public static final java.lang.String fromField_COLORSTEPS
        fromField ROUTE name for SFInt32 field named colorSteps.
        See Also:
        Constant Field Values
      • toField_COLORSTEPS

        public static final java.lang.String toField_COLORSTEPS
        toField ROUTE name for SFInt32 field named colorSteps.
        See Also:
        Constant Field Values
      • 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_ORTHOGONALCOLOR

        public static final java.lang.String fromField_ORTHOGONALCOLOR
        fromField ROUTE name for SFColorRGBA field named orthogonalColor.
        See Also:
        Constant Field Values
      • toField_ORTHOGONALCOLOR

        public static final java.lang.String toField_ORTHOGONALCOLOR
        toField ROUTE name for SFColorRGBA field named orthogonalColor.
        See Also:
        Constant Field Values
      • fromField_PARALLELCOLOR

        public static final java.lang.String fromField_PARALLELCOLOR
        fromField ROUTE name for SFColorRGBA field named parallelColor.
        See Also:
        Constant Field Values
      • toField_PARALLELCOLOR

        public static final java.lang.String toField_PARALLELCOLOR
        toField ROUTE name for SFColorRGBA field named parallelColor.
        See Also:
        Constant Field Values
      • fromField_SURFACENORMALS

        public static final java.lang.String fromField_SURFACENORMALS
        fromField ROUTE name for SFNode field named surfaceNormals.
        See Also:
        Constant Field Values
      • toField_SURFACENORMALS

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

      • CartoonVolumeStyleObject

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

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

        public final java.lang.String getComponent()
        Defines X3D component for the CartoonVolumeStyle 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
      • getColorSteps

        public int getColorSteps()
        Provide int value using RGB values [0..1] from inputOutput SFInt32 field named colorSteps.

        Tooltip: [1,64] Number of distinct colors taken from interpolated colors and used to render the object.
        • Hint: colorSteps=1 means no color interpolation takes place, only use orthogonalColor.
        • Hint: parallelColor and orthogonalColor interpolation is in HSV color space for RGB components, linearly for alpha component.
        Specified by:
        getColorSteps in interface CartoonVolumeStyle
        Returns:
        value of colorSteps field
      • setColorSteps

        public CartoonVolumeStyleObject setColorSteps​(int newValue)
        Accessor method to assign int value to inputOutput SFInt32 field named colorSteps.

        Tooltip: [1,64] Number of distinct colors taken from interpolated colors and used to render the object.
        • Hint: colorSteps=1 means no color interpolation takes place, only use orthogonalColor.
        • Hint: parallelColor and orthogonalColor interpolation is in HSV color space for RGB components, linearly for alpha component.
        Specified by:
        setColorSteps in interface CartoonVolumeStyle
        Parameters:
        newValue - is new value for the colorSteps field.
        Returns:
        CartoonVolumeStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setColorSteps

        public CartoonVolumeStyleObject setColorSteps​(SFInt32Object newValue)
        Assign typed object value to SFInt32 colorSteps field, similar to setColorSteps(int).
        Parameters:
        newValue - is new value for the colorSteps field.
        Returns:
        CartoonVolumeStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • clearIS

        public CartoonVolumeStyleObject clearIS()
        Utility method to clear SFNode value of IS field.
        Returns:
        CartoonVolumeStyleObject - 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 CartoonVolumeStyleObject clearMetadata()
        Utility method to clear SFNode value of metadata field.
        Returns:
        CartoonVolumeStyleObject - 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
      • getOrthogonalColor

        public float[] getOrthogonalColor()
        Provide array of 4-tuple float results using RGBA values [0..1] using RGBA values [0..1] from inputOutput SFColorRGBA field named orthogonalColor.

        Tooltip: [0,1] orthogonalColor is used for surface normals that are orthogonal (perpendicular) to viewer's current location.
        Specified by:
        getOrthogonalColor in interface CartoonVolumeStyle
        Returns:
        value of orthogonalColor field
      • setOrthogonalColor

        public CartoonVolumeStyleObject setOrthogonalColor​(float[] newValue)
        Accessor method to assign 4-tuple float array using RGBA values [0..1] to inputOutput SFColorRGBA field named orthogonalColor.

        Tooltip: [0,1] orthogonalColor is used for surface normals that are orthogonal (perpendicular) to viewer's current location.
        Specified by:
        setOrthogonalColor in interface CartoonVolumeStyle
        Parameters:
        newValue - is new value for the orthogonalColor field.
        Returns:
        CartoonVolumeStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setOrthogonalColor

        public CartoonVolumeStyleObject setOrthogonalColor​(float red,
                                                           float green,
                                                           float blue,
                                                           float alpha)
        Assign values to SFColorRGBA orthogonalColor field, similar to setOrthogonalColor(float[]).
        Parameters:
        red - first component
        green - second component
        blue - third component
        alpha - fourth component for opaqueness (1 - transparency)
        Returns:
        CartoonVolumeStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setOrthogonalColor

        public CartoonVolumeStyleObject setOrthogonalColor​(double red,
                                                           double green,
                                                           double blue,
                                                           double alpha)
        Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setOrthogonalColor(float[]).
        Parameters:
        red - first component [0..1]
        green - second component [0..1]
        blue - third component [0..1]
        alpha - fourth component [0..1]
        Returns:
        CartoonVolumeStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setOrthogonalColor

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

        public float[] getParallelColor()
        Provide array of 4-tuple float results using RGBA values [0..1] using RGBA values [0..1] from inputOutput SFColorRGBA field named parallelColor.

        Tooltip: [0,1] parallelColor is used for surface normals that are orthogonal to viewer's current location.
        Specified by:
        getParallelColor in interface CartoonVolumeStyle
        Returns:
        value of parallelColor field
      • setParallelColor

        public CartoonVolumeStyleObject setParallelColor​(float[] newValue)
        Accessor method to assign 4-tuple float array using RGBA values [0..1] to inputOutput SFColorRGBA field named parallelColor.

        Tooltip: [0,1] parallelColor is used for surface normals that are orthogonal to viewer's current location.
        Specified by:
        setParallelColor in interface CartoonVolumeStyle
        Parameters:
        newValue - is new value for the parallelColor field.
        Returns:
        CartoonVolumeStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setParallelColor

        public CartoonVolumeStyleObject setParallelColor​(float red,
                                                         float green,
                                                         float blue,
                                                         float alpha)
        Assign values to SFColorRGBA parallelColor field, similar to setParallelColor(float[]).
        Parameters:
        red - first component
        green - second component
        blue - third component
        alpha - fourth component for opaqueness (1 - transparency)
        Returns:
        CartoonVolumeStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setParallelColor

        public CartoonVolumeStyleObject setParallelColor​(double red,
                                                         double green,
                                                         double blue,
                                                         double alpha)
        Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setParallelColor(float[]).
        Parameters:
        red - first component [0..1]
        green - second component [0..1]
        blue - third component [0..1]
        alpha - fourth component [0..1]
        Returns:
        CartoonVolumeStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setParallelColor

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

        public X3DTexture3DNode getSurfaceNormals()
        Provide X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field surfaceNormals.
        Specified by:
        getSurfaceNormals in interface CartoonVolumeStyle
        Returns:
        value of surfaceNormals field
        See Also:
        getSurfaceNormalsProtoInstance()
      • clearSurfaceNormals

        public CartoonVolumeStyleObject clearSurfaceNormals()
        Utility method to clear SFNode value of surfaceNormals field.
        Returns:
        CartoonVolumeStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • hasSurfaceNormals

        public boolean hasSurfaceNormals()
        Indicate whether an object is available for inputOutput SFNode field surfaceNormals.
        Returns:
        whether a properly typed node or ProtoInstance or CommentsBlock is available.
        See Also:
        getSurfaceNormals(), getSurfaceNormalsProtoInstance()
      • setDEF

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

        public CartoonVolumeStyleObject addComments​(java.lang.String newComment)
        Add comment as String to contained commentsList.
        Specified by:
        addComments in class X3DConcreteElement
        Parameters:
        newComment - initial value
        Returns:
        CartoonVolumeStyleObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • addComments

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