PixelTexture (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DAppearanceChildNode, X3DNode, X3DTexture2DNode, X3DTextureNode

All Known Implementing Classes:

PixelTextureObject
```
public interface PixelTexture
extends X3DTexture2DNode
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

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.
- Hint: this is a good way to bundle image(s) into a single scene file, avoiding multiple downloads.
- Warning: aggregate file size can grow dramatically.
- Hint: can contain a single TextureProperties node.
- Hint: insert Shape and Appearance nodes before adding texture.
- Hint: X3D Scene Authoring Hints, Images and Videos
  http://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.
- Hint: Texture mapping
  https://en.wikipedia.org/wiki/Texture_mapping
- Hint: X3D Architecture 17.2.2 Lighting model
  http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/lighting.html#Lightingmodel
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:

SAI Java Specification: TODO, X3D Abstract Specification: PixelTexture, X3D Tooltips: PixelTexture, X3D Scene Authoring Hints: Images

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int[]`	`getImage()` Provide array of int results from inputOutput SFImage field named image.
`X3DMetadataObject`	`getMetadata()` Provide 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 TextureProperties instance (using a properly typed node) from initializeOnly SFNode field textureProperties.
`PixelTexture`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`PixelTexture`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`PixelTexture`	`setImage(int[] newValue)` Assign int array to inputOutput SFImage field named image.
`PixelTexture`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`PixelTexture`	`setRepeatS(boolean newValue)` Assign boolean value to initializeOnly SFBool field named repeatS.
`PixelTexture`	`setRepeatT(boolean newValue)` Assign boolean value to initializeOnly SFBool field named repeatT.
`PixelTexture`	`setTextureProperties(TextureProperties newValue)` Assign TextureProperties instance (using a properly typed node) to initializeOnly SFNode field textureProperties.
`PixelTexture`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - getImage
```
int[] getImage()
```
    Provide array of int results from inputOutput SFImage field named image.
    
    Tooltip: Defines image: width height number_of_components pixel_values. width and height are pixel count, number_of_components = 1 (intensity), 2 (intensity alpha), 3 (red green blue), 4 (red green blue alpha-opacity). 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]. *
    
    Returns:
    
    value of image field
  - setImage
```
PixelTexture setImage(int[] newValue)
```
    Assign int array to inputOutput SFImage field named image.
    
    Tooltip: Defines image: width height number_of_components pixel_values. width and height are pixel count, number_of_components = 1 (intensity), 2 (intensity alpha), 3 (red green blue), 4 (red green blue alpha-opacity). 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].
    
    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 X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    
    Specified by:
    
    getMetadata in interface X3DAppearanceChildNode
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    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)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DAppearanceChildNode
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    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)
```
    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)
```
    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 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)
```
    Assign 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).
  - setDEF
```
PixelTexture setDEF(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named DEF.
    
    Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
    
    Note that setting the DEF value clears the USE value.
    
    Specified by:
    
    setDEF in interface X3DAppearanceChildNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Specified by:
    
    setDEF in interface X3DTexture2DNode
    
    Specified by:
    
    setDEF in interface X3DTextureNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    PixelTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
PixelTexture setUSE(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named USE.
    
    Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value). Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance. Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute. Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
    
    Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.
    
    Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
    
    Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
    
    Specified by:
    
    setUSE in interface X3DAppearanceChildNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Specified by:
    
    setUSE in interface X3DTexture2DNode
    
    Specified by:
    
    setUSE in interface X3DTextureNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    PixelTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
PixelTexture setCssClass(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named class.
    
    Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets. Warning: currently the class attribute is only supported in XML encoding of X3D scenes. Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
    
    Specified by:
    
    setCssClass in interface X3DAppearanceChildNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Specified by:
    
    setCssClass in interface X3DTexture2DNode
    
    Specified by:
    
    setCssClass in interface X3DTextureNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    PixelTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface PixelTexture

Method Summary

Method Detail

getImage

setImage

getMetadata

setMetadata

getRepeatS

setRepeatS

getRepeatT

setRepeatT

getTextureProperties

setTextureProperties

setDEF

setUSE

setCssClass