Package org.web3d.x3d.sai.Texturing

Interface PixelTexture

All Superinterfaces:
X3DAppearanceChildNode, X3DNode, X3DSingleTextureNode, X3DTexture2DNode, X3DTextureNode
All Known Implementing Classes:
PixelTexture
public interface PixelTexture
extends X3DTexture2DNode
PixelTexture creates a 2D-image texture map using a numeric array of pixel values.

X3D node tooltip: [X3DTexture2DNode] PixelTexture creates a 2D-image texture map using a numeric array of pixel values. 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).
See Also:
SAI Java Specification, X3D Abstract Specification: PixelTexture, X3D Tooltips: PixelTexture, 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.
    int[] getImage()
    Provide array of int results from inputOutput SFImage field named image.
    X3DMetadataObject getMetadata()
    Provide org.web3d.x3d.sai.Core.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 org.web3d.x3d.sai.Texturing.TextureProperties instance (using a properly typed node) from initializeOnly SFNode field textureProperties.
    PixelTexture setDescription​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named description.
    PixelTexture setImage​(int[] newValue)
    Accessor method to assign int array to inputOutput SFImage field named image.
    PixelTexture setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    PixelTexture setRepeatS​(boolean newValue)
    Accessor method to assign boolean value to initializeOnly SFBool field named repeatS.
    PixelTexture setRepeatT​(boolean newValue)
    Accessor method to assign boolean value to initializeOnly SFBool field named repeatT.
    PixelTexture setTextureProperties​(TextureProperties newValue)
    Accessor method to assign org.web3d.x3d.sai.Texturing.TextureProperties instance (using a properly typed node) to initializeOnly SFNode field textureProperties.

  • 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
      Returns:
      value of description field

    • setDescription

      PixelTexture 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
      Parameters:
      newValue - is new value for the description field.
      Returns:
      PixelTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getImage

      int[] getImage()
      Provide array of int results from inputOutput SFImage field named image.

      Tooltip: Defines image: width, height, number_of_components per each pixel value, and list of pixel_values. Note that width and height are pixel count, and allowed values for RGBA number_of_components in each pixel value are 1 (intensity), 2 (intensity alpha), 3 (red green blue), 4 (red green blue alpha-opacity).
      • Warning: the order of initial values in PixelTexture and PixelTexture3D image arrays are different. Example: intensity [1 2 1 0xFF 0x00] Example: intensity-alpha [2 2 1 0 255 255 0] Example: red-green-blue [2 4 3 0xFF0000 0xFF00 0 0 0 0 0xFFFFFF 0xFFFF00] Example: red-green-blue-alpha [2 2 4 0xFFFFFFAA 0xFFFF00AA 0x11111111AA 0x787800AA]
      • Hint: it is easier to understand hexadecimal values for each pixel, but integer values are also allowed.
      • Hint: the array of pixel values has length = (width*height).
      • Hint: the full list of integers in this field has length = (width*height + 3).
      Returns:
      value of image field

    • setImage

      PixelTexture setImage​(int[] newValue)
      Accessor method to assign int array to inputOutput SFImage field named image.

      Tooltip: Defines image: width, height, number_of_components per each pixel value, and list of pixel_values. Note that width and height are pixel count, and allowed values for RGBA number_of_components in each pixel value are 1 (intensity), 2 (intensity alpha), 3 (red green blue), 4 (red green blue alpha-opacity).
      • Warning: the order of initial values in PixelTexture and PixelTexture3D image arrays are different. Example: intensity [1 2 1 0xFF 0x00] Example: intensity-alpha [2 2 1 0 255 255 0] Example: red-green-blue [2 4 3 0xFF0000 0xFF00 0 0 0 0 0xFFFFFF 0xFFFF00] Example: red-green-blue-alpha [2 2 4 0xFFFFFFAA 0xFFFF00AA 0x11111111AA 0x787800AA]
      • Hint: it is easier to understand hexadecimal values for each pixel, but integer values are also allowed.
      • Hint: the array of pixel values has length = (width*height).
      • Hint: the full list of integers in this field has length = (width*height + 3).
      Parameters:
      newValue - is new value for the image field.
      Returns:
      PixelTexture - 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.
      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

      PixelTexture 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.
      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:
      PixelTexture - 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

      PixelTexture 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:
      PixelTexture - 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

      PixelTexture 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:
      PixelTexture - 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

      PixelTexture 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:
      PixelTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).