Package org.web3d.x3d.jsail.Shape

Class UnlitMaterial

java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Shape.UnlitMaterial
All Implemented Interfaces:
X3DNode, UnlitMaterial, X3DAppearanceChildNode, X3DMaterialNode, X3DOneSidedMaterialNode
public class UnlitMaterial extends X3DConcreteNode implements UnlitMaterial
UnlitMaterial specifies surface rendering properties for associated geometry nodes.

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes. X3D node tooltip: (X3D version 4.0 draft) [X3DOneSidedMaterialNode] UnlitMaterial specifies surface rendering properties for associated geometry nodes. Material attributes are used by the X3D lighting equations during rendering. Hint: insert Shape and Appearance nodes before adding material. Hint: DEF/USE copies of a single node can provide a similar "look + feel" style for related shapes in a scene. Hint: X3D Scene Authoring Hints, Color <a href="https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color" target="_blank">https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color</a> Hint: X3D Example Archives, Basic, Universal Media Materials <a href="https://www.web3d.org/x3d/content/examples/Basic/UniversalMediaMaterials" target="_blank">https://www.web3d.org/x3d/content/examples/Basic/UniversalMediaMaterials</a> Hint: X3D Architecture 17.2.2 Lighting model <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/lighting.html#Lightingmodel" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/lighting.html#Lightingmodel</a> Hint: Rendering <a href="https://en.wikipedia.org/wiki/Rendering_(computer_graphics)" target="_blank">https://en.wikipedia.org/wiki/Rendering_(computer_graphics)</a> Hint: 3D rendering <a href="https://en.wikipedia.org/wiki/3D_rendering" target="_blank">https://en.wikipedia.org/wiki/3D_rendering</a> Hint: Physically based rendering (PBR) <a href="https://en.wikipedia.org/wiki/Physically_based_rendering" target="_blank">https://en.wikipedia.org/wiki/Physically_based_rendering</a> Hint: Non-photorealistic rendering (NPR) <a href="https://en.wikipedia.org/wiki/Non-photorealistic_rendering" target="_blank">https://en.wikipedia.org/wiki/Non-photorealistic_rendering</a> Hint: Cel shading (toon shading) <a href="https://en.wikipedia.org/wiki/Cel_shading" target="_blank">https://en.wikipedia.org/wiki/Cel_shading</a> *


Note that SFColor provides a variety of color constants.

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:

  • Field Details

    • NAME

      public static final String NAME
      String constant NAME provides name of this element: UnlitMaterial.
      See Also:

    • COMPONENT

      public static final String COMPONENT
      String constant COMPONENT defines X3D component for the UnlitMaterial element: Shape
      See Also:

    • LEVEL

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

    • EMISSIVECOLOR_DEFAULT_VALUE

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

    • EMISSIVETEXTURE_DEFAULT_VALUE

      public static final X3DSingleTextureNode EMISSIVETEXTURE_DEFAULT_VALUE
      SFNode field named emissiveTexture has default value null (Java syntax) or NULL (XML syntax).

    • EMISSIVETEXTUREMAPPING_DEFAULT_VALUE

      public static final String EMISSIVETEXTUREMAPPING_DEFAULT_VALUE
      SFString field named emissiveTextureMapping has default value equal to an empty string.
      See Also:

    • IS_DEFAULT_VALUE

      public static final IS 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).

    • NORMALSCALE_DEFAULT_VALUE

      public static final float NORMALSCALE_DEFAULT_VALUE
      SFFloat field named normalScale has default value 1f (Java syntax) or 1 (XML syntax).
      See Also:

    • NORMALTEXTURE_DEFAULT_VALUE

      public static final X3DSingleTextureNode NORMALTEXTURE_DEFAULT_VALUE
      SFNode field named normalTexture has default value null (Java syntax) or NULL (XML syntax).

    • NORMALTEXTUREMAPPING_DEFAULT_VALUE

      public static final String NORMALTEXTUREMAPPING_DEFAULT_VALUE
      SFString field named normalTextureMapping has default value equal to an empty string.
      See Also:

    • 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:

    • 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:

    • fromField_EMISSIVECOLOR

      public static final String fromField_EMISSIVECOLOR
      fromField ROUTE name for SFColor field named emissiveColor.
      See Also:

    • toField_EMISSIVECOLOR

      public static final String toField_EMISSIVECOLOR
      toField ROUTE name for SFColor field named emissiveColor.
      See Also:

    • fromField_EMISSIVETEXTURE

      public static final String fromField_EMISSIVETEXTURE
      fromField ROUTE name for SFNode field named emissiveTexture.
      See Also:

    • toField_EMISSIVETEXTURE

      public static final String toField_EMISSIVETEXTURE
      toField ROUTE name for SFNode field named emissiveTexture.
      See Also:

    • fromField_EMISSIVETEXTUREMAPPING

      public static final String fromField_EMISSIVETEXTUREMAPPING
      fromField ROUTE name for SFString field named emissiveTextureMapping.
      See Also:

    • toField_EMISSIVETEXTUREMAPPING

      public static final String toField_EMISSIVETEXTUREMAPPING
      toField ROUTE name for SFString field named emissiveTextureMapping.
      See Also:

    • fromField_IS

      public static final String fromField_IS
      fromField ROUTE name for SFNode field named IS.
      See Also:

    • fromField_METADATA

      public static final String fromField_METADATA
      fromField ROUTE name for SFNode field named metadata.
      See Also:

    • toField_METADATA

      public static final String toField_METADATA
      toField ROUTE name for SFNode field named metadata.
      See Also:

    • fromField_NORMALSCALE

      public static final String fromField_NORMALSCALE
      fromField ROUTE name for SFFloat field named normalScale.
      See Also:

    • toField_NORMALSCALE

      public static final String toField_NORMALSCALE
      toField ROUTE name for SFFloat field named normalScale.
      See Also:

    • fromField_NORMALTEXTURE

      public static final String fromField_NORMALTEXTURE
      fromField ROUTE name for SFNode field named normalTexture.
      See Also:

    • toField_NORMALTEXTURE

      public static final String toField_NORMALTEXTURE
      toField ROUTE name for SFNode field named normalTexture.
      See Also:

    • fromField_NORMALTEXTUREMAPPING

      public static final String fromField_NORMALTEXTUREMAPPING
      fromField ROUTE name for SFString field named normalTextureMapping.
      See Also:

    • toField_NORMALTEXTUREMAPPING

      public static final String toField_NORMALTEXTUREMAPPING
      toField ROUTE name for SFString field named normalTextureMapping.
      See Also:

    • fromField_TRANSPARENCY

      public static final String fromField_TRANSPARENCY
      fromField ROUTE name for SFFloat field named transparency.
      See Also:

    • toField_TRANSPARENCY

      public static final String toField_TRANSPARENCY
      toField ROUTE name for SFFloat field named transparency.
      See Also:

  • Constructor Details

    • UnlitMaterial

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

    • UnlitMaterial

      public UnlitMaterial(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: UnlitMaterial
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element

    • getComponent

      public final String getComponent()
      Defines X3D component for the UnlitMaterial 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:

    • 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:

    • 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:

    • initialize

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

    • 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 UnlitMaterial
      Returns:
      value of emissiveColor field

    • setEmissiveColor

      public UnlitMaterial 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 UnlitMaterial
      Parameters:
      newValue - is new value for the emissiveColor field.
      Returns:
      UnlitMaterial - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setEmissiveColor

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

    • setEmissiveColor

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

    • setEmissiveColor

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

    • setEmissiveColor

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

    • getEmissiveTexture

      public X3DSingleTextureNode getEmissiveTexture()
      Provide org.web3d.x3d.sai.Texturing.X3DSingleTextureNode instance (using a properly typed node) from inputOutput SFNode field emissiveTexture.
      Specified by:
      getEmissiveTexture in interface UnlitMaterial
      Returns:
      value of emissiveTexture field
      See Also:


      • Tooltip: [X3DSingleTextureNode] When applying emissiveColor for this material node, the contained texture provides Physically Based Rendering (PBR) modulation for each pixel. Hint: if texture node is NULL or unspecified, no effect is applied to material values. Hint: contained texture node must include containerField='emissiveTexture'. *

    • setEmissiveTexture

      public UnlitMaterial setEmissiveTexture(X3DSingleTextureNode newValue)
      Accessor method to assign org.web3d.x3d.sai.Texturing.X3DSingleTextureNode instance (using a properly typed node) to inputOutput SFNode field emissiveTexture.
      Specified by:
      setEmissiveTexture in interface UnlitMaterial
      Parameters:
      newValue - is new value for the emissiveTexture field.
      Returns:
      UnlitMaterial - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • clearEmissiveTexture

      public UnlitMaterial clearEmissiveTexture()
      Utility method to clear SFNode value of emissiveTexture field.
      Returns:
      UnlitMaterial - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • setEmissiveTexture

      public UnlitMaterial setEmissiveTexture(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field emissiveTexture.
      Parameters:
      newValue - is new value for the emissiveTexture field.
      Returns:
      UnlitMaterial - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • hasEmissiveTexture

      public boolean hasEmissiveTexture()
      Indicate whether an object is available for inputOutput SFNode field emissiveTexture.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:

    • getEmissiveTextureMapping

      public String getEmissiveTextureMapping()
      Provide String value from inputOutput SFString field named emissiveTextureMapping.

      Tooltip: The mapping label identifies which texture coordinates and transformations are used to compute texture effects from corresponding geometry on a given material. Hint: TODO support planned to perform multiple-node mapping validation checks using X3D Schematron or X3D Validator <a href="https://savage.nps.edu/X3dValidator" target="_blank">https://savage.nps.edu/X3dValidator</a> *
      Specified by:
      getEmissiveTextureMapping in interface UnlitMaterial
      Specified by:
      getEmissiveTextureMapping in interface X3DOneSidedMaterialNode
      Returns:
      value of emissiveTextureMapping field

    • setEmissiveTextureMapping

      public UnlitMaterial setEmissiveTextureMapping(String newValue)
      Accessor method to assign String value to inputOutput SFString field named emissiveTextureMapping.

      Tooltip: The mapping label identifies which texture coordinates and transformations are used to compute texture effects from corresponding geometry on a given material. Hint: TODO support planned to perform multiple-node mapping validation checks using X3D Schematron or X3D Validator <a href="https://savage.nps.edu/X3dValidator" target="_blank">https://savage.nps.edu/X3dValidator</a> *
      Specified by:
      setEmissiveTextureMapping in interface UnlitMaterial
      Specified by:
      setEmissiveTextureMapping in interface X3DOneSidedMaterialNode
      Parameters:
      newValue - is new value for the emissiveTextureMapping field.
      Returns:
      UnlitMaterial - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setEmissiveTextureMapping

      public UnlitMaterial setEmissiveTextureMapping(SFString newValue)
      Assign typed object value to SFString emissiveTextureMapping field, similar to setEmissiveTextureMapping(String). // #0.e
      Parameters:
      newValue - is new value for the emissiveTextureMapping field.
      Returns:
      UnlitMaterial - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • 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:

    • setIS

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

    • clearIS

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

    • 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 UnlitMaterial
      Specified by:
      getMetadata in interface X3DAppearanceChildNode
      Specified by:
      getMetadata in interface X3DMaterialNode
      Specified by:
      getMetadata in interface X3DNode
      Specified by:
      getMetadata in interface X3DOneSidedMaterialNode
      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 <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/core.html#Metadata" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/core.html#Metadata</a> *
      • X3D Scene Authoring Hints: Metadata Nodes

    • setMetadata

      public UnlitMaterial 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 UnlitMaterial
      Specified by:
      setMetadata in interface X3DAppearanceChildNode
      Specified by:
      setMetadata in interface X3DMaterialNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DOneSidedMaterialNode
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      UnlitMaterial - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • clearMetadata

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

    • setMetadata

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

    • 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:

    • getNormalScale

      public float getNormalScale()
      Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named normalScale.

      Tooltip: [0,infinity] normalScale controls the degree to which normalTexture RGB values apply XYZ-normal bump mapping to pixels in the parent material. Hint: normalScale only affects computation of normalTexture modulations that affect lighting of characteristics of the parent Material and has no relation to normal vectors defined by corresponding geometry. Hint: normalTexture techniques apply Bump mapping <a href="https://en.wikipedia.org/wiki/Bump_mapping" target="_blank">https://en.wikipedia.org/wiki/Bump_mapping</a> *
      Specified by:
      getNormalScale in interface UnlitMaterial
      Specified by:
      getNormalScale in interface X3DOneSidedMaterialNode
      Returns:
      value of normalScale field

    • setNormalScale

      public UnlitMaterial setNormalScale(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named normalScale.

      Tooltip: [0,infinity] normalScale controls the degree to which normalTexture RGB values apply XYZ-normal bump mapping to pixels in the parent material. Hint: normalScale only affects computation of normalTexture modulations that affect lighting of characteristics of the parent Material and has no relation to normal vectors defined by corresponding geometry. Hint: normalTexture techniques apply Bump mapping <a href="https://en.wikipedia.org/wiki/Bump_mapping" target="_blank">https://en.wikipedia.org/wiki/Bump_mapping</a> *
      Specified by:
      setNormalScale in interface UnlitMaterial
      Specified by:
      setNormalScale in interface X3DOneSidedMaterialNode
      Parameters:
      newValue - is new value for the normalScale field.
      Returns:
      UnlitMaterial - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setNormalScale

      public UnlitMaterial setNormalScale(SFFloat newValue)
      Assign typed object value to SFFloat normalScale field, similar to setNormalScale(float). // #0.e
      Parameters:
      newValue - is new value for the normalScale field.
      Returns:
      UnlitMaterial - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setNormalScale

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

    • getNormalTexture

      public X3DSingleTextureNode getNormalTexture()
      Provide org.web3d.x3d.sai.Texturing.X3DSingleTextureNode instance (using a properly typed node) from inputOutput SFNode field normalTexture.
      Specified by:
      getNormalTexture in interface UnlitMaterial
      Returns:
      value of normalTexture field
      See Also:


      • Tooltip: [X3DSingleTextureNode] When applying normalScale for this material node, the contained texture modulates the texture across the surface. Hint: normalTexture techniques apply Bump mapping <a href="https://en.wikipedia.org/wiki/Bump_mapping" target="_blank">https://en.wikipedia.org/wiki/Bump_mapping</a> Hint: if texture node is NULL or unspecified, no effect is applied to material values. Hint: contained texture node must include containerField='normalTexture' *

    • setNormalTexture

      public UnlitMaterial setNormalTexture(X3DSingleTextureNode newValue)
      Accessor method to assign org.web3d.x3d.sai.Texturing.X3DSingleTextureNode instance (using a properly typed node) to inputOutput SFNode field normalTexture.
      Specified by:
      setNormalTexture in interface UnlitMaterial
      Parameters:
      newValue - is new value for the normalTexture field.
      Returns:
      UnlitMaterial - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • clearNormalTexture

      public UnlitMaterial clearNormalTexture()
      Utility method to clear SFNode value of normalTexture field.
      Returns:
      UnlitMaterial - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • setNormalTexture

      public UnlitMaterial setNormalTexture(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field normalTexture.
      Parameters:
      newValue - is new value for the normalTexture field.
      Returns:
      UnlitMaterial - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • hasNormalTexture

      public boolean hasNormalTexture()
      Indicate whether an object is available for inputOutput SFNode field normalTexture.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:

    • getNormalTextureMapping

      public String getNormalTextureMapping()
      Provide String value from inputOutput SFString field named normalTextureMapping.

      Tooltip: The mapping label identifies which texture coordinates and transformations are used to compute texture effects from corresponding geometry on a given material. Hint: TODO support planned to perform multiple-node mapping validation checks using X3D Schematron or X3D Validator <a href="https://savage.nps.edu/X3dValidator" target="_blank">https://savage.nps.edu/X3dValidator</a> *
      Specified by:
      getNormalTextureMapping in interface UnlitMaterial
      Specified by:
      getNormalTextureMapping in interface X3DOneSidedMaterialNode
      Returns:
      value of normalTextureMapping field

    • setNormalTextureMapping

      public UnlitMaterial setNormalTextureMapping(String newValue)
      Accessor method to assign String value to inputOutput SFString field named normalTextureMapping.

      Tooltip: The mapping label identifies which texture coordinates and transformations are used to compute texture effects from corresponding geometry on a given material. Hint: TODO support planned to perform multiple-node mapping validation checks using X3D Schematron or X3D Validator <a href="https://savage.nps.edu/X3dValidator" target="_blank">https://savage.nps.edu/X3dValidator</a> *
      Specified by:
      setNormalTextureMapping in interface UnlitMaterial
      Specified by:
      setNormalTextureMapping in interface X3DOneSidedMaterialNode
      Parameters:
      newValue - is new value for the normalTextureMapping field.
      Returns:
      UnlitMaterial - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setNormalTextureMapping

      public UnlitMaterial setNormalTextureMapping(SFString newValue)
      Assign typed object value to SFString normalTextureMapping field, similar to setNormalTextureMapping(String). // #0.e
      Parameters:
      newValue - is new value for the normalTextureMapping field.
      Returns:
      UnlitMaterial - 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 &lt; .5 opaque, transparency &gt; .5 transparent. *
      Specified by:
      getTransparency in interface UnlitMaterial
      Returns:
      value of transparency field

    • setTransparency

      public UnlitMaterial 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 &lt; .5 opaque, transparency &gt; .5 transparent. *
      Specified by:
      setTransparency in interface UnlitMaterial
      Parameters:
      newValue - is new value for the transparency field.
      Returns:
      UnlitMaterial - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setTransparency

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

    • setTransparency

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

    • 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. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions <a href="https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions" target="_blank">https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions</a> *
      Overrides:
      getDEF in class X3DConcreteNode
      Returns:
      value of DEF field
      See Also:

    • setDEF

      public final UnlitMaterial 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. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions <a href="https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions" target="_blank">https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions</a> *


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

    • setDEF

      public UnlitMaterial setDEF(SFString newValue)
      Assign typed object value to SFString DEF field, similar to setDEF(String). // #0.e
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      UnlitMaterial - 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:

    • setUSE

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

    • setUSE

      public UnlitMaterial setUSE(SFString newValue)
      Assign typed object value to SFString USE field, similar to setUSE(String). // #0.e
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      UnlitMaterial - 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 X3DConcreteElement
      Returns:
      value of class field
      See Also:

    • setCssClass

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

    • setCssClass

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

    • getHtmlID

      public String getHtmlID()
      Provide String value from inputOutput SFString field named id.
      Overrides:
      getHtmlID in class X3DConcreteElement
      Returns:
      value of id field
      See Also:

    • setHtmlID

      public final UnlitMaterial setHtmlID(String newValue)
      Accessor method to assign String value to inputOutput SFString field named id.
      Specified by:
      setHtmlID in class X3DConcreteNode
      Parameters:
      newValue - is new value for the id field.
      Returns:
      UnlitMaterial - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • setHtmlID

      public UnlitMaterial setHtmlID(SFString newValue)
      Assign typed object value to SFString HtmlID field, similar to setHtmlID(String). // #0.e
      Parameters:
      newValue - is new value for the id field.
      Returns:
      UnlitMaterial - 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 X3DConcreteElement
      Returns:
      value of style field
      See Also:

    • setCssStyle

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

    • setCssStyle

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

    • setUSE

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

    • addComments

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

    • addComments

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

    • addComments

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

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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)