org.web3d.x3d.sai.Texturing

Interface MultiTextureTransform

All Superinterfaces:

X3DAppearanceChildNode, X3DNode, X3DTextureTransformNode

All Known Implementing Classes:

MultiTextureTransformObject

public interface MultiTextureTransform
extends X3DTextureTransformNode

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

X3D node tooltip: [X3DTextureTransformNode] MultiTextureTransform contains multiple TextureTransform nodes, each provided for use by corresponding ImageTexture MovieTexture or PixelTexture nodes within a sibling MultiTexture node.

• Hint: insert Shape and Appearance nodes before adding MultiTextureTransform.
• 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
• Warning: MultiTextureTransform may not contain another MultiTextureTransform 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: MultiTextureTransform, X3D Tooltips: MultiTextureTransform, X3D Scene Authoring Hints: Images

Method Summary

Modifier and Type	Method and Description
void	addTextureTransform(X3DNode[] newValue) Add array of child textureTransform nodes to array of existing nodes (if any).
X3DMetadataObject	getMetadata() Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
X3DNode[]	getTextureTransform() Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field textureTransform.
MultiTextureTransform	setCssClass(java.lang.String newValue) Assign String value to inputOutput SFString field named class.
MultiTextureTransform	setDEF(java.lang.String newValue) Assign String value to inputOutput SFString field named DEF.
MultiTextureTransform	setMetadata(X3DMetadataObject newValue) Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
void	setTextureTransform(X3DNode newValue) Set single child textureTransform node, replacing prior array of existing nodes (if any).
MultiTextureTransform	setTextureTransform(X3DNode[] newValue) Assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field textureTransform.
MultiTextureTransform	setUSE(java.lang.String newValue) Assign String value to inputOutput SFString field named USE.

Method Detail

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 X3DTextureTransformNode

Returns:

value of metadata field

See Also:

X3D Scene Authoring Hints: Metadata Nodes

setMetadata

MultiTextureTransform 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 X3DTextureTransformNode

Parameters:

newValue - is new value for the metadata field.

Returns:

MultiTextureTransform - 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

getTextureTransform

X3DNode[] getTextureTransform()

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

Tooltip: [X3DTextureTransformNode] Zero or more contained TextureTransform nodes, for each of the different texture channels, that define 2D transformation applied to texture coordinates.

• Hint: if textureTransform is NULL or unspecified, this field has no effect.
• Warning: MultiTextureTransform may not contain another MultiTextureTransform node.

Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DTextureTransformNode.

Returns:

value of textureTransform field

See Also:

X3DTextureTransformNode

setTextureTransform

MultiTextureTransform setTextureTransform(X3DNode[] newValue)

Assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field textureTransform.

Tooltip: [X3DTextureTransformNode] Zero or more contained TextureTransform nodes, for each of the different texture channels, that define 2D transformation applied to texture coordinates. Hint: if textureTransform is NULL or unspecified, this field has no effect. Warning: MultiTextureTransform may not contain another MultiTextureTransform node.

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DTextureTransformNode.

Parameters:

newValue - is new value for the textureTransform field.

Returns:

MultiTextureTransform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addTextureTransform

void addTextureTransform(X3DNode[] newValue)

Add array of child textureTransform nodes to array of existing nodes (if any).

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DTextureTransformNode.

Parameters:

newValue - is new value array to be appended the textureTransform field.

setTextureTransform

void setTextureTransform(X3DNode newValue)

Set single child textureTransform node, replacing prior array of existing nodes (if any).

Parameters:

newValue - is new node for the textureTransform field

setDEF

MultiTextureTransform 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 X3DTextureTransformNode

Parameters:

newValue - is new value for the DEF field.

Returns:

MultiTextureTransform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUSE

MultiTextureTransform 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 X3DTextureTransformNode

Parameters:

newValue - is new value for the USE field.

Returns:

MultiTextureTransform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setCssClass

MultiTextureTransform 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 X3DTextureTransformNode

Parameters:

newValue - is new value for the class field.

Returns:

MultiTextureTransform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).