Package org.web3d.x3d.sai.Texturing

Interface MultiTexture

All Superinterfaces:
X3DAppearanceChildNode, X3DNode, X3DTextureNode
All Known Implementing Classes:
MultiTextureObject
public interface MultiTexture
extends X3DTextureNode
MultiTexture applies several individual textures to a single geometry node, enabling a variety of visual effects that include light mapping and environment mapping.

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 and PixelTexture 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.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:
SAI Java Specification: TODO, X3D Abstract Specification: MultiTexture, X3D Tooltips: MultiTexture, X3D Scene Authoring Hints: Images

  • Method Summary

    Modifier and Type Method Description
    void addTexture​(X3DNode[] newValue)
    Add array of child texture nodes to array of existing nodes (if any).
    float getAlpha()
    Provide float value within allowed range of [0,1] from inputOutput SFFloat field named alpha.
    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.
    java.lang.String[] getFunction()
    Provide array of String enumeration results (baseType multiTextureFunctionValues) ['"COMPLEMENT"' | '"ALPHAREPLICATE"' | '""' | '"etc."'] from inputOutput MFString field named function.
    X3DMetadataObject getMetadata()
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    java.lang.String[] getMode()
    Provide array of String enumeration results (baseType multiTextureModeValues) ['"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.
    java.lang.String[] getSource()
    Provide array of String enumeration results (baseType multiTextureSourceValues) ['"DIFFUSE"' | '"FACTOR"' | '"SPECULAR"' | '""' | '"etc."'] from inputOutput MFString field named source.
    X3DNode[] getTexture()
    Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field texture.
    MultiTexture setAlpha​(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named alpha.
    MultiTexture setColor​(float[] newValue)
    Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput SFColor field named color.
    MultiTexture setFunction​(java.lang.String[] newValue)
    Accessor method to assign String enumeration array (""COMPLEMENT"" | ""ALPHAREPLICATE"" | """") to inputOutput MFString field named function.
    MultiTexture setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    MultiTexture setMode​(java.lang.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.
    MultiTexture setSource​(java.lang.String[] newValue)
    Accessor method to assign String enumeration array (""DIFFUSE"" | ""FACTOR"" | ""SPECULAR"" | """") to inputOutput MFString field named source.
    void setTexture​(X3DNode newValue)
    Set single child texture node, replacing prior array of existing nodes (if any).
    MultiTexture setTexture​(X3DNode[] newValue)
    Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field texture.

  • Method Details

    • getAlpha

      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. *
      Returns:
      value of alpha field

    • setAlpha

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

    • getColor

      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.
      Returns:
      value of color field

    • setColor

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

    • getFunction

      java.lang.String[] getFunction()
      Provide array of String enumeration results (baseType multiTextureFunctionValues) ['"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.
      Returns:
      value of function field

    • setFunction

      MultiTexture setFunction​(java.lang.String[] newValue)
      Accessor method to assign String enumeration array (""COMPLEMENT"" | ""ALPHAREPLICATE"" | """") to 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.
      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).

    • getMetadata

      X3DMetadataObject getMetadata()
      Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
      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:
      X3D Scene Authoring Hints: Metadata Nodes

    • setMetadata

      MultiTexture setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
      Specified by:
      setMetadata in interface X3DAppearanceChildNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DTextureNode
      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:
      X3D Scene Authoring Hints: Metadata Nodes

    • getMode

      java.lang.String[] getMode()
      Provide array of String enumeration results (baseType multiTextureModeValues) ['"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.
      Returns:
      value of mode field

    • setMode

      MultiTexture setMode​(java.lang.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.

      Tooltip: mode field indicates the type of blending operation, both for color and for alpha channel.
      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).

    • getSource

      java.lang.String[] getSource()
      Provide array of String enumeration results (baseType multiTextureSourceValues) ['"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.
      Returns:
      value of source field

    • setSource

      MultiTexture setSource​(java.lang.String[] newValue)
      Accessor method to assign String enumeration array (""DIFFUSE"" | ""FACTOR"" | ""SPECULAR"" | """") to 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.
      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).

    • getTexture

      X3DNode[] getTexture()
      Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field texture.

      Tooltip: [X3DTextureNode] Contained texture nodes (ImageTexture, MovieTexture, PixelTexture) that map image(s) to surface geometry, defining each of the different texture channels.

      Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DTextureNode.
      Returns:
      value of texture field
      See Also:
      X3DTextureNode

    • setTexture

      MultiTexture setTexture​(X3DNode[] newValue)
      Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field texture.

      Tooltip: [X3DTextureNode] Contained texture nodes (ImageTexture, MovieTexture, PixelTexture) that map image(s) to surface geometry, defining each of the different texture channels.

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DTextureNode.
      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

      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 X3DTextureNode.
      Parameters:
      newValue - is new value array to be appended the texture field.

    • setTexture

      void setTexture​(X3DNode newValue)
      Set single child texture node, replacing prior array of existing nodes (if any).
      Parameters:
      newValue - is new node for the texture field