org.web3d.x3d.jsail.Texturing

Class TextureTransformObject

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.Texturing.TextureTransformObject

All Implemented Interfaces:

X3DNode, X3DAppearanceChildNode, TextureTransform, X3DTextureTransformNode

public class TextureTransformObject
extends X3DConcreteNode
implements TextureTransform

X3D node tooltip: [X3DTextureTransformNode] TextureTransform shifts 2D texture coordinates for positioning, orienting and scaling image textures on geometry.

• Warning: resulting visible effects appear reversed because image changes occur before mapping to geometry.
• Hint: order of operations is translation, rotation about center, non-uniform scale about center.
• Hint: insert Shape and Appearance nodes before adding TextureTransform.
• Hint: Texture mapping
  https://en.wikipedia.org/wiki/Texture_mapping

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: TextureTransform, X3D Tooltips: TextureTransform, X3D Scene Authoring Hints: Images

Field Summary

Fields

Modifier and Type	Field and Description
static float[]	CENTER_DEFAULT_VALUE SFVec2f field named center has default value {0f,0f} (Java syntax) or 0 0 (XML syntax).
static java.lang.String	COMPONENT String constant COMPONENT defines X3D component for the TextureTransform element: Texturing
static java.lang.String	containerField_DEFAULT_VALUE containerField describes typical field relationship of a node to its parent.
static java.lang.String	fromField_CENTER fromField ROUTE name for SFVec2f field named center.
static java.lang.String	fromField_METADATA fromField ROUTE name for SFNode field named metadata.
static java.lang.String	fromField_ROTATION fromField ROUTE name for SFFloat field named rotation.
static java.lang.String	fromField_SCALE fromField ROUTE name for SFVec2f field named scale.
static java.lang.String	fromField_TRANSLATION fromField ROUTE name for SFVec2f field named translation.
static int	LEVEL Integer constant LEVEL provides default X3D Texturing component level for this element: 1
static java.lang.String	NAME String constant NAME provides name of this element: TextureTransform.
static float	ROTATION_DEFAULT_VALUE SFFloat field named rotation has default value 0f (Java syntax) or 0 (XML syntax).
static float[]	SCALE_DEFAULT_VALUE SFVec2f field named scale has default value {1f,1f} (Java syntax) or 1 1 (XML syntax).
static java.lang.String	toField_CENTER toField ROUTE name for SFVec2f field named center.
static java.lang.String	toField_METADATA toField ROUTE name for SFNode field named metadata.
static java.lang.String	toField_ROTATION toField ROUTE name for SFFloat field named rotation.
static java.lang.String	toField_SCALE toField ROUTE name for SFVec2f field named scale.
static java.lang.String	toField_TRANSLATION toField ROUTE name for SFVec2f field named translation.
static float[]	TRANSLATION_DEFAULT_VALUE SFVec2f field named translation has default value {0f,0f} (Java syntax) or 0 0 (XML syntax).

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

CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

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

validationResult

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
TextureTransformObject	addComments(CommentsBlock newCommentsBlock) Add CommentsBlock to contained commentsList.
TextureTransformObject	addComments(java.lang.String newComment) Add comment as String to contained commentsList.
TextureTransformObject	addComments(java.lang.String[] newComments) Add comments as String[] array to contained commentsList.
TextureTransformObject	clearMetadata() Utility method to clear SFNode value of metadata field.
X3DConcreteElement	findElementByNameValue(java.lang.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(java.lang.String nameValue, java.lang.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(java.lang.String DEFvalue) Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
java.lang.String	getAccessType(java.lang.String fieldName) Indicate accessType corresponding to given fieldName.
float[]	getCenter() Provide array of 2-tuple float results from inputOutput SFVec2f field named center.
java.lang.String	getComponent() Defines X3D component for the TextureTransform element: Texturing
int	getComponentLevel() Provides default X3D component level for this element: 1
java.lang.String	getContainerFieldDefault() containerField describes typical field relationship of a node to its parent.
java.lang.String	getElementName() Provides name of this element: TextureTransform
java.lang.String	getFieldType(java.lang.String fieldName) Indicate type corresponding to given fieldName.
ISObject	getIS() Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
X3DMetadataObject	getMetadata() Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
float	getRotation() Provide float value unit axis, angle (in radians) from inputOutput SFFloat field named rotation.
float[]	getScale() Provide array of 2-tuple float results from inputOutput SFVec2f field named scale.
float[]	getTranslation() Provide array of 2-tuple float results from inputOutput SFVec2f field named translation.
boolean	hasElementByNameValue(java.lang.String nameValue, java.lang.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	hasMetadata() Indicate whether an object is available for inputOutput SFNode field metadata.
boolean	hasNodeByDEF(java.lang.String DEFvalue) Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
void	initialize() Initialize all member variables to default values.
TextureTransformObject	setCenter(float[] newValue) Assign 2-tuple float array to inputOutput SFVec2f field named center.
TextureTransformObject	setCenter(float x, float y) Assign values to SFVec2f center field, similar to setCenter(float[]).
TextureTransformObject	setCenter(SFVec2fObject newValue) Assign typed object value to SFVec2f center field, similar to setCenter(float[]).
TextureTransformObject	setCssClass(SFStringObject newValue) Assign typed object value to SFString cssClass field, similar to setCssClass(String).
TextureTransformObject	setCssClass(java.lang.String newValue) Assign String value to inputOutput SFString field named class.
TextureTransformObject	setDEF(SFStringObject newValue) Assign typed object value to SFString DEF field, similar to setDEF(String).
TextureTransformObject	setDEF(java.lang.String newValue) Assign String value to inputOutput SFString field named DEF.
TextureTransformObject	setIS(ISObject newValue) Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
TextureTransformObject	setMetadata(ProtoInstanceObject newValue) Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
TextureTransformObject	setMetadata(X3DMetadataObject newValue) Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
TextureTransformObject	setRotation(float newValue) Assign float value unit axis, angle (in radians) to inputOutput SFFloat field named rotation.
TextureTransformObject	setRotation(SFFloatObject newValue) Assign typed object value to SFFloat rotation field, similar to setRotation(float).
TextureTransformObject	setScale(float[] newValue) Assign 2-tuple float array to inputOutput SFVec2f field named scale.
TextureTransformObject	setScale(float x, float y) Assign values to SFVec2f scale field, similar to setScale(float[]).
TextureTransformObject	setScale(SFVec2fObject newValue) Assign typed object value to SFVec2f scale field, similar to setScale(float[]).
TextureTransformObject	setTranslation(float[] newValue) Assign 2-tuple float array to inputOutput SFVec2f field named translation.
TextureTransformObject	setTranslation(float x, float y) Assign values to SFVec2f translation field, similar to setTranslation(float[]).
TextureTransformObject	setTranslation(SFVec2fObject newValue) Assign typed object value to SFVec2f translation field, similar to setTranslation(float[]).
TextureTransformObject	setUSE(SFStringObject newValue) Assign typed object value to SFString USE field, similar to setUSE(String).
TextureTransformObject	setUSE(java.lang.String newValue) Assign String value to inputOutput SFString field named USE.
TextureTransformObject	setUSE(TextureTransformObject DEFnode) Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
java.lang.String	toStringClassicVRML(int indentLevel) Recursive method to provide ClassicVRML string serialization.
java.lang.String	toStringVRML97(int indentLevel) Recursive method to provide VRML97 string serialization.
java.lang.String	toStringX3D(int indentLevel) Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
java.lang.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

getContainerFieldAlternateValues, getContainerFieldOverride, getCssClass, getDEF, getUSE, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

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

clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

String constant NAME provides name of this element: TextureTransform.

See Also:

Constant Field Values

COMPONENT

public static final java.lang.String COMPONENT

String constant COMPONENT defines X3D component for the TextureTransform 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: 1

See Also:

Constant Field Values

CENTER_DEFAULT_VALUE

public static final float[] CENTER_DEFAULT_VALUE

SFVec2f field named center has default value {0f,0f} (Java syntax) or 0 0 (XML syntax).

ROTATION_DEFAULT_VALUE

public static final float ROTATION_DEFAULT_VALUE

SFFloat field named rotation has default value 0f (Java syntax) or 0 (XML syntax).

See Also:

Constant Field Values

SCALE_DEFAULT_VALUE

public static final float[] SCALE_DEFAULT_VALUE

SFVec2f field named scale has default value {1f,1f} (Java syntax) or 1 1 (XML syntax).

TRANSLATION_DEFAULT_VALUE

public static final float[] TRANSLATION_DEFAULT_VALUE

SFVec2f field named translation has default value {0f,0f} (Java syntax) or 0 0 (XML syntax).

containerField_DEFAULT_VALUE

public static final java.lang.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:

X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM), Constant Field Values

fromField_CENTER

public static final java.lang.String fromField_CENTER

fromField ROUTE name for SFVec2f field named center.

See Also:

Constant Field Values

toField_CENTER

public static final java.lang.String toField_CENTER

toField ROUTE name for SFVec2f field named center.

See Also:

Constant Field Values

fromField_METADATA

public static final java.lang.String fromField_METADATA

fromField ROUTE name for SFNode field named metadata.

See Also:

Constant Field Values

toField_METADATA

public static final java.lang.String toField_METADATA

toField ROUTE name for SFNode field named metadata.

See Also:

Constant Field Values

fromField_ROTATION

public static final java.lang.String fromField_ROTATION

fromField ROUTE name for SFFloat field named rotation.

See Also:

Constant Field Values

toField_ROTATION

public static final java.lang.String toField_ROTATION

toField ROUTE name for SFFloat field named rotation.

See Also:

Constant Field Values

fromField_SCALE

public static final java.lang.String fromField_SCALE

fromField ROUTE name for SFVec2f field named scale.

See Also:

Constant Field Values

toField_SCALE

public static final java.lang.String toField_SCALE

toField ROUTE name for SFVec2f field named scale.

See Also:

Constant Field Values

fromField_TRANSLATION

public static final java.lang.String fromField_TRANSLATION

fromField ROUTE name for SFVec2f field named translation.

See Also:

Constant Field Values

toField_TRANSLATION

public static final java.lang.String toField_TRANSLATION

toField ROUTE name for SFVec2f field named translation.

See Also:

Constant Field Values

Constructor Detail

TextureTransformObject

public TextureTransformObject()

Constructor for TextureTransformObject to initialize member variables with default values.

TextureTransformObject

public TextureTransformObject(java.lang.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 Detail

getElementName

public final java.lang.String getElementName()

Provides name of this element: TextureTransform

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final java.lang.String getComponent()

Defines X3D component for the TextureTransform 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: 1

Specified by:

getComponentLevel in class X3DConcreteElement

Returns:

default X3D component level for this element

getFieldType

public java.lang.String getFieldType(java.lang.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 java.lang.String getAccessType(java.lang.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 java.lang.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:

X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)

initialize

public final void initialize()

Initialize all member variables to default values.

Overrides:

initialize in class X3DConcreteNode

getCenter

public float[] getCenter()

Provide array of 2-tuple float results from inputOutput SFVec2f field named center.

Tooltip: center point in 2D (s,t) texture coordinates for rotation and scaling. *

Specified by:

getCenter in interface TextureTransform

Returns:

value of center field

setCenter

public TextureTransformObject setCenter(float[] newValue)

Assign 2-tuple float array to inputOutput SFVec2f field named center.

Tooltip: center point in 2D (s,t) texture coordinates for rotation and scaling.

Specified by:

setCenter in interface TextureTransform

Parameters:

newValue - is new value for the center field.

Returns:

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

setCenter

public TextureTransformObject setCenter(SFVec2fObject newValue)

Assign typed object value to SFVec2f center field, similar to setCenter(float[]).

Parameters:

newValue - is new value for the center field.

Returns:

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

setCenter

public TextureTransformObject setCenter(float x,
                                        float y)

Assign values to SFVec2f center field, similar to setCenter(float[]).

Parameters:

x - first component

y - second component

Returns:

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

getMetadata

public X3DMetadataObject getMetadata()

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

Specified by:

getMetadata in interface X3DNode

Specified by:

getMetadata in interface X3DAppearanceChildNode

Specified by:

getMetadata in interface TextureTransform

Specified by:

getMetadata in interface X3DTextureTransformNode

Returns:

value of metadata field

See Also:

getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes

setMetadata

public TextureTransformObject setMetadata(X3DMetadataObject newValue)

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

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in interface X3DAppearanceChildNode

Specified by:

setMetadata in interface TextureTransform

Specified by:

setMetadata in interface X3DTextureTransformNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

See Also:

setMetadata(ProtoInstanceObject), X3D Scene Authoring Hints: Metadata Nodes

clearMetadata

public TextureTransformObject clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

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

setMetadata

public TextureTransformObject setMetadata(ProtoInstanceObject 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:

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

See Also:

setMetadata(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

getRotation

public float getRotation()

Provide float value unit axis, angle (in radians) from inputOutput SFFloat field named rotation.

Tooltip: single rotation angle of texture about center (opposite effect appears on geometry).

• Warning: use a single radian angle value, not a 4-tuple Rotation.

Specified by:

getRotation in interface TextureTransform

Returns:

value of rotation field

setRotation

public TextureTransformObject setRotation(float newValue)

Assign float value unit axis, angle (in radians) to inputOutput SFFloat field named rotation.

Tooltip: single rotation angle of texture about center (opposite effect appears on geometry). Warning: use a single radian angle value, not a 4-tuple Rotation.

Specified by:

setRotation in interface TextureTransform

Parameters:

newValue - is new value for the rotation field.

Returns:

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

setRotation

public TextureTransformObject setRotation(SFFloatObject newValue)

Assign typed object value to SFFloat rotation field, similar to setRotation(float).

Parameters:

newValue - is new value for the rotation field.

Returns:

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

getScale

public float[] getScale()

Provide array of 2-tuple float results from inputOutput SFVec2f field named scale.

Tooltip: Non-uniform planar scaling of texture about center (opposite effect appears on geometry). *

Specified by:

getScale in interface TextureTransform

Returns:

value of scale field

setScale

public TextureTransformObject setScale(float[] newValue)

Assign 2-tuple float array to inputOutput SFVec2f field named scale.

Tooltip: Non-uniform planar scaling of texture about center (opposite effect appears on geometry).

Specified by:

setScale in interface TextureTransform

Parameters:

newValue - is new value for the scale field.

Returns:

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

setScale

public TextureTransformObject setScale(SFVec2fObject newValue)

Assign typed object value to SFVec2f scale field, similar to setScale(float[]).

Parameters:

newValue - is new value for the scale field.

Returns:

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

setScale

public TextureTransformObject setScale(float x,
                                       float y)

Assign values to SFVec2f scale field, similar to setScale(float[]).

Parameters:

x - first component

y - second component

Returns:

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

getTranslation

public float[] getTranslation()

Provide array of 2-tuple float results from inputOutput SFVec2f field named translation.

Tooltip: Lateral/vertical shift in 2D (s,t) texture coordinates (opposite effect appears on geometry). *

Specified by:

getTranslation in interface TextureTransform

Returns:

value of translation field

setTranslation

public TextureTransformObject setTranslation(float[] newValue)

Assign 2-tuple float array to inputOutput SFVec2f field named translation.

Tooltip: Lateral/vertical shift in 2D (s,t) texture coordinates (opposite effect appears on geometry).

Specified by:

setTranslation in interface TextureTransform

Parameters:

newValue - is new value for the translation field.

Returns:

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

setTranslation

public TextureTransformObject setTranslation(SFVec2fObject newValue)

Assign typed object value to SFVec2f translation field, similar to setTranslation(float[]).

Parameters:

newValue - is new value for the translation field.

Returns:

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

setTranslation

public TextureTransformObject setTranslation(float x,
                                             float y)

Assign values to SFVec2f translation field, similar to setTranslation(float[]).

Parameters:

x - first component

y - second component

Returns:

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

setDEF

public final TextureTransformObject 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 X3DNode

Specified by:

setDEF in interface X3DAppearanceChildNode

Specified by:

setDEF in interface TextureTransform

Specified by:

setDEF in interface X3DTextureTransformNode

Specified by:

setDEF in class X3DConcreteNode

Parameters:

newValue - is new value for the DEF field.

Returns:

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

setDEF

public TextureTransformObject setDEF(SFStringObject newValue)

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

Parameters:

newValue - is new value for the DEF field.

Returns:

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

setUSE

public final TextureTransformObject 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 X3DNode

Specified by:

setUSE in interface X3DAppearanceChildNode

Specified by:

setUSE in interface TextureTransform

Specified by:

setUSE in interface X3DTextureTransformNode

Specified by:

setUSE in class X3DConcreteNode

Parameters:

newValue - is new value for the USE field.

Returns:

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

setUSE

public TextureTransformObject setUSE(SFStringObject newValue)

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

Parameters:

newValue - is new value for the USE field.

Returns:

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

setCssClass

public final TextureTransformObject 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 X3DNode

Specified by:

setCssClass in interface X3DAppearanceChildNode

Specified by:

setCssClass in interface TextureTransform

Specified by:

setCssClass in interface X3DTextureTransformNode

Specified by:

setCssClass in class X3DConcreteNode

Parameters:

newValue - is new value for the class field.

Returns:

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

See Also:

W3C Cascading Style Sheets

setCssClass

public TextureTransformObject setCssClass(SFStringObject newValue)

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

Parameters:

newValue - is new value for the class field.

Returns:

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

setIS

public TextureTransformObject setIS(ISObject newValue)

Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.

Specified by:

setIS in class X3DConcreteNode

Parameters:

newValue - is new value for the description field.

Returns:

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

getIS

public ISObject getIS()

Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.

Specified by:

getIS in class X3DConcreteNode

Returns:

current ISObject, if any.

See Also:

X3D Tooltips: IS, X3D Tooltips: connect

setUSE

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

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

addComments

public TextureTransformObject addComments(java.lang.String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

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

addComments

public TextureTransformObject addComments(java.lang.String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public TextureTransformObject addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

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

toStringX3D

public java.lang.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:

X3DObject.FILE_EXTENSION_X3D, X3DObject.FILE_EXTENSION_XML, X3DObject.toStringXML(), X3DObject.toFileXML(String), X3DObject.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form

toStringClassicVRML

public java.lang.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:

X3DObject.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 java.lang.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:

X3DObject.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(java.lang.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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()

findElementByNameValue

public X3DConcreteElement findElementByNameValue(java.lang.String nameValue,
                                                 java.lang.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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()

hasElementByNameValue

public boolean hasElementByNameValue(java.lang.String nameValue,
                                     java.lang.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(java.lang.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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()

hasNodeByDEF

public boolean hasNodeByDEF(java.lang.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 java.lang.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)