Package org.web3d.x3d.jsail.Texturing3D
Class TextureTransform3DObject
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Texturing3D.TextureTransform3DObject
- All Implemented Interfaces:
X3DNode,X3DAppearanceChildNode,X3DTextureTransformNode,TextureTransform3D
public class TextureTransform3DObject extends X3DConcreteNode implements TextureTransform3D
TextureTransform3D applies a 3D transformation to texture coordinates.
X3D node tooltip: (X3D version 3.1 or later) [X3DTextureTransformNode] TextureTransform3D applies a 3D transformation to texture coordinates.
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.
X3D node tooltip: (X3D version 3.1 or later) [X3DTextureTransformNode] TextureTransform3D applies a 3D transformation to texture coordinates.
- 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 TextureTransform3D.
- 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.
-
Field Summary
Fields Modifier and Type Field Description static float[]CENTER_DEFAULT_VALUESFVec3f field named center has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).static java.lang.StringCOMPONENTString constant COMPONENT defines X3D component for the TextureTransform3D element: Texturing3Dstatic java.lang.StringcontainerField_DEFAULT_VALUEcontainerField describes typical field relationship of a node to its parent.static java.lang.StringfromField_CENTERfromField ROUTE name for SFVec3f field named center.static java.lang.StringfromField_ISfromField ROUTE name for SFNode field named IS.static java.lang.StringfromField_METADATAfromField ROUTE name for SFNode field named metadata.static java.lang.StringfromField_ROTATIONfromField ROUTE name for SFRotation field named rotation.static java.lang.StringfromField_SCALEfromField ROUTE name for SFVec3f field named scale.static java.lang.StringfromField_TRANSLATIONfromField ROUTE name for SFVec3f field named translation.static ISObjectIS_DEFAULT_VALUESFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static intLEVELInteger constant LEVEL provides default X3D Texturing3D component level for this element: 1static X3DMetadataObjectMETADATA_DEFAULT_VALUESFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static java.lang.StringNAMEString constant NAME provides name of this element: TextureTransform3D.static float[]ROTATION_DEFAULT_VALUESFRotation field named rotation has default value {0f,0f,1f,0f} (Java syntax) or 0 0 1 0 (XML syntax).static float[]SCALE_DEFAULT_VALUESFVec3f field named scale has default value {1f,1f,1f} (Java syntax) or 1 1 1 (XML syntax).static java.lang.StringtoField_CENTERtoField ROUTE name for SFVec3f field named center.static java.lang.StringtoField_METADATAtoField ROUTE name for SFNode field named metadata.static java.lang.StringtoField_ROTATIONtoField ROUTE name for SFRotation field named rotation.static java.lang.StringtoField_SCALEtoField ROUTE name for SFVec3f field named scale.static java.lang.StringtoField_TRANSLATIONtoField ROUTE name for SFVec3f field named translation.static float[]TRANSLATION_DEFAULT_VALUESFVec3f field named translation has default value {0f,0f,0f} (Java syntax) or 0 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 -
Constructor Summary
Constructors Constructor Description TextureTransform3DObject()Constructor for TextureTransform3DObject to initialize member variables with default values.TextureTransform3DObject(java.lang.String DEFlabel)Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and Type Method Description TextureTransform3DObjectaddComments(java.lang.String newComment)Add comment as String to contained commentsList.TextureTransform3DObjectaddComments(java.lang.String[] newComments)Add comments as String[] array to contained commentsList.TextureTransform3DObjectaddComments(CommentsBlock newCommentsBlock)Add CommentsBlock to contained commentsList.TextureTransform3DObjectclearIS()Utility method to clear SFNode value of IS field.TextureTransform3DObjectclearMetadata()Utility method to clear SFNode value of metadata field.X3DConcreteElementfindElementByNameValue(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.X3DConcreteElementfindElementByNameValue(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.X3DConcreteNodefindNodeByDEF(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.StringgetAccessType(java.lang.String fieldName)Indicate accessType corresponding to given fieldName.float[]getCenter()Provide array of 3-tuple float results from inputOutput SFVec3f field named center.java.lang.StringgetComponent()Defines X3D component for the TextureTransform3D element: Texturing3DintgetComponentLevel()Provides default X3D component level for this element: 1java.lang.StringgetContainerFieldDefault()containerField describes typical field relationship of a node to its parent.java.lang.StringgetCssClass()Provide String value from inputOutput SFString field named class.java.lang.StringgetDEF()Provide String value from inputOutput SFString field named DEF.java.lang.StringgetElementName()Provides name of this element: TextureTransform3Djava.lang.StringgetFieldType(java.lang.String fieldName)Indicate type corresponding to given fieldName.ISObjectgetIS()Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.X3DMetadataObjectgetMetadata()Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.float[]getRotation()Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named rotation.float[]getScale()Provide array of 3-tuple float results from inputOutput SFVec3f field named scale.float[]getTranslation()Provide array of 3-tuple float results from inputOutput SFVec3f field named translation.java.lang.StringgetUSE()Provide String value from inputOutput SFString field named USE.booleanhasElementByNameValue(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.booleanhasIS()Indicate whether an object is available for inputOutput SFNode field IS.booleanhasMetadata()Indicate whether an object is available for inputOutput SFNode field metadata.booleanhasNodeByDEF(java.lang.String DEFvalue)Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.voidinitialize()Initialize all member variables to default values.TextureTransform3DObjectsetCenter(double[] newArray)Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetCenter(float[]).TextureTransform3DObjectsetCenter(double x, double y, double z)Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetCenter(float[]).TextureTransform3DObjectsetCenter(float[] newValue)Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named center.TextureTransform3DObjectsetCenter(float x, float y, float z)Assign values to SFVec3f center field, similar tosetCenter(float[]).TextureTransform3DObjectsetCenter(SFVec3fObject newValue)Assign typed object value to SFVec3f center field, similar tosetCenter(float[]).TextureTransform3DObjectsetCssClass(java.lang.String newValue)Accessor method to assign String value to inputOutput SFString field named class.TextureTransform3DObjectsetCssClass(SFStringObject newValue)Assign typed object value to SFString cssClass field, similar tosetCssClass(String).TextureTransform3DObjectsetDEF(java.lang.String newValue)Accessor method to assign String value to inputOutput SFString field named DEF.TextureTransform3DObjectsetDEF(SFStringObject newValue)Assign typed object value to SFString DEF field, similar tosetDEF(String).TextureTransform3DObjectsetIS(ISObject newValue)Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.TextureTransform3DObjectsetMetadata(ProtoInstanceObject newValue)Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.TextureTransform3DObjectsetMetadata(X3DMetadataObject newValue)Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.TextureTransform3DObjectsetRotation(double[] newArray)Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetRotation(float[]).TextureTransform3DObjectsetRotation(double x, double y, double z, double angleRadians)Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetRotation(float[]).TextureTransform3DObjectsetRotation(float[] newValue)Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named rotation.TextureTransform3DObjectsetRotation(float x, float y, float z, float angleRadians)Assign values to SFRotation rotation field, similar tosetRotation(float[]).TextureTransform3DObjectsetRotation(SFRotationObject newValue)Assign typed object value to SFRotation rotation field, similar tosetRotation(float[]).TextureTransform3DObjectsetScale(double[] newArray)Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetScale(float[]).TextureTransform3DObjectsetScale(double x, double y, double z)Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetScale(float[]).TextureTransform3DObjectsetScale(float[] newValue)Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named scale.TextureTransform3DObjectsetScale(float x, float y, float z)Assign values to SFVec3f scale field, similar tosetScale(float[]).TextureTransform3DObjectsetScale(SFVec3fObject newValue)Assign typed object value to SFVec3f scale field, similar tosetScale(float[]).TextureTransform3DObjectsetTranslation(double[] newArray)Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetTranslation(float[]).TextureTransform3DObjectsetTranslation(double x, double y, double z)Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetTranslation(float[]).TextureTransform3DObjectsetTranslation(float[] newValue)Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named translation.TextureTransform3DObjectsetTranslation(float x, float y, float z)Assign values to SFVec3f translation field, similar tosetTranslation(float[]).TextureTransform3DObjectsetTranslation(SFVec3fObject newValue)Assign typed object value to SFVec3f translation field, similar tosetTranslation(float[]).TextureTransform3DObjectsetUSE(java.lang.String newValue)Accessor method to assign String value to inputOutput SFString field named USE.TextureTransform3DObjectsetUSE(SFStringObject newValue)Assign typed object value to SFString USE field, similar tosetUSE(String).TextureTransform3DObjectsetUSE(TextureTransform3DObject DEFnode)Assign a USE reference to another DEF node of same node type, similar tosetUSE(String).java.lang.StringtoStringClassicVRML(int indentLevel)Recursive method to provide ClassicVRML string serialization.java.lang.StringtoStringVRML97(int indentLevel)Recursive method to provide VRML97 string serialization.java.lang.StringtoStringX3D(int indentLevel)Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.java.lang.Stringvalidate()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, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverrideMethods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, hasParentObject, isValid, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D
-
Field Details
-
NAME
public static final java.lang.String NAMEString constant NAME provides name of this element: TextureTransform3D.- See Also:
- Constant Field Values
-
COMPONENT
public static final java.lang.String COMPONENTString constant COMPONENT defines X3D component for the TextureTransform3D element: Texturing3D- See Also:
- Constant Field Values
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D Texturing3D component level for this element: 1- See Also:
- Constant Field Values
-
CENTER_DEFAULT_VALUE
public static final float[] CENTER_DEFAULT_VALUESFVec3f field named center has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax). -
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax). -
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax). -
ROTATION_DEFAULT_VALUE
public static final float[] ROTATION_DEFAULT_VALUESFRotation field named rotation has default value {0f,0f,1f,0f} (Java syntax) or 0 0 1 0 (XML syntax). -
SCALE_DEFAULT_VALUE
public static final float[] SCALE_DEFAULT_VALUESFVec3f field named scale has default value {1f,1f,1f} (Java syntax) or 1 1 1 (XML syntax). -
TRANSLATION_DEFAULT_VALUE
public static final float[] TRANSLATION_DEFAULT_VALUESFVec3f field named translation has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax). -
containerField_DEFAULT_VALUE
public static final java.lang.String containerField_DEFAULT_VALUEcontainerField 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. -
fromField_CENTER
public static final java.lang.String fromField_CENTERfromField ROUTE name for SFVec3f field named center.- See Also:
- Constant Field Values
-
toField_CENTER
public static final java.lang.String toField_CENTERtoField ROUTE name for SFVec3f field named center.- See Also:
- Constant Field Values
-
fromField_IS
public static final java.lang.String fromField_ISfromField ROUTE name for SFNode field named IS.- See Also:
- Constant Field Values
-
fromField_METADATA
public static final java.lang.String fromField_METADATAfromField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
toField_METADATA
public static final java.lang.String toField_METADATAtoField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
fromField_ROTATION
public static final java.lang.String fromField_ROTATIONfromField ROUTE name for SFRotation field named rotation.- See Also:
- Constant Field Values
-
toField_ROTATION
public static final java.lang.String toField_ROTATIONtoField ROUTE name for SFRotation field named rotation.- See Also:
- Constant Field Values
-
fromField_SCALE
public static final java.lang.String fromField_SCALEfromField ROUTE name for SFVec3f field named scale.- See Also:
- Constant Field Values
-
toField_SCALE
public static final java.lang.String toField_SCALEtoField ROUTE name for SFVec3f field named scale.- See Also:
- Constant Field Values
-
fromField_TRANSLATION
public static final java.lang.String fromField_TRANSLATIONfromField ROUTE name for SFVec3f field named translation.- See Also:
- Constant Field Values
-
toField_TRANSLATION
public static final java.lang.String toField_TRANSLATIONtoField ROUTE name for SFVec3f field named translation.- See Also:
- Constant Field Values
-
-
Constructor Details
-
TextureTransform3DObject
public TextureTransform3DObject()Constructor for TextureTransform3DObject to initialize member variables with default values. -
TextureTransform3DObject
public TextureTransform3DObject(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 Details
-
getElementName
public final java.lang.String getElementName()Provides name of this element: TextureTransform3D- Specified by:
getElementNamein classX3DConcreteElement- Returns:
- name of this element
-
getComponent
public final java.lang.String getComponent()Defines X3D component for the TextureTransform3D element: Texturing3D- Specified by:
getComponentin classX3DConcreteElement- Returns:
- X3D component for this element
-
getComponentLevel
public final int getComponentLevel()Provides default X3D component level for this element: 1- Specified by:
getComponentLevelin classX3DConcreteElement- 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:
getFieldTypein classX3DConcreteElement- 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:
getAccessTypein classX3DConcreteElement- 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:
getContainerFieldDefaultin classX3DConcreteNode- 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:
initializein classX3DConcreteNode
-
getCenter
public float[] getCenter()Provide array of 3-tuple float results from inputOutput SFVec3f field named center.
Tooltip: center point in 2D (s,t) texture coordinates for rotation and scaling. *- Specified by:
getCenterin interfaceTextureTransform3D- Returns:
- value of center field
-
setCenter
Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named center.
Tooltip: center point in 2D (s,t) texture coordinates for rotation and scaling. *- Specified by:
setCenterin interfaceTextureTransform3D- Parameters:
newValue- is new value for the center field.- Returns:
TextureTransform3DObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setCenter
Assign typed object value to SFVec3f center field, similar tosetCenter(float[]).- Parameters:
newValue- is new value for the center field.- Returns:
TextureTransform3DObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setCenter
Assign values to SFVec3f center field, similar tosetCenter(float[]).- Parameters:
x- first componenty- second componentz- third component- Returns:
TextureTransform3DObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setCenter
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetCenter(float[]).- Parameters:
x- first componenty- second componentz- third component- Returns:
TextureTransform3DObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setCenter
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetCenter(float[]).- Parameters:
newArray- is new value for field- Returns:
TextureTransform3DObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getIS
Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.- Specified by:
getISin classX3DConcreteNode- Returns:
- value of IS field
- See Also:
- X3D Tooltips: IS, X3D Tooltips: connect
-
setIS
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.- Specified by:
setISin classX3DConcreteNode- Parameters:
newValue- is new value for the IS field.- Returns:
TextureTransform3DObject- 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
Utility method to clear SFNode value of IS field.- Returns:
TextureTransform3DObject- 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
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadatain interfaceTextureTransform3D- Specified by:
getMetadatain interfaceX3DAppearanceChildNode- Specified by:
getMetadatain interfaceX3DNode- Specified by:
getMetadatain interfaceX3DTextureTransformNode- 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/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata, X3D Scene Authoring Hints: Metadata Nodes
-
setMetadata
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadatain interfaceTextureTransform3D- Specified by:
setMetadatain interfaceX3DAppearanceChildNode- Specified by:
setMetadatain interfaceX3DNode- Specified by:
setMetadatain interfaceX3DTextureTransformNode- Specified by:
setMetadatain classX3DConcreteNode- Parameters:
newValue- is new value for the metadata field.- Returns:
TextureTransform3DObject- 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/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata, X3D Scene Authoring Hints: Metadata Nodes
-
clearMetadata
Utility method to clear SFNode value of metadata field.- Returns:
TextureTransform3DObject- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setMetadata
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadatain classX3DConcreteNode- Parameters:
newValue- is new value for the metadata field.- Returns:
TextureTransform3DObject- 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 array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named rotation.
Tooltip: rotation angle of texture about center (opposite effect appears on geometry). *- Specified by:
getRotationin interfaceTextureTransform3D- Returns:
- value of rotation field
-
setRotation
Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named rotation.
Tooltip: rotation angle of texture about center (opposite effect appears on geometry). *- Specified by:
setRotationin interfaceTextureTransform3D- Parameters:
newValue- is new value for the rotation field.- Returns:
TextureTransform3DObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setRotation
Assign typed object value to SFRotation rotation field, similar tosetRotation(float[]).- Parameters:
newValue- is new value for the rotation field.- Returns:
TextureTransform3DObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setRotation
Assign values to SFRotation rotation field, similar tosetRotation(float[]).- Parameters:
x- first component of axisy- second component of axisz- third component of axisangleRadians- fourth component of rotation around axis- Returns:
TextureTransform3DObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setRotation
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetRotation(float[]).- Parameters:
x- first componenty- second componentz- third componentangleRadians- fourth component- Returns:
TextureTransform3DObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setRotation
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetRotation(float[]).- Parameters:
newArray- is new value for field- Returns:
TextureTransform3DObject- 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 3-tuple float results from inputOutput SFVec3f field named scale.
Tooltip: Non-uniform planar scaling of texture about center (opposite effect appears on geometry). *- Specified by:
getScalein interfaceTextureTransform3D- Returns:
- value of scale field
-
setScale
Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named scale.
Tooltip: Non-uniform planar scaling of texture about center (opposite effect appears on geometry). *- Specified by:
setScalein interfaceTextureTransform3D- Parameters:
newValue- is new value for the scale field.- Returns:
TextureTransform3DObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setScale
Assign typed object value to SFVec3f scale field, similar tosetScale(float[]).- Parameters:
newValue- is new value for the scale field.- Returns:
TextureTransform3DObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setScale
Assign values to SFVec3f scale field, similar tosetScale(float[]).- Parameters:
x- first componenty- second componentz- third component- Returns:
TextureTransform3DObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setScale
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetScale(float[]).- Parameters:
x- first componenty- second componentz- third component- Returns:
TextureTransform3DObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setScale
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetScale(float[]).- Parameters:
newArray- is new value for field- Returns:
TextureTransform3DObject- 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 3-tuple float results from inputOutput SFVec3f field named translation.
Tooltip: Lateral/vertical shift in 2D (s,t) texture coordinates (opposite effect appears on geometry). *- Specified by:
getTranslationin interfaceTextureTransform3D- Returns:
- value of translation field
-
setTranslation
Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named translation.
Tooltip: Lateral/vertical shift in 2D (s,t) texture coordinates (opposite effect appears on geometry). *- Specified by:
setTranslationin interfaceTextureTransform3D- Parameters:
newValue- is new value for the translation field.- Returns:
TextureTransform3DObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setTranslation
Assign typed object value to SFVec3f translation field, similar tosetTranslation(float[]).- Parameters:
newValue- is new value for the translation field.- Returns:
TextureTransform3DObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setTranslation
Assign values to SFVec3f translation field, similar tosetTranslation(float[]).- Parameters:
x- first componenty- second componentz- third component- Returns:
TextureTransform3DObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setTranslation
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetTranslation(float[]).- Parameters:
x- first componenty- second componentz- third component- Returns:
TextureTransform3DObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setTranslation
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetTranslation(float[]).- Parameters:
newArray- is new value for field- Returns:
TextureTransform3DObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getDEF
public java.lang.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:
getDEFin classX3DConcreteNode- Returns:
- value of DEF field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
setDEF
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:
setDEFin classX3DConcreteNode- Parameters:
newValue- is new value for the DEF field.- Returns:
TextureTransform3DObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDEF
Assign typed object value to SFString DEF field, similar tosetDEF(String).- Parameters:
newValue- is new value for the DEF field.- Returns:
TextureTransform3DObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getUSE
public java.lang.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:
getUSEin classX3DConcreteNode- Returns:
- value of USE field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
setUSE
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: eachUSEnode is still an independent object, with theUSEvalue matching theDEFvalue in the preceding object.
Warning: invoking thesetUSE()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:
setUSEin classX3DConcreteNode- Parameters:
newValue- is new value for the USE field.- Returns:
TextureTransform3DObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUSE
Assign typed object value to SFString USE field, similar tosetUSE(String).- Parameters:
newValue- is new value for the USE field.- Returns:
TextureTransform3DObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssClass
public java.lang.String getCssClass()Provide String value from 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
- Overrides:
getCssClassin classX3DConcreteNode- Returns:
- value of class field
- See Also:
- W3C Cascading Style Sheets
-
setCssClass
Accessor method to 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:
setCssClassin classX3DConcreteNode- Parameters:
newValue- is new value for the class field.- Returns:
TextureTransform3DObject- 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
Assign typed object value to SFString cssClass field, similar tosetCssClass(String).- Parameters:
newValue- is new value for the class field.- Returns:
TextureTransform3DObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUSE
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String).
Warning: note that thesetUSE()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:
TextureTransform3DObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addComments
Add comment as String to contained commentsList.- Specified by:
addCommentsin classX3DConcreteElement- Parameters:
newComment- initial value- Returns:
TextureTransform3DObject- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add comments as String[] array to contained commentsList.- Specified by:
addCommentsin classX3DConcreteElement- Parameters:
newComments- array of comments- Returns:
TextureTransform3DObject- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add CommentsBlock to contained commentsList.- Specified by:
addCommentsin classX3DConcreteElement- Parameters:
newCommentsBlock- block of comments to add- Returns:
TextureTransform3DObject- 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:
toStringX3Din classX3DConcreteElement- 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, X3D Canonicalization (C14N) Tool
-
toStringClassicVRML
public java.lang.String toStringClassicVRML(int indentLevel)Recursive method to provide ClassicVRML string serialization.- Specified by:
toStringClassicVRMLin classX3DConcreteElement- 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:
toStringVRML97in classX3DConcreteElement- 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
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:
findElementByNameValuein classX3DConcreteElement- 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:
findElementByNameValuein classX3DConcreteElement- 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
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:
findNodeByDEFin classX3DConcreteElement- 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:
validatein classX3DConcreteElement- Returns:
- validation results (if any)
-