StreamControl (Java 3D Javadocs 0-SNAPSHOT API)

java.lang.Object
- org.scijava.java3d.utils.scenegraph.io.retained.Controller
- - org.scijava.java3d.utils.scenegraph.io.retained.StreamControl

```
public class StreamControl
extends Controller
```
Provides the infrastructure for ScenGraphStream Reader and Writer

Field Summary

Fields
Modifier and Type Field and Description

protected String FILE_IDENT
- Fields inherited from class org.scijava.java3d.utils.scenegraph.io.retained.Controller
  BG_DIR_PTR, BRANCH_GRAPH_COUNT, classLoader, currentFileVersion, FILE_DESCRIPTION, NAMES_OBJECTS_TABLE_PTR, NODE_TYPES_PTR, nullObject, outputFileVersion, SYMBOL_TABLE_PTR, symbolTable, UNIVERSE_CONFIG_PTR

Fields
Modifier and Type	Field and Description
`protected String`	`FILE_IDENT`

Constructor Summary

Constructors
Constructor and Description

StreamControl(DataInputStream in)

StreamControl(DataOutputStream out)

Constructors
Constructor and Description
`StreamControl(DataInputStream in)`
`StreamControl(DataOutputStream out)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addNamedObjects(HashMap namedObjects)` Add the named objects to the symbol table
`void`	`close()`
`long`	`getFilePointer()` Implementation of abstract method from Controller.
`void`	`loadNodeComponent(SymbolTableData symbol)` Used by SymbolTable to load a node component that is not in current graph
`BranchGroup`	`readBranchGraph(HashMap namedObjects)`
`protected void`	`readBranchGraphs(int[] graphs)` Read the set of branchgraps.
`void`	`readStreamHeader()`
`void`	`writeBranchGraph(BranchGroup bg, Serializable userData)` The BranchGraph userData is not supported in a stream and will be ignored.
`void`	`writeStreamHeader()` Prepare the Stream for writing, by sending header information

Methods inherited from class org.scijava.java3d.utils.scenegraph.io.retained.Controller
addNamedObject, createState, createState, createState, getClassLoader, getCurrentFileVersion, getImageCompression, getNamedObject, getNames, getNodeClassFromID, getNodeClassID, getOutputFileVersion, getSymbolTable, readBounds, readColor3f, readColor4f, readMatrix4d, readNodeComponents, readObject, readPoint3d, readPoint3f, readQuat4f, readSerializedData, readSharedGroup, readTransform3D, readTuple3d, readTuple3f, readTuple4d, readTuple4f, readUniverse, readVector3f, readVector4d, readVector4f, reset, setClassLoader, skipUserData, useSuperClassIfNoChildClass, writeBounds, writeColor3f, writeColor4f, writeMatrix4d, writeNodeComponents, writeObject, writePoint3d, writePoint3f, writeQuat4f, writeSerializedData, writeSharedGroup, writeTransform3D, writeTuple3d, writeTuple3f, writeTuple4d, writeTuple4f, writeUniverse, writeVector3f, writeVector4d, writeVector4f

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

- Field Detail
  - FILE_IDENT
```
protected String FILE_IDENT
```
- Constructor Detail
  - StreamControl
```
public StreamControl(DataOutputStream out)
```
  - StreamControl
```
public StreamControl(DataInputStream in)
```
- Method Detail
  - writeStreamHeader
```
public void writeStreamHeader()
                       throws IOException
```
    Prepare the Stream for writing, by sending header information
    
    Throws:
    
    IOException
  - readStreamHeader
```
public void readStreamHeader()
                      throws IOException
```
    Throws:
    
    IOException
  - addNamedObjects
```
public void addNamedObjects(HashMap namedObjects)
```
    Add the named objects to the symbol table
  - writeBranchGraph
```
public void writeBranchGraph(BranchGroup bg,
                             Serializable userData)
                      throws IOException
```
    The BranchGraph userData is not supported in a stream and will be ignored. However the data in the userData field of the BranchGroup will be stored in the stream
    
    Specified by:
    
    writeBranchGraph in class Controller
    
    Throws:
    
    IOException
  - readBranchGraph
```
public BranchGroup readBranchGraph(HashMap namedObjects)
                            throws IOException
```
    Throws:
    
    IOException
  - readBranchGraphs
```
protected void readBranchGraphs(int[] graphs)
                         throws IOException
```
    Read the set of branchgraps. Used by readUniverse RandomAccessFileControl will read the graphs in the array, StreamControl expects the graphs to follow the universe in the stream so it will read graphs.length branchgraphs.
    
    Specified by:
    
    readBranchGraphs in class Controller
    
    Throws:
    
    IOException
  - loadNodeComponent
```
public void loadNodeComponent(SymbolTableData symbol)
                       throws IOException
```
    Used by SymbolTable to load a node component that is not in current graph
    
    Throws:
    
    IOException
  - close
```
public void close()
           throws IOException
```
    Specified by:
    
    close in class Controller
    
    Throws:
    
    IOException
  - getFilePointer
```
public long getFilePointer()
```
    Implementation of abstract method from Controller. Always returns 0
    
    Specified by:
    
    getFilePointer in class Controller

Class StreamControl

Field Summary

Fields inherited from class org.scijava.java3d.utils.scenegraph.io.retained.Controller

Constructor Summary

Method Summary

Methods inherited from class org.scijava.java3d.utils.scenegraph.io.retained.Controller

Methods inherited from class java.lang.Object

Field Detail

FILE_IDENT

Constructor Detail

StreamControl

StreamControl

Method Detail

writeStreamHeader

readStreamHeader

addNamedObjects

writeBranchGraph

readBranchGraph

readBranchGraphs

loadNodeComponent

close

getFilePointer