Package org.web3d.x3d.jsail.Texturing

Class MultiTexture

java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Texturing.MultiTexture
All Implemented Interfaces:
X3DNode, X3DAppearanceChildNode, MultiTexture, X3DTextureNode
public class MultiTexture extends X3DConcreteNode implements MultiTexture
MultiTexture applies several individual textures to a single geometry node, enabling a variety of visual effects that include light mapping and environment mapping.

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: [X3DTextureNode] MultiTexture applies several individual textures to a single geometry node, enabling a variety of visual effects that include light mapping and environment mapping. MultiTexture can contain zero or more ImageTexture, MovieTexture, PixelTexture, ComposedCubeMapTexture, GeneratedCubeMapTexture, ImageCubeMapTexture, ComposedTexture3D, ImageTexture3D, and PixelTexture3D nodes. Texture maps have a 2D coordinate system (s, t) horizontal and vertical, with (s, t) texture-coordinate values in range [0.0, 1.0] for opposite corners of the image. Hint: insert Shape and Appearance nodes before adding texture. Hint: Texture mapping <a href="https://en.wikipedia.org/wiki/Texture_mapping" target="_blank">https://en.wikipedia.org/wiki/Texture_mapping</a> Warning: the number of textures to be blended may have a significant impact on performance, depending on available graphics hardware capabilities. Hint: multitexturing is accomplished using MultiTexture, MultiTextureCoordinate and MultiTextureTransform nodes. Hint: Texture coordinates are reapplied (or else recomputed if textureTransform field initially NULL) whenever the corresponding vertex-based geometry changes. Hint: X3D Texturing component Figure 18.2 Lightmap example, <a href="https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texturing.html#f-Lightmapexample" target="_blank">https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texturing.html#f-Lightmapexample</a> Hint: X3D Texturing component Table 18.2: Comparison of single texture and multitexture attributes, <a href="https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texturing.html#t-SingleAndMultitextureAttrs" target="_blank">https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texturing.html#t-SingleAndMultitextureAttrs</a> Hint: MultiTexture does not need to be included in LoadSensor watchList since any child ImageTexture and MovieTexture nodes of interest can be handled separately. Warning: MultiTexture may not contain another MultiTexture node. *


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

    • FUNCTION_COMPLEMENT

      public static final String FUNCTION_COMPLEMENT
      Tooltip: Invert argument x as (1 - x). MFString field named function with X3DUOM simpleType multiTextureFunctionValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "COMPLEMENT" (Java syntax) or '"COMPLEMENT"' (XML syntax).
      See Also:

    • FUNCTION_ALPHAREPLICATE

      public static final String FUNCTION_ALPHAREPLICATE
      Tooltip: Replicate alpha information to all color channels before operation completes. MFString field named function with X3DUOM simpleType multiTextureFunctionValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "ALPHAREPLICATE" (Java syntax) or '"ALPHAREPLICATE"' (XML syntax).
      See Also:

    • FUNCTION_

      public static final String FUNCTION_
      Tooltip: No function is applied - empty SFString is allowed value within MFString array. MFString field named function with X3DUOM simpleType multiTextureFunctionValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "" (Java syntax) or '""' (XML syntax).
      See Also:

    • MODE_ADD

      public static final String MODE_ADD
      MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "ADD" (Java syntax) or '"ADD"' (XML syntax).
      See Also:

    • MODE_ADDSIGNED

      public static final String MODE_ADDSIGNED
      MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "ADDSIGNED" (Java syntax) or '"ADDSIGNED"' (XML syntax).
      See Also:

    • MODE_ADDSIGNED2X

      public static final String MODE_ADDSIGNED2X
      MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "ADDSIGNED2X" (Java syntax) or '"ADDSIGNED2X"' (XML syntax).
      See Also:

    • MODE_ADDSMOOTH

      public static final String MODE_ADDSMOOTH
      MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "ADDSMOOTH" (Java syntax) or '"ADDSMOOTH"' (XML syntax).
      See Also:

    • MODE_BLENDCURRENTALPHA

      public static final String MODE_BLENDCURRENTALPHA
      MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "BLENDCURRENTALPHA" (Java syntax) or '"BLENDCURRENTALPHA"' (XML syntax).
      See Also:

    • MODE_BLENDDIFFUSEALPHA

      public static final String MODE_BLENDDIFFUSEALPHA
      MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "BLENDDIFFUSEALPHA" (Java syntax) or '"BLENDDIFFUSEALPHA"' (XML syntax).
      See Also:

    • MODE_BLENDFACTORALPHA

      public static final String MODE_BLENDFACTORALPHA
      MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "BLENDFACTORALPHA" (Java syntax) or '"BLENDFACTORALPHA"' (XML syntax).
      See Also:

    • MODE_BLENDTEXTUREALPHA

      public static final String MODE_BLENDTEXTUREALPHA
      MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "BLENDTEXTUREALPHA" (Java syntax) or '"BLENDTEXTUREALPHA"' (XML syntax).
      See Also:

    • MODE_DOTPRODUCT3

      public static final String MODE_DOTPRODUCT3
      MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "DOTPRODUCT3" (Java syntax) or '"DOTPRODUCT3"' (XML syntax).
      See Also:

    • MODE_MODULATE

      public static final String MODE_MODULATE
      MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "MODULATE" (Java syntax) or '"MODULATE"' (XML syntax).
      See Also:

    • MODE_MODULATE2X

      public static final String MODE_MODULATE2X
      MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "MODULATE2X" (Java syntax) or '"MODULATE2X"' (XML syntax).
      See Also:

    • MODE_MODULATE4X

      public static final String MODE_MODULATE4X
      MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "MODULATE4X" (Java syntax) or '"MODULATE4X"' (XML syntax).
      See Also:

    • MODE_MODULATEALPHA_ADDCOLOR

      public static final String MODE_MODULATEALPHA_ADDCOLOR
      MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "MODULATEALPHA_ADDCOLOR" (Java syntax) or '"MODULATEALPHA_ADDCOLOR"' (XML syntax).
      See Also:

    • MODE_MODULATEINVALPHA_ADDCOLOR

      public static final String MODE_MODULATEINVALPHA_ADDCOLOR
      MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "MODULATEINVALPHA_ADDCOLOR" (Java syntax) or '"MODULATEINVALPHA_ADDCOLOR"' (XML syntax).
      See Also:

    • MODE_MODULATEINVCOLOR_ADDALPHA

      public static final String MODE_MODULATEINVCOLOR_ADDALPHA
      MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "MODULATEINVCOLOR_ADDALPHA" (Java syntax) or '"MODULATEINVCOLOR_ADDALPHA"' (XML syntax).
      See Also:

    • MODE_OFF

      public static final String MODE_OFF
      MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "OFF" (Java syntax) or '"OFF"' (XML syntax).
      See Also:

    • MODE_REPLACE

      public static final String MODE_REPLACE
      MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "REPLACE" (Java syntax) or '"REPLACE"' (XML syntax).
      See Also:

    • MODE_SELECTARG1

      public static final String MODE_SELECTARG1
      MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "SELECTARG1" (Java syntax) or '"SELECTARG1"' (XML syntax).
      See Also:

    • MODE_SELECTARG2

      public static final String MODE_SELECTARG2
      MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "SELECTARG2" (Java syntax) or '"SELECTARG2"' (XML syntax).
      See Also:

    • MODE_SUBTRACT

      public static final String MODE_SUBTRACT
      MFString field named mode with X3DUOM simpleType multiTextureModeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "SUBTRACT" (Java syntax) or '"SUBTRACT"' (XML syntax).
      See Also:

    • SOURCE_DIFFUSE

      public static final String SOURCE_DIFFUSE
      MFString field named source with X3DUOM simpleType multiTextureSourceValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "DIFFUSE" (Java syntax) or '"DIFFUSE"' (XML syntax).
      See Also:

    • SOURCE_FACTOR

      public static final String SOURCE_FACTOR
      MFString field named source with X3DUOM simpleType multiTextureSourceValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "FACTOR" (Java syntax) or '"FACTOR"' (XML syntax).
      See Also:

    • SOURCE_SPECULAR

      public static final String SOURCE_SPECULAR
      MFString field named source with X3DUOM simpleType multiTextureSourceValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "SPECULAR" (Java syntax) or '"SPECULAR"' (XML syntax).
      See Also:

    • SOURCE_

      public static final String SOURCE_
      MFString field named source with X3DUOM simpleType multiTextureSourceValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "" (Java syntax) or '""' (XML syntax).
      See Also:

    • NAME

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

    • COMPONENT

      public static final String COMPONENT
      String constant COMPONENT defines X3D component for the MultiTexture element: Texturing
      See Also:

    • LEVEL

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

    • ALPHA_DEFAULT_VALUE

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

    • COLOR_DEFAULT_VALUE

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

    • DESCRIPTION_DEFAULT_VALUE

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

    • FUNCTION_DEFAULT_VALUE

      public static final ArrayList<String> FUNCTION_DEFAULT_VALUE
      MFString field named function has default value equal to an empty list.

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

    • MODE_DEFAULT_VALUE

      public static final ArrayList<String> MODE_DEFAULT_VALUE
      MFString field named mode has default value equal to an empty list.

    • SOURCE_DEFAULT_VALUE

      public static final ArrayList<String> SOURCE_DEFAULT_VALUE
      MFString field named source has default value equal to an empty list.

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

      public static final String fromField_ALPHA
      fromField ROUTE name for SFFloat field named alpha.
      See Also:

    • toField_ALPHA

      public static final String toField_ALPHA
      toField ROUTE name for SFFloat field named alpha.
      See Also:

    • fromField_COLOR

      public static final String fromField_COLOR
      fromField ROUTE name for SFColor field named color.
      See Also:

    • toField_COLOR

      public static final String toField_COLOR
      toField ROUTE name for SFColor field named color.
      See Also:

    • fromField_DESCRIPTION

      public static final String fromField_DESCRIPTION
      fromField ROUTE name for SFString field named description.
      See Also:

    • toField_DESCRIPTION

      public static final String toField_DESCRIPTION
      toField ROUTE name for SFString field named description.
      See Also:

    • fromField_FUNCTION

      public static final String fromField_FUNCTION
      fromField ROUTE name for MFString field named function.
      See Also:

    • toField_FUNCTION

      public static final String toField_FUNCTION
      toField ROUTE name for MFString field named function.
      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_MODE

      public static final String fromField_MODE
      fromField ROUTE name for MFString field named mode.
      See Also:

    • toField_MODE

      public static final String toField_MODE
      toField ROUTE name for MFString field named mode.
      See Also:

    • fromField_SOURCE

      public static final String fromField_SOURCE
      fromField ROUTE name for MFString field named source.
      See Also:

    • toField_SOURCE

      public static final String toField_SOURCE
      toField ROUTE name for MFString field named source.
      See Also:

    • fromField_TEXTURE

      public static final String fromField_TEXTURE
      fromField ROUTE name for MFNode field named texture.
      See Also:

    • toField_TEXTURE

      public static final String toField_TEXTURE
      toField ROUTE name for MFNode field named texture.
      See Also:

  • Constructor Details

    • MultiTexture

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

    • MultiTexture

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

    • getComponent

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

    • getAlpha

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

      Tooltip: [0,1] The alpha field defines the alpha (1-transparency) base value for mode operations. *
      Specified by:
      getAlpha in interface MultiTexture
      Returns:
      value of alpha field

    • setAlpha

      public MultiTexture setAlpha(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named alpha.

      Tooltip: [0,1] The alpha field defines the alpha (1-transparency) base value for mode operations. *
      Specified by:
      setAlpha in interface MultiTexture
      Parameters:
      newValue - is new value for the alpha field.
      Returns:
      MultiTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setAlpha

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

    • setAlpha

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

    • getColor

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

      Tooltip: [0,1] The color field defines the RGB base values for mode operations. 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> *
      Specified by:
      getColor in interface MultiTexture
      Returns:
      value of color field

    • setColor

      public MultiTexture setColor(float[] newValue)
      Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput SFColor field named color.

      Tooltip: [0,1] The color field defines the RGB base values for mode operations. 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> *
      Specified by:
      setColor in interface MultiTexture
      Parameters:
      newValue - is new value for the color field.
      Returns:
      MultiTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setColor

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

    • setColor

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

    • setColor

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

    • setColor

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

    • getDescription

      public String getDescription()
      Provide String value from inputOutput SFString field named description.

      Tooltip: Author-provided prose that describes intended purpose of the url asset. Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as &#38; for & ampersand character, or &#34; for " quotation-mark character). *
      Specified by:
      getDescription in interface MultiTexture
      Specified by:
      getDescription in interface X3DTextureNode
      Returns:
      value of description field

    • setDescription

      public MultiTexture setDescription(String newValue)
      Accessor method to assign String value to inputOutput SFString field named description.

      Tooltip: Author-provided prose that describes intended purpose of the url asset. Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as &#38; for & ampersand character, or &#34; for " quotation-mark character). *
      Specified by:
      setDescription in interface MultiTexture
      Specified by:
      setDescription in interface X3DTextureNode
      Parameters:
      newValue - is new value for the description field.
      Returns:
      MultiTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setDescription

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

    • getFunction

      public String[] getFunction()
      Provide array of String enumeration results (baseType MFString) ['"COMPLEMENT"' | '"ALPHAREPLICATE"' | '""' | '"etc."'] from inputOutput MFString field named function.

      Tooltip: function operators COMPLEMENT or ALPHAREPLICATE can be applied after the mode blending operation. Empty string value "" indicates that no function operation is applied for that stage. Hint: include the same number of function values as textures, otherwise the default of no function operation is applied for each remaining stage. Hint: X3D Architecture Table 18.5 Values for the function field <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html#t-ValuesForFunctionField" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html#t-ValuesForFunctionField</a> for further details. *


      Available enumeration values for string comparison: COMPLEMENT, ALPHAREPLICATE, FUNCTION_.
      Specified by:
      getFunction in interface MultiTexture
      Returns:
      value of function field

    • getFunctionList

      public ArrayList<String> getFunctionList()
      Utility method to get ArrayList value of MFString function field, similar to getFunction().
      Returns:
      value of function field

    • getFunctionString

      public String getFunctionString()
      Utility method to get String value of MFString function field, similar to getFunction().
      Returns:
      value of function field

    • setFunction

      public MultiTexture setFunction(String[] newValue)
      Accessor method to assign String enumeration array (""COMPLEMENT"" | ""ALPHAREPLICATE"" | """") to inputOutput MFString field named function.

      Hint: authors have option to choose from an extendible list of predefined enumeration values (COMPLEMENT, ALPHAREPLICATE, FUNCTION_).

      Tooltip: function operators COMPLEMENT or ALPHAREPLICATE can be applied after the mode blending operation. Empty string value "" indicates that no function operation is applied for that stage. Hint: include the same number of function values as textures, otherwise the default of no function operation is applied for each remaining stage. Hint: X3D Architecture Table 18.5 Values for the function field <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html#t-ValuesForFunctionField" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html#t-ValuesForFunctionField</a> for further details. *
      Specified by:
      setFunction in interface MultiTexture
      Parameters:
      newValue - is new value for the function field.
      Returns:
      MultiTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setFunction

      public MultiTexture setFunction(MFString newValue)
      Assign typed object value to MFString function field, similar to setFunction(String[]). // #0.e
      Parameters:
      newValue - is new value for the function field.
      Returns:
      MultiTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setFunction

      public MultiTexture setFunction(SFString newValue)
      Assign single SFString object value to MFString function field, similar to setFunction(String[]).
      Parameters:
      newValue - is new value for the function field.
      Returns:
      MultiTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • setFunction

      public MultiTexture setFunction(String newValue)
      Assign singleton String value to MFString function field, similar to setFunction(String[]).
      Parameters:
      newValue - is new value for the function field.
      Returns:
      MultiTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • setFunction

      public MultiTexture setFunction(ArrayList<String> newValue)
      Assign ArrayList value of MFString function field, similar to setFunction(String[]).
      Parameters:
      newValue - is new value for the function field.
      Returns:
      MultiTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • clearFunction

      public MultiTexture clearFunction()
      Utility method to clear MFString value of function field.
      Returns:
      MultiTexture - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • addFunction

      public MultiTexture addFunction(String newValue)
      Add singleton String value to MFString function field.
      Parameters:
      newValue - is new value to add to the function field.
      Returns:
      MultiTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • addFunction

      public MultiTexture addFunction(SFString newValue)
      Add singleton SFString value to MFString function field.
      Parameters:
      newValue - is new value to add to the function field.
      Returns:
      MultiTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

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

    • clearIS

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

    • clearMetadata

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

    • setMetadata

      public MultiTexture 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:
      MultiTexture - 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:

    • getMode

      public String[] getMode()
      Provide array of String enumeration results (baseType MFString) ['"ADD"' | '"ADDSIGNED"' | '"ADDSIGNED2X"' | '"ADDSMOOTH"' | '"BLENDCURRENTALPHA"' | '"BLENDDIFFUSEALPHA"' | '"BLENDFACTORALPHA"' | '"BLENDTEXTUREALPHA"' | '"DOTPRODUCT3"' | '"MODULATE"' | '"MODULATE2X"' | '"MODULATE4X"' | '"MODULATEALPHA_ADDCOLOR"' | '"MODULATEINVALPHA_ADDCOLOR"' | '"MODULATEINVCOLOR_ADDALPHA"' | '"OFF"' | '"REPLACE"' | '"SELECTARG1"' | '"SELECTARG2"' | '"SUBTRACT"' | '"etc."'] from inputOutput MFString field named mode.

      Tooltip: mode field indicates the type of blending operation, both for color and for alpha channel. Hint: include the same number of mode values as textures, otherwise the default value MODULATE is added for each remaining stage. Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values. Hint: X3D Architecture Table 18.3 Multitexture modes <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html#t-MultitextureModes" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html#t-MultitextureModes</a> for further details. *


      Available enumeration values for string comparison: ADD, ADDSIGNED, ADDSIGNED2X, ADDSMOOTH, BLENDCURRENTALPHA, BLENDDIFFUSEALPHA, BLENDFACTORALPHA, BLENDTEXTUREALPHA, DOTPRODUCT3, MODULATE, MODULATE2X, MODULATE4X, MODULATEALPHA_ADDCOLOR, MODULATEINVALPHA_ADDCOLOR, MODULATEINVCOLOR_ADDALPHA, OFF, REPLACE, SELECTARG1, SELECTARG2, SUBTRACT.
      Specified by:
      getMode in interface MultiTexture
      Returns:
      value of mode field

    • getModeList

      public ArrayList<String> getModeList()
      Utility method to get ArrayList value of MFString mode field, similar to getMode().
      Returns:
      value of mode field

    • getModeString

      public String getModeString()
      Utility method to get String value of MFString mode field, similar to getMode().
      Returns:
      value of mode field

    • setMode

      public MultiTexture setMode(String[] newValue)
      Accessor method to assign String enumeration array (""ADD"" | ""ADDSIGNED"" | ""ADDSIGNED2X"" | ""ADDSMOOTH"" | ""BLENDCURRENTALPHA"" | ""BLENDDIFFUSEALPHA"" | ""BLENDFACTORALPHA"" | ""BLENDTEXTUREALPHA"" | ""DOTPRODUCT3"" | ""MODULATE"" | ""MODULATE2X"" | ""MODULATE4X"" | ""MODULATEALPHA_ADDCOLOR"" | ""MODULATEINVALPHA_ADDCOLOR"" | ""MODULATEINVCOLOR_ADDALPHA"" | ""OFF"" | ""REPLACE"" | ""SELECTARG1"" | ""SELECTARG2"" | ""SUBTRACT"") to inputOutput MFString field named mode.

      Hint: authors have option to choose from an extendible list of predefined enumeration values (ADD, ADDSIGNED, ADDSIGNED2X, ADDSMOOTH, BLENDCURRENTALPHA, BLENDDIFFUSEALPHA, BLENDFACTORALPHA, BLENDTEXTUREALPHA, DOTPRODUCT3, MODULATE, MODULATE2X, MODULATE4X, MODULATEALPHA_ADDCOLOR, MODULATEINVALPHA_ADDCOLOR, MODULATEINVCOLOR_ADDALPHA, OFF, REPLACE, SELECTARG1, SELECTARG2, SUBTRACT).

      Tooltip: mode field indicates the type of blending operation, both for color and for alpha channel. Hint: include the same number of mode values as textures, otherwise the default value MODULATE is added for each remaining stage. Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values. Hint: X3D Architecture Table 18.3 Multitexture modes <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html#t-MultitextureModes" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html#t-MultitextureModes</a> for further details. *
      Specified by:
      setMode in interface MultiTexture
      Parameters:
      newValue - is new value for the mode field.
      Returns:
      MultiTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setMode

      public MultiTexture setMode(MFString newValue)
      Assign typed object value to MFString mode field, similar to setMode(String[]). // #0.e
      Parameters:
      newValue - is new value for the mode field.
      Returns:
      MultiTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setMode

      public MultiTexture setMode(SFString newValue)
      Assign single SFString object value to MFString mode field, similar to setMode(String[]).
      Parameters:
      newValue - is new value for the mode field.
      Returns:
      MultiTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • setMode

      public MultiTexture setMode(String newValue)
      Assign singleton String value to MFString mode field, similar to setMode(String[]).
      Parameters:
      newValue - is new value for the mode field.
      Returns:
      MultiTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • setMode

      public MultiTexture setMode(ArrayList<String> newValue)
      Assign ArrayList value of MFString mode field, similar to setMode(String[]).
      Parameters:
      newValue - is new value for the mode field.
      Returns:
      MultiTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • clearMode

      public MultiTexture clearMode()
      Utility method to clear MFString value of mode field.
      Returns:
      MultiTexture - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • addMode

      public MultiTexture addMode(String newValue)
      Add singleton String value to MFString mode field.
      Parameters:
      newValue - is new value to add to the mode field.
      Returns:
      MultiTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • addMode

      public MultiTexture addMode(SFString newValue)
      Add singleton SFString value to MFString mode field.
      Parameters:
      newValue - is new value to add to the mode field.
      Returns:
      MultiTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • getSource

      public String[] getSource()
      Provide array of String enumeration results (baseType MFString) ['"DIFFUSE"' | '"FACTOR"' | '"SPECULAR"' | '""' | '"etc."'] from inputOutput MFString field named source.

      Tooltip: source field determines whether each image source is treated as DIFFUSE, SPECULAR or a multiplicative FACTOR. Empty string value "" indicates that no source modifier is applied for that stage. Hint: include the same number of source values as textures, otherwise the default of no source interpretation is applied for each remaining stage. Hint: X3D Architecture Table 18.4 Values for the source field <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html#t-ValuesForSourceField" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html#t-ValuesForSourceField</a> for further details. *


      Available enumeration values for string comparison: DIFFUSE, FACTOR, SPECULAR, SOURCE_.
      Specified by:
      getSource in interface MultiTexture
      Returns:
      value of source field

    • getSourceList

      public ArrayList<String> getSourceList()
      Utility method to get ArrayList value of MFString source field, similar to getSource().
      Returns:
      value of source field

    • getSourceString

      public String getSourceString()
      Utility method to get String value of MFString source field, similar to getSource().
      Returns:
      value of source field

    • setSource

      public MultiTexture setSource(String[] newValue)
      Accessor method to assign String enumeration array (""DIFFUSE"" | ""FACTOR"" | ""SPECULAR"" | """") to inputOutput MFString field named source.

      Hint: authors have option to choose from an extendible list of predefined enumeration values (DIFFUSE, FACTOR, SPECULAR, SOURCE_).

      Tooltip: source field determines whether each image source is treated as DIFFUSE, SPECULAR or a multiplicative FACTOR. Empty string value "" indicates that no source modifier is applied for that stage. Hint: include the same number of source values as textures, otherwise the default of no source interpretation is applied for each remaining stage. Hint: X3D Architecture Table 18.4 Values for the source field <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html#t-ValuesForSourceField" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html#t-ValuesForSourceField</a> for further details. *
      Specified by:
      setSource in interface MultiTexture
      Parameters:
      newValue - is new value for the source field.
      Returns:
      MultiTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setSource

      public MultiTexture setSource(MFString newValue)
      Assign typed object value to MFString source field, similar to setSource(String[]). // #0.e
      Parameters:
      newValue - is new value for the source field.
      Returns:
      MultiTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setSource

      public MultiTexture setSource(SFString newValue)
      Assign single SFString object value to MFString source field, similar to setSource(String[]).
      Parameters:
      newValue - is new value for the source field.
      Returns:
      MultiTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • setSource

      public MultiTexture setSource(String newValue)
      Assign singleton String value to MFString source field, similar to setSource(String[]).
      Parameters:
      newValue - is new value for the source field.
      Returns:
      MultiTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • setSource

      public MultiTexture setSource(ArrayList<String> newValue)
      Assign ArrayList value of MFString source field, similar to setSource(String[]).
      Parameters:
      newValue - is new value for the source field.
      Returns:
      MultiTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • clearSource

      public MultiTexture clearSource()
      Utility method to clear MFString value of source field.
      Returns:
      MultiTexture - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • addSource

      public MultiTexture addSource(String newValue)
      Add singleton String value to MFString source field.
      Parameters:
      newValue - is new value to add to the source field.
      Returns:
      MultiTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • addSource

      public MultiTexture addSource(SFString newValue)
      Add singleton SFString value to MFString source field.
      Parameters:
      newValue - is new value to add to the source field.
      Returns:
      MultiTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • getTexture

      public X3DNode[] getTexture()
      Provide array of org.web3d.x3d.sai.Texturing.X3DSingleTextureNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field texture.

      Tooltip: [X3DSingleTextureNode] Contained texture nodes (ImageTexture, MovieTexture, PixelTexture) that map image(s) to surface geometry, defining each of the different texture channels. Warning: MultiTexture may not contain another MultiTexture node. Hint: if texture node is NULL or unspecified, corresponding Shape geometry for this Appearance is not textured. Hint: X3D Scene Authoring Hints, Images <a href="https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Images" target="_blank">https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Images</a> Hint: X3D Architecture 18 Texturing component <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html</a> Hint: X3D Architecture 33 Texturing3D component <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texture3D.html" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texture3D.html</a> *


      Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DSingleTextureNode.
      Specified by:
      getTexture in interface MultiTexture
      Returns:
      value of texture field
      See Also:

    • getTextureList

      public ArrayList<X3DNode> getTextureList()
      Utility method to get ArrayList value of MFNode texture field, similar to getTexture().
      Returns:
      value of texture field

    • setTexture

      public MultiTexture setTexture(X3DNode[] newValue)
      Accessor method to assign org.web3d.x3d.sai.Texturing.X3DSingleTextureNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field texture.

      Tooltip: [X3DSingleTextureNode] Contained texture nodes (ImageTexture, MovieTexture, PixelTexture) that map image(s) to surface geometry, defining each of the different texture channels. Warning: MultiTexture may not contain another MultiTexture node. Hint: if texture node is NULL or unspecified, corresponding Shape geometry for this Appearance is not textured. Hint: X3D Scene Authoring Hints, Images <a href="https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Images" target="_blank">https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Images</a> Hint: X3D Architecture 18 Texturing component <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html</a> Hint: X3D Architecture 33 Texturing3D component <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texture3D.html" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texture3D.html</a> *


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

    • setTexture

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

    • addTexture

      public MultiTexture addTexture(X3DNode newValue)
      Add single child node to existing array of texture nodes (if any).

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

    • addTexture

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

    • addTexture

      public void addTexture(X3DNode[] newValue)
      Add array of child texture nodes to array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DSingleTextureNode.
      Specified by:
      addTexture in interface MultiTexture
      Parameters:
      newValue - is new value array to be appended the texture field.

    • setTexture

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

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to X3DSingleTextureNode.
      Specified by:
      setTexture in interface MultiTexture
      Parameters:
      newValue - is new node for the texture field (restricted to X3DSingleTextureNode)

    • clearTexture

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

    • hasTexture

      public boolean hasTexture()
      Indicate whether an object is available for inputOutput MFNode field texture.
      Returns:
      whether a properly typed node or ProtoInstance array or CommentsBlock is available.
      See Also:

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

    • setDEF

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

    • setUSE

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

    • setCssClass

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

    • setHtmlID

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

    • setCssStyle

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

    • setUSE

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

    • addComments

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

    • addComments

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

    • addComments

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