Class MultiTextureTransform

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.Texturing.MultiTextureTransform

All Implemented Interfaces:

X3DNode, X3DAppearanceChildNode, MultiTextureTransform, X3DTextureTransformNode

public class MultiTextureTransform
extends X3DConcreteNode
implements MultiTextureTransform

MultiTextureTransform contains multiple TextureTransform nodes, each provided for use by corresponding ImageTexture MovieTexture or PixelTexture nodes within a sibling MultiTexture node.

MultiTextureTransform 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, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/texturing.html#f-Lightmapexample
• Hint: X3D Texturing component Table 18.2: Comparison of single texture and multitexture attributes, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/texturing.html#t-SingleAndMultitextureAttrs
• Warning: MultiTextureTransform may not contain another MultiTextureTransform 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:

• X3D Abstract Specification: MultiTextureTransform
• X3D Tooltips: MultiTextureTransform
• X3D Scene Authoring Hints: Images

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT	String constant COMPONENT defines X3D component for the MultiTextureTransform element: Texturing
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final String	fromField_IS	fromField ROUTE name for SFNode field named IS.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
static final String	fromField_TEXTURETRANSFORM	fromField ROUTE name for MFNode field named textureTransform.
static final IS	IS_DEFAULT_VALUE	SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
static final int	LEVEL	Integer constant LEVEL provides default X3D Texturing component level for this element: 2
static final X3DMetadataObject	METADATA_DEFAULT_VALUE	SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
static final String	NAME	String constant NAME provides name of this element: MultiTextureTransform.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_TEXTURETRANSFORM	toField ROUTE name for MFNode field named textureTransform.

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode

containerField_ALLOWED_VALUES, containerFieldOverride

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement

validationResult

Constructor Summary

Constructors

Constructor	Description
MultiTextureTransform()	Constructor for MultiTextureTransform to initialize member variables with default values.
MultiTextureTransform(String DEFlabel)	Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
MultiTextureTransform	addComments(String newComment)	Add comment as String to contained commentsList.
MultiTextureTransform	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
MultiTextureTransform	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
MultiTextureTransform	addTextureTransform(ProtoInstance newValue)	Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for textureTransform field.
MultiTextureTransform	addTextureTransform(X3DNode newValue)	Add single child node to existing array of textureTransform nodes (if any).
void	addTextureTransform(X3DNode[] newValue)	Add array of child textureTransform nodes to array of existing nodes (if any).
MultiTextureTransform	clearIS()	Utility method to clear SFNode value of IS field.
MultiTextureTransform	clearMetadata()	Utility method to clear SFNode value of metadata field.
MultiTextureTransform	clearTextureTransform()	Utility method to clear MFNode value of textureTransform field.
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.
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.
X3DConcreteNode	findNodeByDEF(String DEFvalue)	Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
String	getAccessType(String fieldName)	Indicate accessType corresponding to given fieldName.
final String	getComponent()	Defines X3D component for the MultiTextureTransform element: Texturing
final int	getComponentLevel()	Provides default X3D component level for this element: 2
final String	getContainerFieldDefault()	containerField describes typical field relationship of a node to its parent.
String	getCssClass()	Provide String value from inputOutput SFString field named class.
String	getCssStyle()	Provide String value from inputOutput SFString field named style.
String	getDEF()	Provide String value from inputOutput SFString field named DEF.
final String	getElementName()	Provides name of this element: MultiTextureTransform
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
String	getHtmlId()	Provide String value from inputOutput SFString field named id.
IS	getIS()	Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
static final IS	getISDefault()	Public accessor for encapsulated SFNode default value null, returned as IS.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
static final X3DMetadataObject	getMetadataDefault()	Public accessor for encapsulated SFNode default value null, returned as org.web3d.x3d.sai.Core.X3DMetadataObject.
X3DNode[]	getTextureTransform()	Provide array of org.web3d.x3d.sai.Texturing.X3DSingleTextureTransformNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field textureTransform.
ArrayList<X3DNode>	getTextureTransformList()	Utility method to get ArrayList value of MFNode textureTransform field, similar to getTextureTransform().
String	getUSE()	Provide String value from inputOutput SFString field named USE.
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.
boolean	hasIS()	Indicate whether an object is available for inputOutput SFNode field IS.
boolean	hasMetadata()	Indicate whether an object is available for inputOutput SFNode field metadata.
boolean	hasNodeByDEF(String DEFvalue)	Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
boolean	hasTextureTransform()	Indicate whether an object is available for inputOutput MFNode field textureTransform.
final void	initialize()	Initialize all member variables to default values.
final MultiTextureTransform	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
MultiTextureTransform	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final MultiTextureTransform	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
MultiTextureTransform	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final MultiTextureTransform	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
MultiTextureTransform	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
final MultiTextureTransform	setHtmlId(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
MultiTextureTransform	setHtmlId(SFString newValue)	Assign typed object value to SFString HtmlId field, similar to setHtmlId(String).
MultiTextureTransform	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
MultiTextureTransform	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
MultiTextureTransform	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
MultiTextureTransform	setTextureTransform(ArrayList<X3DSingleTextureTransformNode> newValue)	Assign ArrayList value of MFNode textureTransform field, similar to setTextureTransform(org.web3d.x3d.sai.Core.X3DNode[]).
void	setTextureTransform(X3DNode newValue)	Set single child textureTransform node, replacing prior array of existing nodes (if any).
MultiTextureTransform	setTextureTransform(X3DNode[] newValue)	Accessor method to assign org.web3d.x3d.sai.Texturing.X3DSingleTextureTransformNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field textureTransform.
final MultiTextureTransform	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
MultiTextureTransform	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
MultiTextureTransform	setUSE(MultiTextureTransform DEFnode)	Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
String	toStringClassicVRML(int indentLevel)	Recursive method to provide ClassicVRML string serialization.
String	toStringVRML97(int indentLevel)	Recursive method to provide VRML97 string serialization.
String	toStringX3D(int indentLevel)	Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
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.

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode

getContainerFieldAllowedValues, getContainerFieldOverride, getDEFDefault, getName, getUSEDefault, hasDEF, hasNameField, hasUSE, includesNameField, isNode, isStatement, resetContainerFieldOverride, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement

addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, getCssClassDefault, getCssStyleDefault, getHtmlIdDefault, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setConcreteCssClass, setConcreteCssStyle, setConcreteHtmlId, setParent, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NAME

public static final String NAME

String constant NAME provides name of this element: MultiTextureTransform.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the MultiTextureTransform element: Texturing

See Also:

• Constant Field Values

LEVEL

public static final int LEVEL

Integer constant LEVEL provides default X3D Texturing component level for this element: 2

See Also:

• Constant Field Values

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

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, this default value is provided for informational purposes only.
containerField_DEFAULT_VALUE = "textureTransform";
containerField_ALLOWED_VALUES = {"textureTransform" }; type xs:NMTOKEN

See Also:

• X3DConcreteNode.containerField_ALLOWED_VALUES
• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for containerField
• X3D Unified Object Model (X3DUOM)
• Constant Field Values

fromField_IS

public static final String fromField_IS

fromField ROUTE name for SFNode field named IS.

See Also:

• Constant Field Values

fromField_METADATA

public static final String fromField_METADATA

fromField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

toField_METADATA

public static final String toField_METADATA

toField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

fromField_TEXTURETRANSFORM

public static final String fromField_TEXTURETRANSFORM

fromField ROUTE name for MFNode field named textureTransform.

See Also:

• Constant Field Values

toField_TEXTURETRANSFORM

public static final String toField_TEXTURETRANSFORM

toField ROUTE name for MFNode field named textureTransform.

See Also:

• Constant Field Values

Constructor Details

MultiTextureTransform

public MultiTextureTransform()

Constructor for MultiTextureTransform to initialize member variables with default values.

MultiTextureTransform

public MultiTextureTransform(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: MultiTextureTransform

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the MultiTextureTransform 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

getISDefault

public static final IS getISDefault()

Public accessor for encapsulated SFNode default value null, returned as IS.

Returns:

default value

getMetadataDefault

public static final X3DMetadataObject getMetadataDefault()

Public accessor for encapsulated SFNode default value null, returned as org.web3d.x3d.sai.Core.X3DMetadataObject.

Returns:

default value

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:

• ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE

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:

• ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE

getContainerFieldDefault

public final String getContainerFieldDefault()

containerField describes typical field relationship of a node to its parent. Programmer usage is not ordinarily needed when using this API, since this default value is provided for informational purposes only.

Specified by:

getContainerFieldDefault in class X3DConcreteNode

Returns:

default containerField value

See Also:

• containerField_DEFAULT_VALUE
• X3DConcreteNode.containerField_ALLOWED_VALUES
• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for containerField
• X3D Unified Object Model (X3DUOM)

initialize

public final void initialize()

Initialize all member variables to default values.

Overrides:

initialize in class X3DConcreteNode

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:

• X3D Tooltips: IS
• X3D Tooltips: connect

setIS

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

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

See Also:

• X3D Tooltips: IS
• X3D Tooltips: connect

clearIS

public MultiTextureTransform clearIS()

Utility method to clear SFNode value of IS field.

Returns:

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

• getIS()

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 MultiTextureTransform

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:

• 
  
  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 https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata
• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

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

Specified by:

setMetadata in interface X3DAppearanceChildNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in interface X3DTextureTransformNode

Specified by:

setMetadata in class X3DConcreteNode

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:

• 
  
  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 https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata
• X3D Scene Authoring Hints: Metadata Nodes

clearMetadata

public MultiTextureTransform clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

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

setMetadata

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

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

See Also:

• setMetadata(org.web3d.x3d.sai.Core.X3DMetadataObject)

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:

• getMetadata()
• getMetadataProtoInstance()
• X3D Scene Authoring Hints: Metadata Nodes

getTextureTransform

public X3DNode[] getTextureTransform()

Provide array of org.web3d.x3d.sai.Texturing.X3DSingleTextureTransformNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field textureTransform.

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

• Hint: Texture coordinates are reapplied (or else recomputed if textureTransform field initially NULL) whenever the corresponding vertex-based geometry changes.
• Hint: if textureTransform array is empty, then 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 X3DSingleTextureTransformNode.

Specified by:

getTextureTransform in interface MultiTextureTransform

Returns:

value of textureTransform field

See Also:

• X3DSingleTextureTransformNode

getTextureTransformList

public ArrayList<X3DNode> getTextureTransformList()

Utility method to get ArrayList value of MFNode textureTransform field, similar to getTextureTransform().

Returns:

value of textureTransform field

setTextureTransform

public MultiTextureTransform setTextureTransform(X3DNode[] newValue)

Accessor method to assign org.web3d.x3d.sai.Texturing.X3DSingleTextureTransformNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field textureTransform.

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

• Hint: Texture coordinates are reapplied (or else recomputed if textureTransform field initially NULL) whenever the corresponding vertex-based geometry changes.
• Hint: if textureTransform array is empty, then 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 X3DSingleTextureTransformNode.

Specified by:

setTextureTransform in interface MultiTextureTransform

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

setTextureTransform

public MultiTextureTransform setTextureTransform(ArrayList<X3DSingleTextureTransformNode> newValue)

Assign ArrayList value of MFNode textureTransform field, similar to setTextureTransform(org.web3d.x3d.sai.Core.X3DNode[]).

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

public MultiTextureTransform addTextureTransform(X3DNode newValue)

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

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

Parameters:

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

Returns:

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

addTextureTransform

public MultiTextureTransform addTextureTransform(ProtoInstance newValue)

Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for textureTransform 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:

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

addTextureTransform

public 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 X3DSingleTextureTransformNode.

Specified by:

addTextureTransform in interface MultiTextureTransform

Parameters:

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

setTextureTransform

public void setTextureTransform(X3DNode newValue)

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

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

Specified by:

setTextureTransform in interface MultiTextureTransform

Parameters:

newValue - is new node for the textureTransform field (restricted to X3DSingleTextureTransformNode)

clearTextureTransform

public MultiTextureTransform clearTextureTransform()

Utility method to clear MFNode value of textureTransform field. This method does not initialize with TEXTURETRANSFORM_DEFAULT_VALUE.

Returns:

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

hasTextureTransform

public boolean hasTextureTransform()

Indicate whether an object is available for inputOutput MFNode field textureTransform.

Returns:

whether a properly typed node or ProtoInstance array or CommentsBlock is available.

See Also:

• getTextureTransform()

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

Overrides:

getDEF in class X3DConcreteNode

Returns:

value of DEF field

See Also:

• X3D Scene Authoring Hints: Naming Conventions

setDEF

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

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:

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

setDEF

public MultiTextureTransform setDEF(SFString newValue)

Assign typed object value to SFString DEF field, similar to setDEF(String).

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

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:

• X3D Scene Authoring Hints: Naming Conventions

setUSE

public final MultiTextureTransform 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:

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

setUSE

public MultiTextureTransform setUSE(SFString newValue)

Assign typed object value to SFString USE field, similar to setUSE(String).

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

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:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS tutorial: Starting with HTML + CSS
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public final MultiTextureTransform 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:

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

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS tutorial: Starting with HTML + CSS
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public MultiTextureTransform setCssClass(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssClass(String).

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

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:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS tutorial: Starting with HTML + CSS
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlId

public final MultiTextureTransform 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:

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

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
  Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus not applicable for USE nodes, ROUTE statements, or Script references.
• X3D Architecture Annex L - HTML authoring guidelines, L.3.1 Content definition and page presentation
• HTML 5.2 W3C Recommendation
• Document Object Model (DOM) Technical Reports
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlId

public MultiTextureTransform setHtmlId(SFString newValue)

Assign typed object value to SFString HtmlId field, similar to setHtmlId(String).

Parameters:

newValue - is new value for the id field.

Returns:

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

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS tutorial: Starting with HTML + CSS
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public final MultiTextureTransform 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:

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

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS tutorial: Starting with HTML + CSS
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public MultiTextureTransform setCssStyle(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssStyle(String).

Parameters:

newValue - is new value for the style field.

Returns:

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

setUSE

public MultiTextureTransform setUSE(MultiTextureTransform 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:

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

addComments

public MultiTextureTransform addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

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

See Also:

• X3D Architecture, clause 7.2.5.1 Organization

addComments

public MultiTextureTransform addComments(String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public MultiTextureTransform addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

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

• X3D.FILE_EXTENSION_X3D
• X3D.FILE_EXTENSION_XML
• X3D.toStringXML()
• X3D.toFileXML(String)
• X3D.toFileX3D(String)
• X3D XML Encoding
• X3D Compressed Binary Encoding: X3D Canonical Form
• X3D Canonicalization (C14N) Tool

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:

• X3D.FILE_EXTENSION_CLASSICVRML
• X3D Resources: Virtual Reality Modeling Language (VRML) 97
• Extensible 3D (X3D) encodings Part 2: Classic VRML encoding
• Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar

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:

• X3D.FILE_EXTENSION_VRML97
• X3D Resources: Virtual Reality Modeling Language (VRML) 97
• Virtual Reality Modeling Language (VRML) 97 specification
• VRML 97 v2.1 Amendment

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:

• findNodeByDEF(String)
• X3DConcreteElement.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

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:

• findNodeByDEF(String)
• X3DConcreteElement.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

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:

• findElementByNameValue(String, String)

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:

• findElementByNameValue(String)
• X3DConcreteElement.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

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:

• findNodeByDEF(String)

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. TODO document specific validation methods.

Specified by:

validate in class X3DConcreteElement

Returns:

validation results (if any)