TextureCoordinateGenerator (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DGeometricPropertyNode, X3DNode, X3DTextureCoordinateNode

All Known Implementing Classes:

TextureCoordinateGeneratorObject
```
public interface TextureCoordinateGenerator
extends X3DTextureCoordinateNode
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

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).
- Hint: add Shape and then polgyonal/planar geometry before adding TextureCoordinateGenerator.
- Hint: Texture mapping
  https://en.wikipedia.org/wiki/Texture_mapping
- Hint: X3D Texturing component Figure 18.1, Texture map coordinate system
  http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texturing.html#f-TextureMapCoordSystem
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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`X3DMetadataObject`	`getMetadata()` Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`java.lang.String`	`getMode()` Provide String enumeration value ['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`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`TextureCoordinateGenerator`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`TextureCoordinateGenerator`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`TextureCoordinateGenerator`	`setMode(java.lang.String newValue)` Assign String enumeration value ("SPHERE"\|"CAMERASPACENORMAL"\|"CAMERASPACEPOSITION"\|"CAMERASPACEREFLECTIONVECTOR"\|"SPHERE-LOCAL"\|"COORD"\|"COORD-EYE"\|"NOISE"\|"NOISE-EYE"\|"SPHERE-REFLECT"\|"SPHERE-REFLECT-LOCAL") ['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)` Assign float array to inputOutput MFFloat field named parameter.
`TextureCoordinateGenerator`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - getMetadata
```
X3DMetadataObject getMetadata()
```
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    
    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)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    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 ['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.
    - Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
    - Hint: X3D Architecture Table 18.6 Texture coordinate generation modes
      http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texturing.html#t-Texturecoordgeneration for further details.
    Returns:
    
    value of mode field
  - setMode
```
TextureCoordinateGenerator setMode(java.lang.String newValue)
```
    Assign String enumeration value ("SPHERE"|"CAMERASPACENORMAL"|"CAMERASPACEPOSITION"|"CAMERASPACEREFLECTIONVECTOR"|"SPHERE-LOCAL"|"COORD"|"COORD-EYE"|"NOISE"|"NOISE-EYE"|"SPHERE-REFLECT"|"SPHERE-REFLECT-LOCAL") ['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. Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values. Hint: X3D Architecture Table 18.6 Texture coordinate generation modes http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texturing.html#t-Texturecoordgeneration for further details.
    
    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)
```
    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).
  - setDEF
```
TextureCoordinateGenerator setDEF(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named DEF.
    
    Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
    
    Note that setting the DEF value clears the USE value.
    
    Specified by:
    
    setDEF in interface X3DGeometricPropertyNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Specified by:
    
    setDEF in interface X3DTextureCoordinateNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    TextureCoordinateGenerator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
TextureCoordinateGenerator setUSE(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named USE.
    
    Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value). Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance. Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute. Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
    
    Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.
    
    Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
    
    Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
    
    Specified by:
    
    setUSE in interface X3DGeometricPropertyNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Specified by:
    
    setUSE in interface X3DTextureCoordinateNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    TextureCoordinateGenerator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
TextureCoordinateGenerator setCssClass(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named class.
    
    Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets. Warning: currently the class attribute is only supported in XML encoding of X3D scenes. Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
    
    Specified by:
    
    setCssClass in interface X3DGeometricPropertyNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Specified by:
    
    setCssClass in interface X3DTextureCoordinateNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    TextureCoordinateGenerator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface TextureCoordinateGenerator

Method Summary

Method Detail

getMetadata

setMetadata

getMode

setMode

getParameter

setParameter

setDEF

setUSE

setCssClass