Package org.web3d.x3d.sai.Texturing
Interface ImageTexture
- All Superinterfaces:
X3DAppearanceChildNode,X3DNode,X3DTexture2DNode,X3DTextureNode,X3DUrlObject
- All Known Implementing Classes:
ImageTextureObject
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.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
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/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).
-
Method Summary
Modifier and Type Method Description X3DMetadataObjectgetMetadata()Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.booleangetRepeatS()Provide boolean value from initializeOnly SFBool field named repeatS.booleangetRepeatT()Provide boolean value from initializeOnly SFBool field named repeatT.TexturePropertiesgetTextureProperties()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.ImageTexturesetMetadata(X3DMetadataObject newValue)Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.ImageTexturesetRepeatS(boolean newValue)Accessor method to assign boolean value to initializeOnly SFBool field named repeatS.ImageTexturesetRepeatT(boolean newValue)Accessor method to assign boolean value to initializeOnly SFBool field named repeatT.ImageTexturesetTextureProperties(TextureProperties newValue)Accessor method to assign TextureProperties instance (using a properly typed node) to initializeOnly SFNode field textureProperties.ImageTexturesetUrl(java.lang.String[] newValue)Accessor method to assign String array to inputOutput MFString field named url.
-
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.- Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
- Specified by:
getMetadatain interfaceX3DAppearanceChildNode- Specified by:
getMetadatain interfaceX3DNode- Specified by:
getMetadatain interfaceX3DTexture2DNode- Specified by:
getMetadatain interfaceX3DTextureNode- Returns:
- value of metadata field
- See Also:
- X3D Scene Authoring Hints: Metadata Nodes
-
setMetadata
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.- Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
- Specified by:
setMetadatain interfaceX3DAppearanceChildNode- Specified by:
setMetadatain interfaceX3DNode- Specified by:
setMetadatain interfaceX3DTexture2DNode- Specified by:
setMetadatain interfaceX3DTextureNode- 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:
getRepeatSin interfaceX3DTexture2DNode- Returns:
- value of repeatS field
-
setRepeatS
Accessor method to assign boolean value to initializeOnly SFBool field named repeatS.
Tooltip: Whether to horizontally repeat texture along S axis. *- Specified by:
setRepeatSin interfaceX3DTexture2DNode- 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:
getRepeatTin interfaceX3DTexture2DNode- Returns:
- value of repeatT field
-
setRepeatT
Accessor method to assign boolean value to initializeOnly SFBool field named repeatT.
Tooltip: Whether to vertically repeat texture along T axis. *- Specified by:
setRepeatTin interfaceX3DTexture2DNode- 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:
getTexturePropertiesin interfaceX3DTexture2DNode- Returns:
- value of textureProperties field
-
setTextureProperties
Accessor method to assign TextureProperties instance (using a properly typed node) to initializeOnly SFNode field textureProperties.- Specified by:
setTexturePropertiesin interfaceX3DTexture2DNode- 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:
getUrlin interfaceX3DUrlObject- Returns:
- value of url field
-
setUrl
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:
setUrlin interfaceX3DUrlObject- 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).
-