Package org.web3d.x3d.sai.Texturing

Interface TextureCoordinateGenerator

All Superinterfaces:
X3DGeometricPropertyNode, X3DNode, X3DTextureCoordinateNode
All Known Implementing Classes:
TextureCoordinateGeneratorObject
public interface TextureCoordinateGenerator
extends X3DTextureCoordinateNode
TextureCoordinateGenerator computes 2D (s,t) texture-coordinate points, used by vertex-based geometry nodes (such as IndexedFaceSet or ElevationGrid) to map textures to vertices (and patches to NURBS surfaces).

X3D node tooltip: [X3DTextureCoordinateNode] TextureCoordinateGenerator computes 2D (s,t) texture-coordinate points, used by vertex-based geometry nodes (such as IndexedFaceSet or ElevationGrid) to map textures to vertices (and patches to NURBS surfaces).
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: TextureCoordinateGenerator, X3D Tooltips: TextureCoordinateGenerator, X3D Scene Authoring Hints: Images

  • Method Summary

    Modifier and Type Method Description
    X3DMetadataObject getMetadata()
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    java.lang.String getMode()
    Provide String enumeration value (baseType textureCoordinateGeneratorModeChoices) ["SPHERE" | "CAMERASPACENORMAL" | "CAMERASPACEPOSITION" | "CAMERASPACEREFLECTIONVECTOR" | "SPHERE-LOCAL" | "COORD" | "COORD-EYE" | "NOISE" | "NOISE-EYE" | "SPHERE-REFLECT" | "SPHERE-REFLECT-LOCAL"] from inputOutput SFString field named mode.
    float[] getParameter()
    Provide array of float results from inputOutput MFFloat field named parameter.
    TextureCoordinateGenerator setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    TextureCoordinateGenerator setMode​(java.lang.String newValue)
    Accessor method to assign String enumeration value ("SPHERE" | "CAMERASPACENORMAL" | "CAMERASPACEPOSITION" | "CAMERASPACEREFLECTIONVECTOR" | "SPHERE-LOCAL" | "COORD" | "COORD-EYE" | "NOISE" | "NOISE-EYE" | "SPHERE-REFLECT" | "SPHERE-REFLECT-LOCAL") to inputOutput SFString field named mode.
    TextureCoordinateGenerator setParameter​(float[] newValue)
    Accessor method to assign float array to inputOutput MFFloat field named parameter.

  • Method Details

    • 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 X3DGeometricPropertyNode
      Specified by:
      getMetadata in interface X3DNode
      Specified by:
      getMetadata in interface X3DTextureCoordinateNode
      Returns:
      value of metadata field
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes

    • setMetadata

      TextureCoordinateGenerator 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 X3DGeometricPropertyNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DTextureCoordinateNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      TextureCoordinateGenerator - 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

    • getMode

      java.lang.String getMode()
      Provide String enumeration value (baseType textureCoordinateGeneratorModeChoices) ["SPHERE" | "CAMERASPACENORMAL" | "CAMERASPACEPOSITION" | "CAMERASPACEREFLECTIONVECTOR" | "SPHERE-LOCAL" | "COORD" | "COORD-EYE" | "NOISE" | "NOISE-EYE" | "SPHERE-REFLECT" | "SPHERE-REFLECT-LOCAL"] from inputOutput SFString field named mode.

      Tooltip: parameter field defines the algorithm used to compute texture coordinates.
      Returns:
      value of mode field

    • setMode

      TextureCoordinateGenerator setMode​(java.lang.String newValue)
      Accessor method to assign String enumeration value ("SPHERE" | "CAMERASPACENORMAL" | "CAMERASPACEPOSITION" | "CAMERASPACEREFLECTIONVECTOR" | "SPHERE-LOCAL" | "COORD" | "COORD-EYE" | "NOISE" | "NOISE-EYE" | "SPHERE-REFLECT" | "SPHERE-REFLECT-LOCAL") to inputOutput SFString field named mode.

      Tooltip: parameter field defines the algorithm used to compute texture coordinates.
      Parameters:
      newValue - is new value for the mode field.
      Returns:
      TextureCoordinateGenerator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getParameter

      float[] getParameter()
      Provide array of float results from inputOutput MFFloat field named parameter.

      Tooltip: parameter array contains scale and translation (x y z) values for Perlin NOISE mode, parameter[0] contains index of refraction for SPHERE-REFLECT mode, parameter[0] contains index of refraction and parameter[1 to 3] contains the eye point in local coordinates for SPHERE-REFLECT-LOCAL mode. *
      Returns:
      value of parameter field

    • setParameter

      TextureCoordinateGenerator setParameter​(float[] newValue)
      Accessor method to assign float array to inputOutput MFFloat field named parameter.

      Tooltip: parameter array contains scale and translation (x y z) values for Perlin NOISE mode, parameter[0] contains index of refraction for SPHERE-REFLECT mode, parameter[0] contains index of refraction and parameter[1 to 3] contains the eye point in local coordinates for SPHERE-REFLECT-LOCAL mode. *
      Parameters:
      newValue - is new value for the parameter field.
      Returns:
      TextureCoordinateGenerator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).