Class TextureTransform

All Implemented Interfaces:
X3DNode, X3DAppearanceChildNode, TextureTransform, X3DTextureTransformNode

public class TextureTransform extends X3DConcreteNode implements TextureTransform
TextureTransform shifts 2D texture coordinates for positioning, orienting and scaling image textures on geometry.

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes. 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 <a href="https://en.wikipedia.org/wiki/Texture_mapping" target="_blank">https://en.wikipedia.org/wiki/Texture_mapping</a> *


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:
  • Field Details

    • NAME

      public static final String NAME
      String constant NAME provides name of this element: TextureTransform.
      See Also:
    • COMPONENT

      public static final String COMPONENT
      String constant COMPONENT defines X3D component for the TextureTransform element: Texturing
      See Also:
    • LEVEL

      public static final int LEVEL
      Integer constant LEVEL provides default X3D Texturing component level for this element: 1
      See Also:
    • 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).
    • IS_DEFAULT_VALUE

      public static final IS IS_DEFAULT_VALUE
      SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
    • MAPPING_DEFAULT_VALUE

      public static final String MAPPING_DEFAULT_VALUE
      SFString field named mapping has default value equal to an empty string.
      See Also:
    • METADATA_DEFAULT_VALUE

      public static final X3DMetadataObject 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_VALUE
      SFFloat field named rotation has default value 0f (Java syntax) or 0 (XML syntax).
      See Also:
    • 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 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:
    • fromField_CENTER

      public static final String fromField_CENTER
      fromField ROUTE name for SFVec2f field named center.
      See Also:
    • toField_CENTER

      public static final String toField_CENTER
      toField ROUTE name for SFVec2f field named center.
      See Also:
    • fromField_IS

      public static final String fromField_IS
      fromField ROUTE name for SFNode field named IS.
      See Also:
    • fromField_MAPPING

      public static final String fromField_MAPPING
      fromField ROUTE name for SFString field named mapping.
      See Also:
    • toField_MAPPING

      public static final String toField_MAPPING
      toField ROUTE name for SFString field named mapping.
      See Also:
    • fromField_METADATA

      public static final String fromField_METADATA
      fromField ROUTE name for SFNode field named metadata.
      See Also:
    • toField_METADATA

      public static final String toField_METADATA
      toField ROUTE name for SFNode field named metadata.
      See Also:
    • fromField_ROTATION

      public static final String fromField_ROTATION
      fromField ROUTE name for SFFloat field named rotation.
      See Also:
    • toField_ROTATION

      public static final String toField_ROTATION
      toField ROUTE name for SFFloat field named rotation.
      See Also:
    • fromField_SCALE

      public static final String fromField_SCALE
      fromField ROUTE name for SFVec2f field named scale.
      See Also:
    • toField_SCALE

      public static final String toField_SCALE
      toField ROUTE name for SFVec2f field named scale.
      See Also:
    • fromField_TRANSLATION

      public static final String fromField_TRANSLATION
      fromField ROUTE name for SFVec2f field named translation.
      See Also:
    • toField_TRANSLATION

      public static final String toField_TRANSLATION
      toField ROUTE name for SFVec2f field named translation.
      See Also:
  • Constructor Details

    • TextureTransform

      public TextureTransform()
      Constructor for TextureTransform to initialize member variables with default values.
    • TextureTransform

      public TextureTransform(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: TextureTransform
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element
    • getComponent

      public final 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 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:
    • 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:
    • getContainerFieldDefault

      public final 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:
    • 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 TextureTransform setCenter(float[] newValue)
      Accessor method to 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:
      TextureTransform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setCenter

      public TextureTransform setCenter(SFVec2f newValue)
      Assign typed object value to SFVec2f center field, similar to setCenter(float[]). // #0.e
      Parameters:
      newValue - is new value for the center field.
      Returns:
      TextureTransform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setCenter

      public TextureTransform setCenter(float x, float y)
      Assign values to SFVec2f center field, similar to setCenter(float[]).
      Parameters:
      x - first component
      y - second component
      Returns:
      TextureTransform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setCenter

      public TextureTransform setCenter(double x, double y)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setCenter(float[]).
      Parameters:
      x - first component
      y - second component
      Returns:
      TextureTransform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setCenter

      public TextureTransform setCenter(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setCenter(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      TextureTransform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • 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:
    • setIS

      public TextureTransform 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:
      TextureTransform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
    • clearIS

      public TextureTransform clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      TextureTransform - 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:
    • getMapping

      public String getMapping()
      Provide String value from inputOutput SFString field named mapping.

      Tooltip: The mapping label identifies which texture coordinates and transformations are used to compute texture effects from corresponding geometry on a given material. Hint: TODO support planned to perform multiple-node mapping validation checks using X3D Schematron or X3D Validator <a href="https://savage.nps.edu/X3dValidator" target="_blank">https://savage.nps.edu/X3dValidator</a> *
      Specified by:
      getMapping in interface TextureTransform
      Returns:
      value of mapping field
    • setMapping

      public TextureTransform setMapping(String newValue)
      Accessor method to assign String value to inputOutput SFString field named mapping.

      Tooltip: The mapping label identifies which texture coordinates and transformations are used to compute texture effects from corresponding geometry on a given material. Hint: TODO support planned to perform multiple-node mapping validation checks using X3D Schematron or X3D Validator <a href="https://savage.nps.edu/X3dValidator" target="_blank">https://savage.nps.edu/X3dValidator</a> *
      Specified by:
      setMapping in interface TextureTransform
      Parameters:
      newValue - is new value for the mapping field.
      Returns:
      TextureTransform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setMapping

      public TextureTransform setMapping(SFString newValue)
      Assign typed object value to SFString mapping field, similar to setMapping(String). // #0.e
      Parameters:
      newValue - is new value for the mapping field.
      Returns:
      TextureTransform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • 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 TextureTransform
      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 <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/core.html#Metadata" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/core.html#Metadata</a> *
      • X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      public TextureTransform 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 TextureTransform
      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:
      TextureTransform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
    • clearMetadata

      public TextureTransform clearMetadata()
      Utility method to clear SFNode value of metadata field.
      Returns:
      TextureTransform - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setMetadata

      public TextureTransform 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:
      TextureTransform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
    • 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:
    • 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 TextureTransform setRotation(float newValue)
      Accessor method to 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:
      TextureTransform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setRotation

      public TextureTransform setRotation(SFFloat newValue)
      Assign typed object value to SFFloat rotation field, similar to setRotation(float). // #0.e
      Parameters:
      newValue - is new value for the rotation field.
      Returns:
      TextureTransform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setRotation

      public TextureTransform setRotation(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setRotation(float).
      Parameters:
      newValue - is new value for field
      Returns:
      TextureTransform - 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 TextureTransform setScale(float[] newValue)
      Accessor method to 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:
      TextureTransform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setScale

      public TextureTransform setScale(SFVec2f newValue)
      Assign typed object value to SFVec2f scale field, similar to setScale(float[]). // #0.e
      Parameters:
      newValue - is new value for the scale field.
      Returns:
      TextureTransform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setScale

      public TextureTransform setScale(float x, float y)
      Assign values to SFVec2f scale field, similar to setScale(float[]).
      Parameters:
      x - first component
      y - second component
      Returns:
      TextureTransform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setScale

      public TextureTransform setScale(double x, double y)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setScale(float[]).
      Parameters:
      x - first component
      y - second component
      Returns:
      TextureTransform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setScale

      public TextureTransform setScale(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setScale(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      TextureTransform - 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 TextureTransform setTranslation(float[] newValue)
      Accessor method to 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:
      TextureTransform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setTranslation

      public TextureTransform setTranslation(SFVec2f newValue)
      Assign typed object value to SFVec2f translation field, similar to setTranslation(float[]). // #0.e
      Parameters:
      newValue - is new value for the translation field.
      Returns:
      TextureTransform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setTranslation

      public TextureTransform setTranslation(float x, float y)
      Assign values to SFVec2f translation field, similar to setTranslation(float[]).
      Parameters:
      x - first component
      y - second component
      Returns:
      TextureTransform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setTranslation

      public TextureTransform setTranslation(double x, double y)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setTranslation(float[]).
      Parameters:
      x - first component
      y - second component
      Returns:
      TextureTransform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setTranslation

      public TextureTransform setTranslation(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setTranslation(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      TextureTransform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • 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 <a href="https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions" target="_blank">https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions</a> *
      Overrides:
      getDEF in class X3DConcreteNode
      Returns:
      value of DEF field
      See Also:
    • setDEF

      public final TextureTransform 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 <a href="https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions" target="_blank">https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions</a> *


      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:
      TextureTransform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDEF

      public TextureTransform setDEF(SFString newValue)
      Assign typed object value to SFString DEF field, similar to setDEF(String). // #0.e
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      TextureTransform - 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:
    • setUSE

      public final TextureTransform 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:
      TextureTransform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

      public TextureTransform setUSE(SFString newValue)
      Assign typed object value to SFString USE field, similar to setUSE(String). // #0.e
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      TextureTransform - 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:
    • setCssClass

      public final TextureTransform 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:
      TextureTransform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
    • setCssClass

      public TextureTransform setCssClass(SFString newValue)
      Assign typed object value to SFString cssClass field, similar to setCssClass(String). // #0.e
      Parameters:
      newValue - is new value for the class field.
      Returns:
      TextureTransform - 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:
    • setHtmlID

      public final TextureTransform 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:
      TextureTransform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
    • setHtmlID

      public TextureTransform setHtmlID(SFString newValue)
      Assign typed object value to SFString HtmlID field, similar to setHtmlID(String). // #0.e
      Parameters:
      newValue - is new value for the id field.
      Returns:
      TextureTransform - 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:
    • setCssStyle

      public final TextureTransform 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:
      TextureTransform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
    • setCssStyle

      public TextureTransform setCssStyle(SFString newValue)
      Assign typed object value to SFString cssClass field, similar to setCssStyle(String). // #0.e
      Parameters:
      newValue - is new value for the style field.
      Returns:
      TextureTransform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

      public TextureTransform setUSE(TextureTransform 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:
      TextureTransform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addComments

      public TextureTransform addComments(String newComment)
      Add comment as String to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComment - initial value
      Returns:
      TextureTransform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
    • addComments

      public TextureTransform addComments(String[] newComments)
      Add comments as String[] array to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComments - array of comments
      Returns:
      TextureTransform - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addComments

      public TextureTransform addComments(CommentsBlock newCommentsBlock)
      Add CommentsBlock to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      TextureTransform - 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:
    • 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:
    • 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:
    • 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:
    • 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:
    • 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:
    • 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:
    • 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:
    • 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.
      Specified by:
      validate in class X3DConcreteElement
      Returns:
      validation results (if any)