Class AppearanceObject

    • Field Detail

      • NAME

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

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

        public static final int LEVEL
        Integer constant LEVEL provides default X3D Shape component level for this element: 1
        See Also:
        Constant Field Values
      • FILLPROPERTIES_DEFAULT_VALUE

        public static final FillPropertiesObject FILLPROPERTIES_DEFAULT_VALUE
        SFNode field named fillProperties 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).
      • LINEPROPERTIES_DEFAULT_VALUE

        public static final LinePropertiesObject LINEPROPERTIES_DEFAULT_VALUE
        SFNode field named lineProperties has default value null (Java syntax) or NULL (XML syntax).
      • MATERIAL_DEFAULT_VALUE

        public static final X3DMaterialNode MATERIAL_DEFAULT_VALUE
        SFNode field named material 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).
      • POINTPROPERTIES_DEFAULT_VALUE

        public static final PointPropertiesObject POINTPROPERTIES_DEFAULT_VALUE
        SFNode field named pointProperties has default value null (Java syntax) or NULL (XML syntax).
      • TEXTURE_DEFAULT_VALUE

        public static final X3DTextureNode TEXTURE_DEFAULT_VALUE
        SFNode field named texture has default value null (Java syntax) or NULL (XML syntax).
      • TEXTURETRANSFORM_DEFAULT_VALUE

        public static final X3DTextureTransformNode TEXTURETRANSFORM_DEFAULT_VALUE
        SFNode field named textureTransform has default value null (Java syntax) or NULL (XML syntax).
      • fromField_FILLPROPERTIES

        public static final java.lang.String fromField_FILLPROPERTIES
        fromField ROUTE name for SFNode field named fillProperties.
        See Also:
        Constant Field Values
      • toField_FILLPROPERTIES

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

        public static final java.lang.String fromField_LINEPROPERTIES
        fromField ROUTE name for SFNode field named lineProperties.
        See Also:
        Constant Field Values
      • toField_LINEPROPERTIES

        public static final java.lang.String toField_LINEPROPERTIES
        toField ROUTE name for SFNode field named lineProperties.
        See Also:
        Constant Field Values
      • fromField_MATERIAL

        public static final java.lang.String fromField_MATERIAL
        fromField ROUTE name for SFNode field named material.
        See Also:
        Constant Field Values
      • toField_MATERIAL

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

        public static final java.lang.String fromField_POINTPROPERTIES
        fromField ROUTE name for SFNode field named pointProperties.
        See Also:
        Constant Field Values
      • toField_POINTPROPERTIES

        public static final java.lang.String toField_POINTPROPERTIES
        toField ROUTE name for SFNode field named pointProperties.
        See Also:
        Constant Field Values
      • fromField_SHADERS

        public static final java.lang.String fromField_SHADERS
        fromField ROUTE name for MFNode field named shaders.
        See Also:
        Constant Field Values
      • toField_SHADERS

        public static final java.lang.String toField_SHADERS
        toField ROUTE name for MFNode field named shaders.
        See Also:
        Constant Field Values
      • fromField_TEXTURE

        public static final java.lang.String fromField_TEXTURE
        fromField ROUTE name for SFNode field named texture.
        See Also:
        Constant Field Values
      • toField_TEXTURE

        public static final java.lang.String toField_TEXTURE
        toField ROUTE name for SFNode field named texture.
        See Also:
        Constant Field Values
      • fromField_TEXTURETRANSFORM

        public static final java.lang.String fromField_TEXTURETRANSFORM
        fromField ROUTE name for SFNode field named textureTransform.
        See Also:
        Constant Field Values
      • toField_TEXTURETRANSFORM

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

      • AppearanceObject

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

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

        public final java.lang.String getComponent()
        Defines X3D component for the Appearance element: Shape
        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: 1
        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
      • getFillProperties

        public FillProperties getFillProperties()
        Provide FillPropertiesObject instance (using a properly typed node) from inputOutput SFNode field fillProperties.
        Specified by:
        getFillProperties in interface Appearance
        Returns:
        value of fillProperties field
        See Also:
        Tooltip: [FillProperties] Single contained FillProperties node that specifies additional visual attributes applied to polygonal areas of corresponding geometry, on top of whatever other appearance is already defined. *
      • clearFillProperties

        public AppearanceObject clearFillProperties()
        Utility method to clear SFNode value of fillProperties field.
        Returns:
        AppearanceObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • setFillProperties

        public AppearanceObject setFillProperties​(ProtoInstanceObject newValue)
        Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field fillProperties.
        Parameters:
        newValue - is new value for the fillProperties field.
        Returns:
        AppearanceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        setFillProperties(FillProperties)
      • hasFillProperties

        public boolean hasFillProperties()
        Indicate whether an object is available for inputOutput SFNode field fillProperties.
        Returns:
        whether a properly typed node or ProtoInstance or CommentsBlock is available.
        See Also:
        getFillProperties(), getFillPropertiesProtoInstance()
      • clearIS

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

        public LineProperties getLineProperties()
        Provide LinePropertiesObject instance (using a properly typed node) from inputOutput SFNode field lineProperties.
        Specified by:
        getLineProperties in interface Appearance
        Returns:
        value of lineProperties field
        See Also:
        Tooltip: [LineProperties] Single contained LineProperties node that specifies additional visual attributes applied to corresponding line geometry. *
      • clearLineProperties

        public AppearanceObject clearLineProperties()
        Utility method to clear SFNode value of lineProperties field.
        Returns:
        AppearanceObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • setLineProperties

        public AppearanceObject setLineProperties​(ProtoInstanceObject newValue)
        Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field lineProperties.
        Parameters:
        newValue - is new value for the lineProperties field.
        Returns:
        AppearanceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        setLineProperties(LineProperties)
      • hasLineProperties

        public boolean hasLineProperties()
        Indicate whether an object is available for inputOutput SFNode field lineProperties.
        Returns:
        whether a properly typed node or ProtoInstance or CommentsBlock is available.
        See Also:
        getLineProperties(), getLinePropertiesProtoInstance()
      • getMaterial

        public X3DMaterialNode getMaterial()
        Provide X3DMaterialNode instance (using a properly typed node) from inputOutput SFNode field material.
        Specified by:
        getMaterial in interface Appearance
        Returns:
        value of material field
        See Also:
        Tooltip: [X3DMaterialNode] Single contained Material node that specifies visual attributes for lighting response (color types, transparency, etc.) applied to corresponding geometry. Warning: if material is NULL or unspecified, lighting is off (all lights ignored) for this Shape and unlit object color is (1, 1, 1).
      • clearMaterial

        public AppearanceObject clearMaterial()
        Utility method to clear SFNode value of material field.
        Returns:
        AppearanceObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • setMaterial

        public AppearanceObject setMaterial​(ProtoInstanceObject newValue)
        Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field material.
        Parameters:
        newValue - is new value for the material field.
        Returns:
        AppearanceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        setMaterial(X3DMaterialNode)
      • hasMaterial

        public boolean hasMaterial()
        Indicate whether an object is available for inputOutput SFNode field material.
        Returns:
        whether a properly typed node or ProtoInstance or CommentsBlock is available.
        See Also:
        getMaterial(), getMaterialProtoInstance()
      • clearMetadata

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

        public PointProperties getPointProperties()
        Provide PointPropertiesObject instance (using a properly typed node) from inputOutput SFNode field pointProperties.
        Specified by:
        getPointProperties in interface Appearance
        Returns:
        value of pointProperties field
        See Also:
        getPointPropertiesProtoInstance()
      • clearPointProperties

        public AppearanceObject clearPointProperties()
        Utility method to clear SFNode value of pointProperties field.
        Returns:
        AppearanceObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • setPointProperties

        public AppearanceObject setPointProperties​(ProtoInstanceObject newValue)
        Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field pointProperties.
        Parameters:
        newValue - is new value for the pointProperties field.
        Returns:
        AppearanceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        setPointProperties(PointProperties)
      • hasPointProperties

        public boolean hasPointProperties()
        Indicate whether an object is available for inputOutput SFNode field pointProperties.
        Returns:
        whether a properly typed node or ProtoInstance or CommentsBlock is available.
        See Also:
        getPointProperties(), getPointPropertiesProtoInstance()
      • getShaders

        public X3DNode[] getShaders()
        Provide array of X3DShaderNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field shaders.

        Tooltip: [X3DShaderNode] Zero or more contained programmable shader nodes (ComposedShader, PackagedShader, ProgramShader) that specify, in order of preference, author-programmed rendering characteristics.

        Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DShaderNode.
        Specified by:
        getShaders in interface Appearance
        Returns:
        value of shaders field
        See Also:
        X3DShaderNode
      • getShadersList

        public java.util.ArrayList<X3DNode> getShadersList()
        Utility method to get ArrayList value of MFNode shaders field, similar to getShaders().
        Returns:
        value of shaders field
      • setShaders

        public AppearanceObject setShaders​(X3DNode[] newValue)
        Accessor method to assign X3DShaderNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field shaders.

        Tooltip: [X3DShaderNode] Zero or more contained programmable shader nodes (ComposedShader, PackagedShader, ProgramShader) that specify, in order of preference, author-programmed rendering characteristics.

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

        public AppearanceObject setShaders​(java.util.ArrayList<X3DShaderNode> newValue)
        Assign ArrayList value of MFNode shaders field, similar to setShaders(X3DNode[]).
        Parameters:
        newValue - is new value for the shaders field.
        Returns:
        AppearanceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addShaders

        public AppearanceObject addShaders​(X3DNode newValue)
        Add single child node to existing array of shaders nodes (if any).

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

        public AppearanceObject addShaders​(ProtoInstanceObject newValue)
        Add single ProtoInstanceObject (with appropriate node type and containerField value) to MFNode array for shaders 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:
        AppearanceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addShaders

        public void addShaders​(X3DNode[] newValue)
        Add array of child shaders nodes to array of existing nodes (if any).

        Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DShaderNode.
        Specified by:
        addShaders in interface Appearance
        Parameters:
        newValue - is new value array to be appended the shaders field.
      • setShaders

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

        Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to X3DShaderNode.
        Specified by:
        setShaders in interface Appearance
        Parameters:
        newValue - is new node for the shaders field (restricted to X3DShaderNode)
      • clearShaders

        public AppearanceObject clearShaders()
        Utility method to clear MFNode value of shaders field.
        Returns:
        AppearanceObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • hasShaders

        public boolean hasShaders()
        Indicate whether an object is available for inputOutput MFNode field shaders.
        Returns:
        whether a properly typed node or ProtoInstance array or CommentsBlock is available.
        See Also:
        getShaders()
      • getTexture

        public X3DTextureNode getTexture()
        Provide X3DTextureNode instance (using a properly typed node) from inputOutput SFNode field texture.
        Specified by:
        getTexture in interface Appearance
        Returns:
        value of texture field
        See Also:
        Tooltip: [X3DTextureNode] Single contained texture node (ImageTexture, MovieTexture, PixelTexture, MultiTexture) that maps image(s) to surface geometry. Hint: if texture node is NULL or unspecified, corresponding Shape geometry for this Appearance is not textured. Hint: X3D Scene Authoring Hints, Images http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Images Hint: X3D Architecture 18 Texturing component http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texturing.html Hint: X3D Architecture 33 Texturing3D component http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texture3D.html
      • clearTexture

        public AppearanceObject clearTexture()
        Utility method to clear SFNode value of texture field.
        Returns:
        AppearanceObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • setTexture

        public AppearanceObject setTexture​(ProtoInstanceObject newValue)
        Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field texture.
        Parameters:
        newValue - is new value for the texture field.
        Returns:
        AppearanceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        setTexture(X3DTextureNode)
      • hasTexture

        public boolean hasTexture()
        Indicate whether an object is available for inputOutput SFNode field texture.
        Returns:
        whether a properly typed node or ProtoInstance or CommentsBlock is available.
        See Also:
        getTexture(), getTextureProtoInstance()
      • getTextureTransform

        public X3DTextureTransformNode getTextureTransform()
        Provide X3DTextureTransformNode instance (using a properly typed node) from inputOutput SFNode field textureTransform.
        Specified by:
        getTextureTransform in interface Appearance
        Returns:
        value of textureTransform field
        See Also:
        Tooltip: [X3DTextureTransformNode] Single contained TextureTransform node that defines 2D transformation applied to texture coordinates. Hint: if textureTransform array is empty, then this field has no effect.
      • clearTextureTransform

        public AppearanceObject clearTextureTransform()
        Utility method to clear SFNode value of textureTransform field.
        Returns:
        AppearanceObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • hasTextureTransform

        public boolean hasTextureTransform()
        Indicate whether an object is available for inputOutput SFNode field textureTransform.
        Returns:
        whether a properly typed node or ProtoInstance or CommentsBlock is available.
        See Also:
        getTextureTransform(), getTextureTransformProtoInstance()
      • setDEF

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

        public AppearanceObject setDEF​(SFStringObject newValue)
        Assign typed object value to SFString DEF field, similar to setDEF(String).
        Parameters:
        newValue - is new value for the DEF field.
        Returns:
        AppearanceObject - 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 AppearanceObject 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:
        AppearanceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setUSE

        public AppearanceObject setUSE​(SFStringObject newValue)
        Assign typed object value to SFString USE field, similar to setUSE(String).
        Parameters:
        newValue - is new value for the USE field.
        Returns:
        AppearanceObject - 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 AppearanceObject 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:
        AppearanceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        W3C Cascading Style Sheets
      • setCssClass

        public AppearanceObject setCssClass​(SFStringObject newValue)
        Assign typed object value to SFString cssClass field, similar to setCssClass(String).
        Parameters:
        newValue - is new value for the class field.
        Returns:
        AppearanceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setUSE

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

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

        public AppearanceObject 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:
        AppearanceObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • addComments

        public AppearanceObject addComments​(CommentsBlock newCommentsBlock)
        Add CommentsBlock to contained commentsList.
        Specified by:
        addComments in class X3DConcreteElement
        Parameters:
        newCommentsBlock - block of comments to add
        Returns:
        AppearanceObject - 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)