ImageComponentState (Java 3D Javadocs 0-SNAPSHOT API)

java.lang.Object
- org.scijava.java3d.utils.scenegraph.io.state.org.scijava.java3d.SceneGraphObjectState
- - org.scijava.java3d.utils.scenegraph.io.state.org.scijava.java3d.NodeComponentState
  - - org.scijava.java3d.utils.scenegraph.io.state.org.scijava.java3d.ImageComponentState

Direct Known Subclasses:

ImageComponent2DState, ImageComponent2DURLState, ImageComponent3DState
```
public abstract class ImageComponentState
extends NodeComponentState
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`byReference`
`protected int`	`format`
`static byte`	`GZIP_COMPRESSION` Use GZIP to compress images.
`protected int`	`height`
`static byte`	`JPEG_COMPRESSION` Use JPEG compression for images JPEG compression is currently the default.
`static byte`	`NO_COMPRESSION` Do not compress the images
`protected int`	`width`
`protected boolean`	`yUp`

Fields inherited from class org.scijava.java3d.utils.scenegraph.io.state.org.scijava.java3d.SceneGraphObjectState
control, node, nodeClassName, symbol

Constructor Summary

Constructors
Constructor and Description

ImageComponentState(SymbolTableData symbol, Controller control)

Constructors
Constructor and Description
`ImageComponentState(SymbolTableData symbol, Controller control)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected BufferedImage`	`readBufferedImage(DataInput in)`
`protected void`	`readConstructorParams(DataInput in)` Read the parameters required for the constructor of the Java3D object
`protected void`	`writeBufferedImage(DataOutput out, BufferedImage image)`
`protected void`	`writeConstructorParams(DataOutput out)` Write the parameters required for the constructor of the Java3D object

Methods inherited from class org.scijava.java3d.utils.scenegraph.io.state.org.scijava.java3d.NodeComponentState
addSubReference, readObject, writeObject

Methods inherited from class org.scijava.java3d.utils.scenegraph.io.state.org.scijava.java3d.SceneGraphObjectState
buildGraph, cleanup, createNode, createNode, createNode, createNode, createState, getNode, getNodeID, getSymbol, readString, writeString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - format
```
protected int format
```
  - height
```
protected int height
```
  - width
```
protected int width
```
  - byReference
```
protected boolean byReference
```
  - yUp
```
protected boolean yUp
```
  - NO_COMPRESSION
```
public static final byte NO_COMPRESSION
```
    Do not compress the images
    
    See Also:
    
    Constant Field Values
  - GZIP_COMPRESSION
```
public static final byte GZIP_COMPRESSION
```
    Use GZIP to compress images. GZIP decompression is very slow
    
    See Also:
    
    Constant Field Values
  - JPEG_COMPRESSION
```
public static final byte JPEG_COMPRESSION
```
    Use JPEG compression for images JPEG compression is currently the default. The file format supports other compression algorithms but there is currently no API to select the algorithm. This feature is on hold pending imageio in Java 1.4
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ImageComponentState
```
public ImageComponentState(SymbolTableData symbol,
                           Controller control)
```
- Method Detail
  - writeConstructorParams
```
protected void writeConstructorParams(DataOutput out)
                               throws IOException
```
    Description copied from class: SceneGraphObjectState
    
    Write the parameters required for the constructor of the Java3D object
    
    Overrides:
    
    writeConstructorParams in class SceneGraphObjectState
    
    Throws:
    
    IOException
  - readConstructorParams
```
protected void readConstructorParams(DataInput in)
                              throws IOException
```
    Description copied from class: SceneGraphObjectState
    
    Read the parameters required for the constructor of the Java3D object
    
    Overrides:
    
    readConstructorParams in class SceneGraphObjectState
    
    Throws:
    
    IOException
  - writeBufferedImage
```
protected void writeBufferedImage(DataOutput out,
                                  BufferedImage image)
                           throws IOException
```
    Throws:
    
    IOException
  - readBufferedImage
```
protected BufferedImage readBufferedImage(DataInput in)
                                   throws IOException
```
    Throws:
    
    IOException

Class ImageComponentState

Field Summary

Fields inherited from class org.scijava.java3d.utils.scenegraph.io.state.org.scijava.java3d.SceneGraphObjectState

Constructor Summary

Method Summary

Methods inherited from class org.scijava.java3d.utils.scenegraph.io.state.org.scijava.java3d.NodeComponentState

Methods inherited from class org.scijava.java3d.utils.scenegraph.io.state.org.scijava.java3d.SceneGraphObjectState

Methods inherited from class java.lang.Object

Field Detail

format

height

width

byReference

yUp

NO_COMPRESSION

GZIP_COMPRESSION

JPEG_COMPRESSION

Constructor Detail

ImageComponentState

Method Detail

writeConstructorParams

readConstructorParams

writeBufferedImage

readBufferedImage