Package org.web3d.x3d.sai.Texturing3D

Interface PixelTexture3D

All Superinterfaces:
X3DAppearanceChildNode, X3DNode, X3DTexture3DNode, X3DTextureNode
All Known Implementing Classes:
PixelTexture3D
public interface PixelTexture3D
extends X3DTexture3DNode
PixelTexture3D defines a 3D image-based texture map as an explicit array of pixel values (image field).

X3D node tooltip: (X3D version 3.1 or later) [X3DTexture3DNode] PixelTexture3D defines a 3D image-based texture map as an explicit array of pixel values (image field).
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: PixelTexture3D, X3D Tooltips: PixelTexture3D, 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 MFInt32 field named image.
    X3DMetadataObject getMetadata()
    Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    boolean getRepeatR()
    Provide boolean value from initializeOnly SFBool field named repeatR.
    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.
    PixelTexture3D setDescription​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named description.
    PixelTexture3D setImage​(int[] newValue)
    Accessor method to assign int array to inputOutput MFInt32 field named image.
    PixelTexture3D setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    PixelTexture3D setRepeatR​(boolean newValue)
    Accessor method to assign boolean value to initializeOnly SFBool field named repeatR.
    PixelTexture3D setRepeatS​(boolean newValue)
    Accessor method to assign boolean value to initializeOnly SFBool field named repeatS.
    PixelTexture3D setRepeatT​(boolean newValue)
    Accessor method to assign boolean value to initializeOnly SFBool field named repeatT.
    PixelTexture3D 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 X3DTexture3DNode
      Specified by:
      getDescription in interface X3DTextureNode
      Returns:
      value of description field

    • setDescription

      PixelTexture3D 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 X3DTexture3DNode
      Specified by:
      setDescription in interface X3DTextureNode
      Parameters:
      newValue - is new value for the description field.
      Returns:
      PixelTexture3D - 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 MFInt32 field named image.

      Tooltip: image describes raw data for this 3D texture: number of components to the image [0,4], width, height and depth of the texture, followed by (width x height x depth) pixel values.
      • Warning: the order of initial values in PixelTexture and PixelTexture3D image arrays are different.
      Returns:
      value of image field

    • setImage

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

      Tooltip: image describes raw data for this 3D texture: number of components to the image [0,4], width, height and depth of the texture, followed by (width x height x depth) pixel values.
      • Warning: the order of initial values in PixelTexture and PixelTexture3D image arrays are different.
      Parameters:
      newValue - is new value for the image field.
      Returns:
      PixelTexture3D - 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 X3DTexture3DNode
      Specified by:
      getMetadata in interface X3DTextureNode
      Returns:
      value of metadata field
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes

    • setMetadata

      PixelTexture3D 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 X3DTexture3DNode
      Specified by:
      setMetadata in interface X3DTextureNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      PixelTexture3D - 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

    • getRepeatR

      boolean getRepeatR()
      Provide boolean value from initializeOnly SFBool field named repeatR.

      Tooltip: Whether to vertically repeat texture along R axis. *
      Specified by:
      getRepeatR in interface X3DTexture3DNode
      Returns:
      value of repeatR field

    • setRepeatR

      PixelTexture3D setRepeatR​(boolean newValue)
      Accessor method to assign boolean value to initializeOnly SFBool field named repeatR.

      Tooltip: Whether to vertically repeat texture along R axis. *
      Specified by:
      setRepeatR in interface X3DTexture3DNode
      Parameters:
      newValue - is new value for the repeatR field.
      Returns:
      PixelTexture3D - 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 X3DTexture3DNode
      Returns:
      value of repeatS field

    • setRepeatS

      PixelTexture3D 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 X3DTexture3DNode
      Parameters:
      newValue - is new value for the repeatS field.
      Returns:
      PixelTexture3D - 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 X3DTexture3DNode
      Returns:
      value of repeatT field

    • setRepeatT

      PixelTexture3D 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 X3DTexture3DNode
      Parameters:
      newValue - is new value for the repeatT field.
      Returns:
      PixelTexture3D - 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 X3DTexture3DNode
      Returns:
      value of textureProperties field

    • setTextureProperties

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