Class MaterialObject

    • Field Detail

      • NAME

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

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

        public static final float AMBIENTINTENSITY_DEFAULT_VALUE
        SFFloat field named ambientIntensity has default value 0.2f (Java syntax) or 0.2 (XML syntax).
        See Also:
        Constant Field Values
      • DIFFUSECOLOR_DEFAULT_VALUE

        public static final float[] DIFFUSECOLOR_DEFAULT_VALUE
        SFColor field named diffuseColor has default value {0.8f,0.8f,0.8f} (Java syntax) or 0.8 0.8 0.8 (XML syntax).
      • EMISSIVECOLOR_DEFAULT_VALUE

        public static final float[] EMISSIVECOLOR_DEFAULT_VALUE
        SFColor field named emissiveColor has default value {0f,0f,0f} (Java syntax) or 0 0 0 (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).
      • SHININESS_DEFAULT_VALUE

        public static final float SHININESS_DEFAULT_VALUE
        SFFloat field named shininess has default value 0.2f (Java syntax) or 0.2 (XML syntax).
        See Also:
        Constant Field Values
      • SPECULARCOLOR_DEFAULT_VALUE

        public static final float[] SPECULARCOLOR_DEFAULT_VALUE
        SFColor field named specularColor has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
      • TRANSPARENCY_DEFAULT_VALUE

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

        public static final java.lang.String fromField_AMBIENTINTENSITY
        fromField ROUTE name for SFFloat field named ambientIntensity.
        See Also:
        Constant Field Values
      • toField_AMBIENTINTENSITY

        public static final java.lang.String toField_AMBIENTINTENSITY
        toField ROUTE name for SFFloat field named ambientIntensity.
        See Also:
        Constant Field Values
      • fromField_DIFFUSECOLOR

        public static final java.lang.String fromField_DIFFUSECOLOR
        fromField ROUTE name for SFColor field named diffuseColor.
        See Also:
        Constant Field Values
      • toField_DIFFUSECOLOR

        public static final java.lang.String toField_DIFFUSECOLOR
        toField ROUTE name for SFColor field named diffuseColor.
        See Also:
        Constant Field Values
      • fromField_EMISSIVECOLOR

        public static final java.lang.String fromField_EMISSIVECOLOR
        fromField ROUTE name for SFColor field named emissiveColor.
        See Also:
        Constant Field Values
      • toField_EMISSIVECOLOR

        public static final java.lang.String toField_EMISSIVECOLOR
        toField ROUTE name for SFColor field named emissiveColor.
        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_SHININESS

        public static final java.lang.String fromField_SHININESS
        fromField ROUTE name for SFFloat field named shininess.
        See Also:
        Constant Field Values
      • toField_SHININESS

        public static final java.lang.String toField_SHININESS
        toField ROUTE name for SFFloat field named shininess.
        See Also:
        Constant Field Values
      • fromField_SPECULARCOLOR

        public static final java.lang.String fromField_SPECULARCOLOR
        fromField ROUTE name for SFColor field named specularColor.
        See Also:
        Constant Field Values
      • toField_SPECULARCOLOR

        public static final java.lang.String toField_SPECULARCOLOR
        toField ROUTE name for SFColor field named specularColor.
        See Also:
        Constant Field Values
      • fromField_TRANSPARENCY

        public static final java.lang.String fromField_TRANSPARENCY
        fromField ROUTE name for SFFloat field named transparency.
        See Also:
        Constant Field Values
      • toField_TRANSPARENCY

        public static final java.lang.String toField_TRANSPARENCY
        toField ROUTE name for SFFloat field named transparency.
        See Also:
        Constant Field Values
    • Constructor Detail

      • MaterialObject

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

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

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

        public float getAmbientIntensity()
        Provide float value within allowed range of [0,1] from inputOutput SFFloat field named ambientIntensity.

        Tooltip: [0,1] how much ambient omnidirectional light is reflected from all light sources. Interchange profile hint: this field may be ignored, applying the default value regardless. *
        Specified by:
        getAmbientIntensity in interface Material
        Returns:
        value of ambientIntensity field
      • setAmbientIntensity

        public MaterialObject setAmbientIntensity​(float newValue)
        Accessor method to assign float value to inputOutput SFFloat field named ambientIntensity.

        Tooltip: [0,1] how much ambient omnidirectional light is reflected from all light sources. Interchange profile hint: this field may be ignored, applying the default value regardless. *
        Specified by:
        setAmbientIntensity in interface Material
        Parameters:
        newValue - is new value for the ambientIntensity field.
        Returns:
        MaterialObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setAmbientIntensity

        public MaterialObject setAmbientIntensity​(SFFloatObject newValue)
        Assign typed object value to SFFloat ambientIntensity field, similar to setAmbientIntensity(float).
        Parameters:
        newValue - is new value for the ambientIntensity field.
        Returns:
        MaterialObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setAmbientIntensity

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

        public float[] getDiffuseColor()
        Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput SFColor field named diffuseColor.

        Tooltip: [0,1] how much direct, angle-dependent light is reflected from all light sources.
        • Hint: only emissiveColor affects IndexedLineSet, LineSet and PointSet.
        Specified by:
        getDiffuseColor in interface Material
        Returns:
        value of diffuseColor field
      • setDiffuseColor

        public MaterialObject setDiffuseColor​(float[] newValue)
        Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput SFColor field named diffuseColor.

        Tooltip: [0,1] how much direct, angle-dependent light is reflected from all light sources.
        • Hint: only emissiveColor affects IndexedLineSet, LineSet and PointSet.
        Specified by:
        setDiffuseColor in interface Material
        Parameters:
        newValue - is new value for the diffuseColor field.
        Returns:
        MaterialObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setDiffuseColor

        public MaterialObject setDiffuseColor​(SFColorObject newValue)
        Assign typed object value to SFColor diffuseColor field, similar to setDiffuseColor(float[]).
        Parameters:
        newValue - is new value for the diffuseColor field.
        Returns:
        MaterialObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setDiffuseColor

        public MaterialObject setDiffuseColor​(float red,
                                              float green,
                                              float blue)
        Assign values to SFColor diffuseColor field, similar to setDiffuseColor(float[]).
        Parameters:
        red - first component
        green - second component
        blue - third component
        Returns:
        MaterialObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setDiffuseColor

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

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

        public float[] getEmissiveColor()
        Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput SFColor field named emissiveColor.

        Tooltip: [0,1] how much glowing light is emitted from this object.
        • Hint: emissiveColors glow even when all lights are off.
        • Hint: reset diffuseColor from default (.8 .8 .8) to (0 0 0) to avoid washout.
        • Hint: only emissiveColor affects IndexedLineSet, LineSet and PointSet.
        • Warning: bright emissiveColor values can wash out other colors and some textures.
        Specified by:
        getEmissiveColor in interface Material
        Returns:
        value of emissiveColor field
      • setEmissiveColor

        public MaterialObject setEmissiveColor​(float[] newValue)
        Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput SFColor field named emissiveColor.

        Tooltip: [0,1] how much glowing light is emitted from this object.
        • Hint: emissiveColors glow even when all lights are off.
        • Hint: reset diffuseColor from default (.8 .8 .8) to (0 0 0) to avoid washout.
        • Hint: only emissiveColor affects IndexedLineSet, LineSet and PointSet.
        • Warning: bright emissiveColor values can wash out other colors and some textures.
        Specified by:
        setEmissiveColor in interface Material
        Parameters:
        newValue - is new value for the emissiveColor field.
        Returns:
        MaterialObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setEmissiveColor

        public MaterialObject setEmissiveColor​(SFColorObject newValue)
        Assign typed object value to SFColor emissiveColor field, similar to setEmissiveColor(float[]).
        Parameters:
        newValue - is new value for the emissiveColor field.
        Returns:
        MaterialObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setEmissiveColor

        public MaterialObject setEmissiveColor​(float red,
                                               float green,
                                               float blue)
        Assign values to SFColor emissiveColor field, similar to setEmissiveColor(float[]).
        Parameters:
        red - first component
        green - second component
        blue - third component
        Returns:
        MaterialObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setEmissiveColor

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

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

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

        public float getShininess()
        Provide float value within allowed range of [0,1] from inputOutput SFFloat field named shininess.

        Tooltip: [0,1] Lower shininess values provide soft specular glows, while higher values result in sharper, smaller highlights. Interchange profile hint: this field may be ignored, applying the default value regardless. *
        Specified by:
        getShininess in interface Material
        Returns:
        value of shininess field
      • setShininess

        public MaterialObject setShininess​(float newValue)
        Accessor method to assign float value to inputOutput SFFloat field named shininess.

        Tooltip: [0,1] Lower shininess values provide soft specular glows, while higher values result in sharper, smaller highlights. Interchange profile hint: this field may be ignored, applying the default value regardless. *
        Specified by:
        setShininess in interface Material
        Parameters:
        newValue - is new value for the shininess field.
        Returns:
        MaterialObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setShininess

        public MaterialObject setShininess​(SFFloatObject newValue)
        Assign typed object value to SFFloat shininess field, similar to setShininess(float).
        Parameters:
        newValue - is new value for the shininess field.
        Returns:
        MaterialObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setShininess

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

        public float[] getSpecularColor()
        Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput SFColor field named specularColor.

        Tooltip: [0,1] specular highlights are brightness reflections (example: shiny spots on an apple). Interchange profile hint: this field may be ignored, applying the default value regardless. *
        Specified by:
        getSpecularColor in interface Material
        Returns:
        value of specularColor field
      • setSpecularColor

        public MaterialObject setSpecularColor​(float[] newValue)
        Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput SFColor field named specularColor.

        Tooltip: [0,1] specular highlights are brightness reflections (example: shiny spots on an apple). Interchange profile hint: this field may be ignored, applying the default value regardless. *
        Specified by:
        setSpecularColor in interface Material
        Parameters:
        newValue - is new value for the specularColor field.
        Returns:
        MaterialObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setSpecularColor

        public MaterialObject setSpecularColor​(SFColorObject newValue)
        Assign typed object value to SFColor specularColor field, similar to setSpecularColor(float[]).
        Parameters:
        newValue - is new value for the specularColor field.
        Returns:
        MaterialObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setSpecularColor

        public MaterialObject setSpecularColor​(float red,
                                               float green,
                                               float blue)
        Assign values to SFColor specularColor field, similar to setSpecularColor(float[]).
        Parameters:
        red - first component
        green - second component
        blue - third component
        Returns:
        MaterialObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setSpecularColor

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

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

        public float getTransparency()
        Provide float value within allowed range of [0,1] from inputOutput SFFloat field named transparency.

        Tooltip: [0,1] how "clear" an object is: 1.0 is completely transparent, 0.0 is completely opaque. Interchange profile hint: transparency < .5 opaque, transparency > .5 transparent. *
        Specified by:
        getTransparency in interface Material
        Returns:
        value of transparency field
      • setTransparency

        public MaterialObject setTransparency​(float newValue)
        Accessor method to assign float value to inputOutput SFFloat field named transparency.

        Tooltip: [0,1] how "clear" an object is: 1.0 is completely transparent, 0.0 is completely opaque. Interchange profile hint: transparency < .5 opaque, transparency > .5 transparent. *
        Specified by:
        setTransparency in interface Material
        Parameters:
        newValue - is new value for the transparency field.
        Returns:
        MaterialObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setTransparency

        public MaterialObject setTransparency​(SFFloatObject newValue)
        Assign typed object value to SFFloat transparency field, similar to setTransparency(float).
        Parameters:
        newValue - is new value for the transparency field.
        Returns:
        MaterialObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setTransparency

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

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

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

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

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

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

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

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