Package org.web3d.x3d.sai.Texturing

Interface TextureTransform

All Superinterfaces:
X3DAppearanceChildNode, X3DNode, X3DTextureTransformNode
All Known Implementing Classes:
TextureTransformObject
public interface TextureTransform
extends X3DTextureTransformNode
TextureTransform shifts 2D texture coordinates for positioning, orienting and scaling image textures on geometry.

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 interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:
SAI Java Specification: TODO, X3D Abstract Specification: TextureTransform, X3D Tooltips: TextureTransform, X3D Scene Authoring Hints: Images

  • Method Summary

    Modifier and Type Method Description
    float[] getCenter()
    Provide array of 2-tuple float results from inputOutput SFVec2f field named center.
    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.
    TextureTransform setCenter​(float[] newValue)
    Accessor method to assign 2-tuple float array to inputOutput SFVec2f field named center.
    TextureTransform setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    TextureTransform setRotation​(float newValue)
    Accessor method to assign float value unit axis, angle (in radians) to inputOutput SFFloat field named rotation.
    TextureTransform setScale​(float[] newValue)
    Accessor method to assign 2-tuple float array to inputOutput SFVec2f field named scale.
    TextureTransform setTranslation​(float[] newValue)
    Accessor method to assign 2-tuple float array to inputOutput SFVec2f field named translation.

  • Method Details

    • getCenter

      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. *
      Returns:
      value of center field

    • setCenter

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

    • getMetadata

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

      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
      Specified by:
      getMetadata in interface X3DAppearanceChildNode
      Specified by:
      getMetadata in interface X3DNode
      Specified by:
      getMetadata in interface X3DTextureTransformNode
      Returns:
      value of metadata field
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes

    • setMetadata

      TextureTransform setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
      Specified by:
      setMetadata in interface X3DAppearanceChildNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DTextureTransformNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      TextureTransform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes

    • getRotation

      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.
      Returns:
      value of rotation field

    • setRotation

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

    • getScale

      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). *
      Returns:
      value of scale field

    • setScale

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

    • getTranslation

      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). *
      Returns:
      value of translation field

    • setTranslation

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