org.web3d.x3d.sai.Texturing

Interface MultiTexture

All Superinterfaces:

X3DAppearanceChildNode, X3DNode, X3DTextureNode

All Known Implementing Classes:

MultiTextureObject

public interface MultiTexture
extends X3DTextureNode

Abstract node interface, defined by X3D specification to support X3D Java interoperability.

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.

• Hint: insert Shape and Appearance nodes before adding texture.
• Hint: Texture mapping
  https://en.wikipedia.org/wiki/Texture_mapping
• 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: X3D Texturing component Figure 18.2 Lightmap example,
  http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texturing.html#f-Lightmapexample
• Hint: X3D Texturing component Table 18.2: Comparison of single texture and multitexture attributes,
  http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texturing.html#t-SingleAndMultitextureAttrs
• 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.

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 and 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 ['"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 ['"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 ['"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) Assign float value within allowed range of [0,1] to inputOutput SFFloat field named alpha.
MultiTexture	setColor(float[] newValue) Assign 3-tuple float array using RGB values [0..1] using RGB values [0..1] to inputOutput SFColor field named color.
MultiTexture	setCssClass(java.lang.String newValue) Assign String value to inputOutput SFString field named class.
MultiTexture	setDEF(java.lang.String newValue) Assign String value to inputOutput SFString field named DEF.
MultiTexture	setFunction(java.lang.String[] newValue) Assign String enumeration array (""COMPLEMENT""|""ALPHAREPLICATE"") ['"COMPLEMENT"'|'"ALPHAREPLICATE"'|'"etc."'] to inputOutput MFString field named function.
MultiTexture	setMetadata(X3DMetadataObject newValue) Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
MultiTexture	setMode(java.lang.String[] newValue) 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"") ['"ADD"'|'"ADDSIGNED"'|'"ADDSIGNED2X"'|'"ADDSMOOTH"'|'"BLENDCURRENTALPHA"'|'"BLENDDIFFUSEALPHA"'|'"BLENDFACTORALPHA"'|'"BLENDTEXTUREALPHA"'|'"DOTPRODUCT3"'|'"MODULATE"'|'"MODULATE2X"'|'"MODULATE4X"'|'"MODULATEALPHA_ADDCOLOR"'|'"MODULATEINVALPHA_ADDCOLOR"'|'"MODULATEINVCOLOR_ADDALPHA"'|'"OFF"'|'"REPLACE"'|'"SELECTARG1"'|'"SELECTARG2"'|'"SUBTRACT"'|'"etc."'] to inputOutput MFString field named mode.
MultiTexture	setSource(java.lang.String[] newValue) Assign String enumeration array (""DIFFUSE""|""FACTOR""|""SPECULAR"") ['"DIFFUSE"'|'"FACTOR"'|'"SPECULAR"'|'"etc."'] 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) Assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field texture.
MultiTexture	setUSE(java.lang.String newValue) Assign String value to inputOutput SFString field named USE.

Method Detail

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)

Assign float value within allowed range of [0,1] 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.

• Hint: X3D Scene Authoring Hints, Color
  http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color

Returns:

value of color field

setColor

MultiTexture setColor(float[] newValue)

Assign 3-tuple float array using RGB values [0..1] 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 http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color

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 ['"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
  http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texturing.html#t-ValuesForFunctionField for further details.

Returns:

value of function field

setFunction

MultiTexture setFunction(java.lang.String[] newValue)

Assign String enumeration array (""COMPLEMENT""|""ALPHAREPLICATE"") ['"COMPLEMENT"'|'"ALPHAREPLICATE"'|'"etc."'] 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. 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 http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texturing.html#t-ValuesForFunctionField for further details.

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.

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)

Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

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 ['"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
  http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texturing.html#t-MultitextureModes for further details.

Returns:

value of mode field

setMode

MultiTexture setMode(java.lang.String[] newValue)

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"") ['"ADD"'|'"ADDSIGNED"'|'"ADDSIGNED2X"'|'"ADDSMOOTH"'|'"BLENDCURRENTALPHA"'|'"BLENDDIFFUSEALPHA"'|'"BLENDFACTORALPHA"'|'"BLENDTEXTUREALPHA"'|'"DOTPRODUCT3"'|'"MODULATE"'|'"MODULATE2X"'|'"MODULATE4X"'|'"MODULATEALPHA_ADDCOLOR"'|'"MODULATEINVALPHA_ADDCOLOR"'|'"MODULATEINVCOLOR_ADDALPHA"'|'"OFF"'|'"REPLACE"'|'"SELECTARG1"'|'"SELECTARG2"'|'"SUBTRACT"'|'"etc."'] to 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 http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texturing.html#t-MultitextureModes for further details.

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 ['"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
  http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texturing.html#t-ValuesForSourceField for further details.

Returns:

value of source field

setSource

MultiTexture setSource(java.lang.String[] newValue)

Assign String enumeration array (""DIFFUSE""|""FACTOR""|""SPECULAR"") ['"DIFFUSE"'|'"FACTOR"'|'"SPECULAR"'|'"etc."'] 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. 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 http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texturing.html#t-ValuesForSourceField for further details.

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: 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
  http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Images
• Hint: X3D Architecture 18 Texturing component
  http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texturing.html
• Hint: X3D Architecture 33 Texturing3D component
  http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texture3D.html

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)

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. 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 http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Images Hint: X3D Architecture 18 Texturing component http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texturing.html Hint: X3D Architecture 33 Texturing3D component http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texture3D.html

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

setDEF

MultiTexture setDEF(java.lang.String newValue)

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 http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

Note that setting the DEF value clears the USE value.

Specified by:

setDEF in interface X3DAppearanceChildNode

Specified by:

setDEF in interface X3DNode

Specified by:

setDEF in interface X3DTextureNode

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

setUSE

MultiTexture setUSE(java.lang.String newValue)

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 interface X3DAppearanceChildNode

Specified by:

setUSE in interface X3DNode

Specified by:

setUSE in interface X3DTextureNode

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

setCssClass

MultiTexture setCssClass(java.lang.String newValue)

Assign String value to inputOutput SFString field named class.

Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets. Warning: currently the class attribute is only supported in XML encoding of X3D scenes. Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS

Specified by:

setCssClass in interface X3DAppearanceChildNode

Specified by:

setCssClass in interface X3DNode

Specified by:

setCssClass in interface X3DTextureNode

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