Class Appearance

All Implemented Interfaces:
X3DNode, Appearance, X3DAppearanceNode

public class Appearance extends X3DConcreteNode implements Appearance
Appearance specifies the visual properties of geometry by containing the Material, ImageTexture/MovieTexture/PixelTexture, FillProperties, LineProperties, programmable shader nodes (ComposedShader, PackagedShader, ProgramShader) and TextureTransform nodes.

X3D node tooltip: [X3DAppearanceNode] Appearance specifies the visual properties of geometry by containing the Material, ImageTexture/MovieTexture/PixelTexture, FillProperties, LineProperties, programmable shader nodes (ComposedShader, PackagedShader, ProgramShader) and TextureTransform nodes.
Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
See Also:
X3D Abstract Specification: Appearance, X3D Tooltips: Appearance, X3D Scene Authoring Hints
  • Field Details

    • ALPHAMODE_AUTO

      public static final String ALPHAMODE_AUTO
      Tooltip: Material transparency is applied to texture transparency. SFString field named alphaMode with X3DUOM simpleType alphaModeChoices and with X3DUOM baseType SFString can equal this value "AUTO" (Java syntax) or AUTO (XML syntax).
      See Also:
      XML Schema: alphaModeChoices, Constant Field Values
    • ALPHAMODE_OPAQUE

      public static final String ALPHAMODE_OPAQUE
      Tooltip: Ignore alpha channel texture transparency, opaque. SFString field named alphaMode with X3DUOM simpleType alphaModeChoices and with X3DUOM baseType SFString can equal this value "OPAQUE" (Java syntax) or OPAQUE (XML syntax).
      See Also:
      XML Schema: alphaModeChoices, Constant Field Values
    • ALPHAMODE_MASK

      public static final String ALPHAMODE_MASK
      Tooltip: Alpha-testing mode for transparent when alpha value less than 0.5 and opaque when greater than or equal to 0.5. SFString field named alphaMode with X3DUOM simpleType alphaModeChoices and with X3DUOM baseType SFString can equal this value "MASK" (Java syntax) or MASK (XML syntax).
      See Also:
      XML Schema: alphaModeChoices, Constant Field Values
    • ALPHAMODE_BLEND

      public static final String ALPHAMODE_BLEND
      Tooltip: Blend combines partial transparency of textures and materials. SFString field named alphaMode with X3DUOM simpleType alphaModeChoices and with X3DUOM baseType SFString can equal this value "BLEND" (Java syntax) or BLEND (XML syntax).
      See Also:
      XML Schema: alphaModeChoices, Constant Field Values
    • NAME

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

      public static final 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
    • ACOUSTICPROPERTIES_DEFAULT_VALUE

      public static final AcousticProperties ACOUSTICPROPERTIES_DEFAULT_VALUE
      SFNode field named acousticProperties has default value null (Java syntax) or NULL (XML syntax).
    • ALPHACUTOFF_DEFAULT_VALUE

      public static final float ALPHACUTOFF_DEFAULT_VALUE
      SFFloat field named alphaCutoff has default value 0.5f (Java syntax) or 0.5 (XML syntax).
      See Also:
      Constant Field Values
    • ALPHAMODE_DEFAULT_VALUE

      public static final String ALPHAMODE_DEFAULT_VALUE
      SFString field named alphaMode has default value "AUTO" (Java syntax) or AUTO (XML syntax).
      See Also:
      Constant Field Values
    • FILLPROPERTIES_DEFAULT_VALUE

      public static final FillProperties FILLPROPERTIES_DEFAULT_VALUE
      SFNode field named fillProperties has default value null (Java syntax) or NULL (XML syntax).
    • IS_DEFAULT_VALUE

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

      public static final LineProperties 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 PointProperties 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).
    • containerField_DEFAULT_VALUE

      public static final String containerField_DEFAULT_VALUE
      containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
      See Also:
      X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM), Constant Field Values
    • fromField_ACOUSTICPROPERTIES

      public static final String fromField_ACOUSTICPROPERTIES
      fromField ROUTE name for SFNode field named acousticProperties.
      See Also:
      Constant Field Values
    • toField_ACOUSTICPROPERTIES

      public static final String toField_ACOUSTICPROPERTIES
      toField ROUTE name for SFNode field named acousticProperties.
      See Also:
      Constant Field Values
    • fromField_ALPHACUTOFF

      public static final String fromField_ALPHACUTOFF
      fromField ROUTE name for SFFloat field named alphaCutoff.
      See Also:
      Constant Field Values
    • toField_ALPHACUTOFF

      public static final String toField_ALPHACUTOFF
      toField ROUTE name for SFFloat field named alphaCutoff.
      See Also:
      Constant Field Values
    • fromField_ALPHAMODE

      public static final String fromField_ALPHAMODE
      fromField ROUTE name for SFString field named alphaMode.
      See Also:
      Constant Field Values
    • toField_ALPHAMODE

      public static final String toField_ALPHAMODE
      toField ROUTE name for SFString field named alphaMode.
      See Also:
      Constant Field Values
    • fromField_FILLPROPERTIES

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

      public static final String toField_FILLPROPERTIES
      toField ROUTE name for SFNode field named fillProperties.
      See Also:
      Constant Field Values
    • fromField_IS

      public static final String fromField_IS
      fromField ROUTE name for SFNode field named IS.
      See Also:
      Constant Field Values
    • fromField_LINEPROPERTIES

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

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

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

      public static final String toField_MATERIAL
      toField ROUTE name for SFNode field named material.
      See Also:
      Constant Field Values
    • fromField_METADATA

      public static final String fromField_METADATA
      fromField ROUTE name for SFNode field named metadata.
      See Also:
      Constant Field Values
    • toField_METADATA

      public static final String toField_METADATA
      toField ROUTE name for SFNode field named metadata.
      See Also:
      Constant Field Values
    • fromField_POINTPROPERTIES

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

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

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

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

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

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

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

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

    • Appearance

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

      public Appearance(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 Details

    • getElementName

      public final String getElementName()
      Provides name of this element: Appearance
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element
    • getComponent

      public final 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 String getFieldType(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 String getAccessType(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
    • getContainerFieldDefault

      public final String getContainerFieldDefault()
      containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
      Specified by:
      getContainerFieldDefault in class X3DConcreteNode
      Returns:
      default containerField value
      See Also:
      X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)
    • initialize

      public final void initialize()
      Initialize all member variables to default values.
      Overrides:
      initialize in class X3DConcreteNode
    • getAcousticProperties

      public AcousticProperties getAcousticProperties()
      Provide org.web3d.x3d.sai.Shape.AcousticProperties instance (using a properly typed node) from inputOutput SFNode field acousticProperties.
      Specified by:
      getAcousticProperties in interface Appearance
      Returns:
      value of acousticProperties field
      See Also:
      Tooltip: [AcousticProperties] Single contained acousticProperties node that specifies additional acoustic attributes applied to associated surface geometry. *
    • setAcousticProperties

      public Appearance setAcousticProperties(AcousticProperties newValue)
      Accessor method to assign org.web3d.x3d.sai.Shape.AcousticProperties instance (using a properly typed node) to inputOutput SFNode field acousticProperties.
      Specified by:
      setAcousticProperties in interface Appearance
      Parameters:
      newValue - is new value for the acousticProperties field.
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      Tooltip: [AcousticProperties] Single contained acousticProperties node that specifies additional acoustic attributes applied to associated surface geometry. *
    • clearAcousticProperties

      public Appearance clearAcousticProperties()
      Utility method to clear SFNode value of acousticProperties field.
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setAcousticProperties

      public Appearance setAcousticProperties(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field acousticProperties.
      Parameters:
      newValue - is new value for the acousticProperties field.
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setAcousticProperties( org.web3d.x3d.sai.Shape.AcousticProperties)
    • hasAcousticProperties

      public boolean hasAcousticProperties()
      Indicate whether an object is available for inputOutput SFNode field acousticProperties.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:
      getAcousticProperties(), getAcousticPropertiesProtoInstance()
    • getAlphaCutoff

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

      Tooltip: [0,1] Threshold value used for pixel rendering either transparent or opaque, used when alphaMode="MASK".
      Specified by:
      getAlphaCutoff in interface Appearance
      Returns:
      value of alphaCutoff field
    • setAlphaCutoff

      public Appearance setAlphaCutoff(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named alphaCutoff.

      Tooltip: [0,1] Threshold value used for pixel rendering either transparent or opaque, used when alphaMode="MASK".
      Specified by:
      setAlphaCutoff in interface Appearance
      Parameters:
      newValue - is new value for the alphaCutoff field.
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setAlphaCutoff

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

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

      public String getAlphaMode()
      Provide String enumeration value (baseType SFString) ["AUTO" | "OPAQUE" | "MASK" | "BLEND"] from inputOutput SFString field named alphaMode.

      Tooltip: Provides options for control of alpha transparency handling for textures. AUTO means Material transparency is applied to texture transparency for full backwards compatility with X3D3, OPAQUE means ignore alpha transparency to render texture as opaque, MASK means alpha-testing of pixels as fully transparent when alpha value is less than alphaCutoff and fully opaque when alpha value is greater than or equal to alphaCutoff, BLEND combines partial transparency of textures and materials.

      Available enumeration values for string comparison: AUTO, OPAQUE, MASK, BLEND.
      Specified by:
      getAlphaMode in interface Appearance
      Returns:
      value of alphaMode field
    • setAlphaMode

      public Appearance setAlphaMode(String newValue)
      Accessor method to assign String enumeration value ("AUTO" | "OPAQUE" | "MASK" | "BLEND") to inputOutput SFString field named alphaMode.

      Warning: authors can only choose from a strict list of enumeration values (AUTO, OPAQUE, MASK, BLEND).

      Tooltip: Provides options for control of alpha transparency handling for textures. AUTO means Material transparency is applied to texture transparency for full backwards compatility with X3D3, OPAQUE means ignore alpha transparency to render texture as opaque, MASK means alpha-testing of pixels as fully transparent when alpha value is less than alphaCutoff and fully opaque when alpha value is greater than or equal to alphaCutoff, BLEND combines partial transparency of textures and materials.
      Specified by:
      setAlphaMode in interface Appearance
      Parameters:
      newValue - is new value for the alphaMode field.
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setAlphaMode

      public Appearance setAlphaMode(SFString newValue)
      Assign typed object value to SFString alphaMode field, similar to setAlphaMode(String).
      Parameters:
      newValue - is new value for the alphaMode field.
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getFillProperties

      public FillProperties getFillProperties()
      Provide org.web3d.x3d.sai.Shape.FillProperties 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. *
    • setFillProperties

      public Appearance setFillProperties(FillProperties newValue)
      Accessor method to assign org.web3d.x3d.sai.Shape.FillProperties instance (using a properly typed node) to inputOutput SFNode field fillProperties.
      Specified by:
      setFillProperties in interface Appearance
      Parameters:
      newValue - is new value for the fillProperties field.
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      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 Appearance clearFillProperties()
      Utility method to clear SFNode value of fillProperties field.
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setFillProperties

      public Appearance setFillProperties(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field fillProperties.
      Parameters:
      newValue - is new value for the fillProperties field.
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setFillProperties( org.web3d.x3d.sai.Shape.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()
    • getIS

      public IS getIS()
      Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
      Specified by:
      getIS in class X3DConcreteNode
      Returns:
      value of IS field
      See Also:
      X3D Tooltips: IS, X3D Tooltips: connect
    • setIS

      public Appearance setIS(IS newValue)
      Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
      Specified by:
      setIS in class X3DConcreteNode
      Parameters:
      newValue - is new value for the IS field.
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Tooltips: IS, X3D Tooltips: connect
    • clearIS

      public Appearance clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      Appearance - 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 org.web3d.x3d.sai.Shape.LineProperties 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. *
    • setLineProperties

      public Appearance setLineProperties(LineProperties newValue)
      Accessor method to assign org.web3d.x3d.sai.Shape.LineProperties instance (using a properly typed node) to inputOutput SFNode field lineProperties.
      Specified by:
      setLineProperties in interface Appearance
      Parameters:
      newValue - is new value for the lineProperties field.
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      Tooltip: [LineProperties] Single contained LineProperties node that specifies additional visual attributes applied to corresponding line geometry. *
    • clearLineProperties

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

      public Appearance setLineProperties(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field lineProperties.
      Parameters:
      newValue - is new value for the lineProperties field.
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setLineProperties( org.web3d.x3d.sai.Shape.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 org.web3d.x3d.sai.Shape.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).
    • setMaterial

      public Appearance setMaterial(X3DMaterialNode newValue)
      Accessor method to assign org.web3d.x3d.sai.Shape.X3DMaterialNode instance (using a properly typed node) to inputOutput SFNode field material.
      Specified by:
      setMaterial in interface Appearance
      Parameters:
      newValue - is new value for the material field.
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      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 Appearance clearMaterial()
      Utility method to clear SFNode value of material field.
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setMaterial

      public Appearance setMaterial(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field material.
      Parameters:
      newValue - is new value for the material field.
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setMaterial( org.web3d.x3d.sai.Shape.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()
    • getMetadata

      public X3DMetadataObject getMetadata()
      Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface Appearance
      Specified by:
      getMetadata in interface X3DAppearanceNode
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:
      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD3/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      public Appearance setMetadata(X3DMetadataObject newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface Appearance
      Specified by:
      setMetadata in interface X3DAppearanceNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD3/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes
    • clearMetadata

      public Appearance clearMetadata()
      Utility method to clear SFNode value of metadata field.
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setMetadata

      public Appearance setMetadata(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setMetadata( org.web3d.x3d.sai.Core.X3DMetadataObject)
    • 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 org.web3d.x3d.sai.Shape.PointProperties 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()
    • setPointProperties

      public Appearance setPointProperties(PointProperties newValue)
      Accessor method to assign org.web3d.x3d.sai.Shape.PointProperties instance (using a properly typed node) to inputOutput SFNode field pointProperties.
      Specified by:
      setPointProperties in interface Appearance
      Parameters:
      newValue - is new value for the pointProperties field.
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setPointProperties(ProtoInstance)
    • clearPointProperties

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

      public Appearance setPointProperties(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field pointProperties.
      Parameters:
      newValue - is new value for the pointProperties field.
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setPointProperties( org.web3d.x3d.sai.Shape.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 org.web3d.x3d.sai.Shaders.X3DShaderNode results (using an array consisting of properly typed nodes or ProtoInstances) 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 ArrayList<X3DNode> getShadersList()
      Utility method to get ArrayList value of MFNode shaders field, similar to getShaders().
      Returns:
      value of shaders field
    • setShaders

      public Appearance setShaders(X3DNode[] newValue)
      Accessor method to assign org.web3d.x3d.sai.Shaders.X3DShaderNode array (using an array consisting of properly typed nodes or ProtoInstances) 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:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setShaders

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

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

      public Appearance addShaders(ProtoInstance newValue)
      Add single ProtoInstance (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:
      Appearance - 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 Appearance clearShaders()
      Utility method to clear MFNode value of shaders field.
      Returns:
      Appearance - 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 org.web3d.x3d.sai.Texturing.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 https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Images Hint: X3D Architecture 18 Texturing component https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD3/Part01/components/texturing.html Hint: X3D Architecture 33 Texturing3D component https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD3/Part01/components/texture3D.html
    • setTexture

      public Appearance setTexture(X3DTextureNode newValue)
      Accessor method to assign org.web3d.x3d.sai.Texturing.X3DTextureNode instance (using a properly typed node) to inputOutput SFNode field texture.
      Specified by:
      setTexture in interface Appearance
      Parameters:
      newValue - is new value for the texture field.
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      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 https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Images Hint: X3D Architecture 18 Texturing component https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD3/Part01/components/texturing.html Hint: X3D Architecture 33 Texturing3D component https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD3/Part01/components/texture3D.html
    • clearTexture

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

      public Appearance setTexture(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field texture.
      Parameters:
      newValue - is new value for the texture field.
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setTexture( org.web3d.x3d.sai.Texturing.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 org.web3d.x3d.sai.Texturing.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.
    • setTextureTransform

      public Appearance setTextureTransform(X3DTextureTransformNode newValue)
      Accessor method to assign org.web3d.x3d.sai.Texturing.X3DTextureTransformNode instance (using a properly typed node) to inputOutput SFNode field textureTransform.
      Specified by:
      setTextureTransform in interface Appearance
      Parameters:
      newValue - is new value for the textureTransform field.
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      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 Appearance clearTextureTransform()
      Utility method to clear SFNode value of textureTransform field.
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setTextureTransform

      public Appearance setTextureTransform(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field textureTransform.
      Parameters:
      newValue - is new value for the textureTransform field.
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setTextureTransform( org.web3d.x3d.sai.Texturing.X3DTextureTransformNode)
    • 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()
    • getDEF

      public String getDEF()
      Provide String value from inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.
      Overrides:
      getDEF in class X3DConcreteNode
      Returns:
      value of DEF field
      See Also:
      X3D Scene Authoring Hints: Naming Conventions
    • setDEF

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

      public Appearance setDEF(SFString newValue)
      Assign typed object value to SFString DEF field, similar to setDEF(String).
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getUSE

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

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

      public String getCssClass()
      Provide String value from inputOutput SFString field named class.
      Overrides:
      getCssClass in class X3DConcreteNode
      Returns:
      value of class field
      See Also:
      X3D Architecture Annex L, HTML authoring guidelines, CSS considerations, W3C Cascading Style Sheets, W3C CSS Snapshot, Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets
    • setCssClass

      public final Appearance setCssClass(String newValue)
      Accessor method to assign String value to inputOutput SFString field named class.
      Specified by:
      setCssClass in class X3DConcreteNode
      Parameters:
      newValue - is new value for the class field.
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Architecture Annex L, HTML authoring guidelines, CSS considerations, W3C Cascading Style Sheets, W3C CSS Snapshot, Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets
    • setCssClass

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

      public String getCssStyle()
      Provide String value from inputOutput SFString field named style.
      Overrides:
      getCssStyle in class X3DConcreteNode
      Returns:
      value of style field
      See Also:
      X3D Architecture Annex L, HTML authoring guidelines, CSS considerations, W3C Cascading Style Sheets, W3C CSS Snapshot, Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets
    • setCssStyle

      public final Appearance setCssStyle(String newValue)
      Accessor method to assign String value to inputOutput SFString field named style.
      Specified by:
      setCssStyle in class X3DConcreteNode
      Parameters:
      newValue - is new value for the style field.
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Architecture Annex L, HTML authoring guidelines, CSS considerations, W3C Cascading Style Sheets, W3C CSS Snapshot, Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets
    • setCssStyle

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

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

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

      public Appearance addComments(String[] newComments)
      Add comments as String[] array to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComments - array of comments
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addComments

      public Appearance addComments(CommentsBlock newCommentsBlock)
      Add CommentsBlock to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • toStringX3D

      public String toStringX3D(int indentLevel)
      Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
      Specified by:
      toStringX3D in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      X3D string
      See Also:
      X3D.FILE_EXTENSION_X3D, X3D.FILE_EXTENSION_XML, X3D.toStringXML(), X3D.toFileXML(String), X3D.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form, X3D Canonicalization (C14N) Tool
    • toStringClassicVRML

      public String toStringClassicVRML(int indentLevel)
      Recursive method to provide ClassicVRML string serialization.
      Specified by:
      toStringClassicVRML in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      ClassicVRML string
      See Also:
      X3D.FILE_EXTENSION_CLASSICVRML, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
    • toStringVRML97

      public String toStringVRML97(int indentLevel)
      Recursive method to provide VRML97 string serialization.
      Specified by:
      toStringVRML97 in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      VRML97 string
      See Also:
      X3D.FILE_EXTENSION_VRML97, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue(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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue(String nameValue, 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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • hasElementByNameValue

      public boolean hasElementByNameValue(String nameValue, 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)
    • findNodeByDEF

      public X3DConcreteNode findNodeByDEF(String DEFvalue)
      Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.

      Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

      Warning: more than one element may be found that has the same DEF, this method does not handle that case.
      Specified by:
      findNodeByDEF in class X3DConcreteElement
      Parameters:
      DEFvalue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found node, null otherwise
      See Also:
      findElementByNameValue(String), X3DConcreteElement.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • hasNodeByDEF

      public boolean hasNodeByDEF(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 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)