ImageTexture (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DAppearanceChildNode, X3DNode, X3DTexture2DNode, X3DTextureNode, X3DUrlObject

All Known Implementing Classes:

ImageTextureObject
```
public interface ImageTexture
extends X3DTexture2DNode, X3DUrlObject
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

X3D node tooltip: [X3DTexture2DNode,X3DUrlObject] ImageTexture maps a 2D-image file onto a geometric shape. Texture maps have a 2D coordinate system (s, t) horizontal and vertical, with (s, t) texture-coordinate values in range [0.0, 1.0] for opposite corners of the image.
- Hint: can contain a single TextureProperties node.
- Hint: insert Shape and Appearance nodes before adding texture.
- Warning: bright Material emissiveColor values can wash out some textures.
- Hint: authors can provide multiple image formats for the same image, with each source address listed separately in the url field.
- Hint: player support is required for .png and .jpg formats, support is suggested for .gif format. Other image formats are optionally supported.
- Hint: X3D Scene Authoring Hints, Images
  http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Images
- Warning: see ComposedCubeMapTexture and TextureBackground for special containerField values.
- Hint: if a texture is opaque, omitting values in the alpha channel can help avoid rendering artifacts related to transparency and reduce file size by 25%.
- Hint: Texture mapping
  https://en.wikipedia.org/wiki/Texture_mapping
- Hint: X3D Architecture 17.2.2 Lighting model
  http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/lighting.html#Lightingmodel
- Hint: apply containerField='watchList' when parent node is LoadSensor.
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: ImageTexture, X3D Tooltips: ImageTexture, 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.
`boolean`	`getRepeatS()` Provide boolean value from initializeOnly SFBool field named repeatS.
`boolean`	`getRepeatT()` Provide boolean value from initializeOnly SFBool field named repeatT.
`TextureProperties`	`getTextureProperties()` Provide TextureProperties instance (using a properly typed node) from initializeOnly SFNode field textureProperties.
`java.lang.String[]`	`getUrl()` Provide array of String results from inputOutput MFString field named url.
`ImageTexture`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`ImageTexture`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`ImageTexture`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`ImageTexture`	`setRepeatS(boolean newValue)` Assign boolean value to initializeOnly SFBool field named repeatS.
`ImageTexture`	`setRepeatT(boolean newValue)` Assign boolean value to initializeOnly SFBool field named repeatT.
`ImageTexture`	`setTextureProperties(TextureProperties newValue)` Assign TextureProperties instance (using a properly typed node) to initializeOnly SFNode field textureProperties.
`ImageTexture`	`setUrl(java.lang.String[] newValue)` Assign String array to inputOutput MFString field named url.
`ImageTexture`	`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 X3DAppearanceChildNode
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Specified by:
    
    getMetadata in interface X3DTexture2DNode
    
    Specified by:
    
    getMetadata in interface X3DTextureNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
ImageTexture setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DAppearanceChildNode
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Specified by:
    
    setMetadata in interface X3DTexture2DNode
    
    Specified by:
    
    setMetadata in interface X3DTextureNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    ImageTexture - 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
  - getRepeatS
```
boolean getRepeatS()
```
    Provide boolean value from initializeOnly SFBool field named repeatS.
    
    Tooltip: Whether to horizontally repeat texture along S axis. *
    
    Specified by:
    
    getRepeatS in interface X3DTexture2DNode
    
    Returns:
    
    value of repeatS field
  - setRepeatS
```
ImageTexture setRepeatS(boolean newValue)
```
    Assign boolean value to initializeOnly SFBool field named repeatS.
    
    Tooltip: Whether to horizontally repeat texture along S axis.
    
    Specified by:
    
    setRepeatS in interface X3DTexture2DNode
    
    Parameters:
    
    newValue - is new value for the repeatS field.
    
    Returns:
    
    ImageTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getRepeatT
```
boolean getRepeatT()
```
    Provide boolean value from initializeOnly SFBool field named repeatT.
    
    Tooltip: Whether to vertically repeat texture along T axis. *
    
    Specified by:
    
    getRepeatT in interface X3DTexture2DNode
    
    Returns:
    
    value of repeatT field
  - setRepeatT
```
ImageTexture setRepeatT(boolean newValue)
```
    Assign boolean value to initializeOnly SFBool field named repeatT.
    
    Tooltip: Whether to vertically repeat texture along T axis.
    
    Specified by:
    
    setRepeatT in interface X3DTexture2DNode
    
    Parameters:
    
    newValue - is new value for the repeatT field.
    
    Returns:
    
    ImageTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getTextureProperties
```
TextureProperties getTextureProperties()
```
    Provide TextureProperties instance (using a properly typed node) from initializeOnly SFNode field textureProperties.
    
    Specified by:
    
    getTextureProperties in interface X3DTexture2DNode
    
    Returns:
    
    value of textureProperties field
  - setTextureProperties
```
ImageTexture setTextureProperties(TextureProperties newValue)
```
    Assign TextureProperties instance (using a properly typed node) to initializeOnly SFNode field textureProperties.
    
    Specified by:
    
    setTextureProperties in interface X3DTexture2DNode
    
    Parameters:
    
    newValue - is new value for the textureProperties field.
    
    Returns:
    
    ImageTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getUrl
```
java.lang.String[] getUrl()
```
    Provide array of String results from inputOutput MFString field named url.
    
    Tooltip: Location and filename of image. Multiple locations are more reliable, and including a Web address lets e-mail attachments work.
    - Hint: MFString arrays can have multiple values, so separate each individual string by quote marks
      "http://www.web3d.org"
      "http://www.web3d.org/about" "etc."
    - Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
    - Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
    - Hint: can replace embedded blank(s) in url queries with %20 for each blank character.
    - Hint: X3D Scene Authoring Hints, urls
      http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls
    Specified by:
    
    getUrl in interface X3DUrlObject
    
    Returns:
    
    value of url field
  - setUrl
```
ImageTexture setUrl(java.lang.String[] newValue)
```
    Assign String array to inputOutput MFString field named url.
    
    Tooltip: Location and filename of image. Multiple locations are more reliable, and including a Web address lets e-mail attachments work. Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "http://www.web3d.org" "http://www.web3d.org/about" "etc." Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity). Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches. Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Hint: X3D Scene Authoring Hints, urls http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls
    
    Specified by:
    
    setUrl in interface X3DUrlObject
    
    Parameters:
    
    newValue - is new value for the url field.
    
    Returns:
    
    ImageTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
ImageTexture 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 X3DAppearanceChildNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Specified by:
    
    setDEF in interface X3DTexture2DNode
    
    Specified by:
    
    setDEF in interface X3DTextureNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    ImageTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
ImageTexture 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 X3DAppearanceChildNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Specified by:
    
    setUSE in interface X3DTexture2DNode
    
    Specified by:
    
    setUSE in interface X3DTextureNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    ImageTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
ImageTexture 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 X3DAppearanceChildNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Specified by:
    
    setCssClass in interface X3DTexture2DNode
    
    Specified by:
    
    setCssClass in interface X3DTextureNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    ImageTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface ImageTexture

Method Summary

Method Detail

getMetadata

setMetadata

getRepeatS

setRepeatS

getRepeatT

setRepeatT

getTextureProperties

setTextureProperties

getUrl

setUrl

setDEF

setUSE

setCssClass