All Superinterfaces:: X3DAppearanceChildNode, X3DNode, X3DSingleTextureNode, X3DTexture2DNode, X3DTextureNode, X3DUrlObject

All Known Implementing Classes:: ImageTexture

public interface ImageTexture
extends X3DTexture2DNode, X3DUrlObject

ImageTexture maps a 2D-image file onto a geometric shape.

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 https://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 https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD2/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, X3D Abstract Specification: ImageTexture, X3D Tooltips: ImageTexture, X3D Scene Authoring Hints: Images

Method Summary

Modifier and Type	Method	Description
`java.lang.String`	`getDescription()`	Provide String value from inputOutput SFString field named description.
`boolean`	`getLoad()`	Provide boolean value from inputOutput SFBool field named load.
`X3DMetadataObject`	`getMetadata()`	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`double`	`getRefresh()`	Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named refresh.
`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 org.web3d.x3d.sai.Texturing.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`	`setDescription(java.lang.String newValue)`	Accessor method to assign String value to inputOutput SFString field named description.
`ImageTexture`	`setLoad(boolean newValue)`	Accessor method to assign boolean value to inputOutput SFBool field named load.
`ImageTexture`	`setMetadata(X3DMetadataObject newValue)`	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`ImageTexture`	`setRefresh(double newValue)`	Accessor method to assign double value in seconds to inputOutput SFTime field named refresh.
`ImageTexture`	`setRepeatS(boolean newValue)`	Accessor method to assign boolean value to initializeOnly SFBool field named repeatS.
`ImageTexture`	`setRepeatT(boolean newValue)`	Accessor method to assign boolean value to initializeOnly SFBool field named repeatT.
`ImageTexture`	`setTextureProperties(TextureProperties newValue)`	Accessor method to assign org.web3d.x3d.sai.Texturing.TextureProperties instance (using a properly typed node) to initializeOnly SFNode field textureProperties.
`ImageTexture`	`setUrl(java.lang.String[] newValue)`	Accessor method to assign String array to inputOutput MFString field named url.

Method Details
- getDescription
  
  java.lang.String getDescription()
  Provide String value from inputOutput SFString field named description.
  
  Tooltip: Author-provided prose that describes intended purpose of the url asset.
  
  Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
  Specified by:
  
  getDescription in interface X3DSingleTextureNode
  
  Specified by:
  
  getDescription in interface X3DTexture2DNode
  
  Specified by:
  
  getDescription in interface X3DTextureNode
  
  Specified by:
  
  getDescription in interface X3DUrlObject
  
  Returns:
  
  value of description field
- setDescription
  
  ImageTexture setDescription(java.lang.String newValue)
  Accessor method to assign String value to inputOutput SFString field named description.
  
  Tooltip: Author-provided prose that describes intended purpose of the url asset.
  
  Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
  Specified by:
  
  setDescription in interface X3DSingleTextureNode
  
  Specified by:
  
  setDescription in interface X3DTexture2DNode
  
  Specified by:
  
  setDescription in interface X3DTextureNode
  
  Specified by:
  
  setDescription in interface X3DUrlObject
  
  Parameters:
  
  newValue - is new value for the description field.
  
  Returns:
  
  ImageTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getLoad
  
  boolean getLoad()
  Provide boolean value from inputOutput SFBool field named load.
  
  Tooltip: load=true means load immediately, load=false means defer loading or else unload a previously loaded scene.
  
  Hint: allows author to design when Inline loading occurs via user interaction, event chains or scripting.
  
  Hint: use a separate LoadSensor node to detect when loading is complete.
  Specified by:
  
  getLoad in interface X3DUrlObject
  
  Returns:
  
  value of load field
- setLoad
  
  ImageTexture setLoad(boolean newValue)
  Accessor method to assign boolean value to inputOutput SFBool field named load.
  
  Tooltip: load=true means load immediately, load=false means defer loading or else unload a previously loaded scene.
  
  Hint: allows author to design when Inline loading occurs via user interaction, event chains or scripting.
  
  Hint: use a separate LoadSensor node to detect when loading is complete.
  Specified by:
  
  setLoad in interface X3DUrlObject
  
  Parameters:
  
  newValue - is new value for the load field.
  
  Returns:
  
  ImageTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getMetadata
  
  X3DMetadataObject getMetadata()
  Provide org.web3d.x3d.sai.Core.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.
  
  Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata
  Specified by:
  
  getMetadata in interface X3DAppearanceChildNode
  
  Specified by:
  
  getMetadata in interface X3DNode
  
  Specified by:
  
  getMetadata in interface X3DSingleTextureNode
  
  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)
  Accessor method to assign org.web3d.x3d.sai.Core.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.
  
  Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata
  Specified by:
  
  setMetadata in interface X3DAppearanceChildNode
  
  Specified by:
  
  setMetadata in interface X3DNode
  
  Specified by:
  
  setMetadata in interface X3DSingleTextureNode
  
  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
- getRefresh
  
  double getRefresh()
  Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named refresh.
  
  Tooltip: refresh defines interval in seconds before automatic reload of current url asset is performed.
  
  Hint: if preceding file loading fails or load field is false, no refresh is performed.
  
  Hint: repeated refresh attempts to reload currently loaded entry of url list. If that fails, the browser retries other entries in the url list.
  
  Warning: automatically reloading content has security considerations and needs to be considered carefully.
  Specified by:
  
  getRefresh in interface X3DUrlObject
  
  Returns:
  
  value of refresh field
- setRefresh
  
  ImageTexture setRefresh(double newValue)
  Accessor method to assign double value in seconds to inputOutput SFTime field named refresh.
  
  Tooltip: refresh defines interval in seconds before automatic reload of current url asset is performed.
  
  Hint: if preceding file loading fails or load field is false, no refresh is performed.
  
  Hint: repeated refresh attempts to reload currently loaded entry of url list. If that fails, the browser retries other entries in the url list.
  
  Warning: automatically reloading content has security considerations and needs to be considered carefully.
  Specified by:
  
  setRefresh in interface X3DUrlObject
  
  Parameters:
  
  newValue - is new value for the refresh field.
  
  Returns:
  
  ImageTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- 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)
  
  Accessor method to 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)
  
  Accessor method to 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 org.web3d.x3d.sai.Texturing.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)
  
  Accessor method to assign org.web3d.x3d.sai.Texturing.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 "https://www.web3d.org" "https://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 https://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)
  Accessor method to 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 "https://www.web3d.org" "https://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 https://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).

Interface ImageTexture

Method Summary

Method Details