Post

ImageTextureAtlas

Overview

ImageTextureAtlas defines a 3D image-based texture map by specifying a single image file that contains slices for complete 3D data.

The ImageTextureAtlas node belongs to the Texturing3D component and its default container field is texture. It is available since X3D version 4.0 or later.

Info: Please note that this node is still experimental, i.e. the functionality of this node may change in future versions of X_ITE. This node is available in X_ITE and X3DOM.

Hierarchy

1
2
3
4
5
6
+ X3DNode
  + X3DAppearanceChildNode
    + X3DTextureNode
      + X3DSingleTextureNode
        + X3DTexture3DNode
          + ImageTextureAtlas (X3DUrlObject)*

* Derived from multiple interfaces.

Fields

SFNode [in, out] metadata NULL [X3DMetadataObject]

Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.

Hint

SFString [in, out] description “”

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).

SFBool [in, out] load TRUE

load=true means load immediately, load=false means defer loading or else unload a previously loaded scene.

Hints

  • Allows author to design when Inline loading occurs via user interaction, event chains or scripting.
  • Use a separate LoadSensor node to detect when loading is complete.

MFString [in, out] url [ ] [URI]

Location and filename of image. Multiple locations are more reliable, and including a Web address lets e-mail attachments work.

Hints

  • MFString arrays can have multiple values, so separate each individual string by quote marks “https://www.web3d.org” “https://www.web3d.org/about” “etc.”
  • Alternative XML encoding for quotation mark “ is " (which is an example of a character entity).
  • Can replace embedded blank(s) in url queries with %20 for each blank character.
  • X3D Scene Authoring Hints, urls

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.

SFTime [in, out] autoRefresh 0 [0,∞)

autoRefresh defines interval in seconds before automatic reload of current url asset is performed.

Hints

  • If preceding file loading fails or load field is false, no refresh is performed.
  • 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.

SFTime [in, out] autoRefreshTimeLimit 3600 [0,∞)

autoRefreshTimeLimit defines maximum duration that automatic refresh activity can occur.

Hint

  • Automatic refresh is different than query and response timeouts performed by a networking library while sequentially attempting to retrieve addressed content from a url list.

Warning

  • Automatically reloading content has security considerations and needs to be considered carefully.

SFInt32 [in, out] slicesOverX 0 [0,∞)

Number of images in x direction.

SFInt32 [in, out] slicesOverY 0 [0,∞)

Number of images in y direction.

SFInt32 [in, out] numberOfSlices 0 [0,∞)

Total number of images.

SFBool [ ] repeatS FALSE

Whether to repeat texture along S axis horizontally from left to right.

SFBool [ ] repeatT FALSE

Whether to repeat texture along T axis vertically from top to bottom.

SFBool [ ] repeatR FALSE

Whether to repeat texture along R axis from front to back.

SFNode [ ] textureProperties NULL [TextureProperties]

Single contained TextureProperties node that can specify additional visual attributes applied to corresponding texture images.

Supported File Formats

Any image file format supported by the web browser, but at least:

EncodingFile ExtensionMIME TypeComment
PNG.pngimage/pnglossless
AVIF.avifimage/aviflossless/lossy
WebP.webpimage/webplossless/lossy
JPEG.jpeg, .jpgimage/jpeglossy
GIF.gifimage/giflossy
SVG.svgimage/svg 

An example image can be found here.

Example

See Also

This post is licensed under CC BY 4.0 by the author.