RandomAccessFileControl (Java 3D Javadocs 0-SNAPSHOT API)

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

public class RandomAccessFileControl
extends Controller

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

RandomAccessFileControl()
Creates new RandomAccessFileControl

Constructors
Constructor and Description
`RandomAccessFileControl()` Creates new RandomAccessFileControl

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`void`	`createFile(File file, SimpleUniverse universe, boolean writeUniverseContent, String description, Serializable userData)` Create the file and write the inital header information
`int`	`getBranchGraphCount()` Return the number of branchgraphs in the file
`int`	`getBranchGraphPosition(BranchGroup graph)` Given a branchgraph, return the corresponding index of the graph in the file.
`long`	`getFilePointer()` Get the current file 'pointer' location.
`Object`	`getUserData()`
`void`	`loadNodeComponent(SymbolTableData symbol)` Used by SymbolTable to load a node component that is not in current graph
`void`	`loadSharedGroup(SymbolTableData symbol)` Loads the specified SharedGroup
`void`	`openFile(File file)` Open the file for reading
`BranchGroup[]`	`readAllBranchGraphs()` Read and return all the graphs in the file
`BranchGroup[]`	`readBranchGraph(int graphID)`
`protected void`	`readBranchGraphs(int[] graphs)` Read the set of branchgraps.
`Object`	`readBranchGraphUserData(int graphID)`
`String`	`readFileDescription()`
`protected void`	`readNodeComponents(DataInput in)` Read in all the node components in this block
`ConfiguredUniverse`	`readUniverse(boolean attachBranchGraphs, Canvas3D canvas)`
`void`	`writeBranchGraph(BranchGroup bg, Serializable userData)`
`protected void`	`writeNodeComponents(DataOutput out)` Write all the unsaved NodeComponents and SharedGroups to DataOutput.
`void`	`writeObject(DataOutput out, SceneGraphObjectState obj)`

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, readObject, readPoint3d, readPoint3f, readQuat4f, readSerializedData, readSharedGroup, readTransform3D, readTuple3d, readTuple3f, readTuple4d, readTuple4f, readUniverse, readVector3f, readVector4d, readVector4f, reset, setClassLoader, skipUserData, useSuperClassIfNoChildClass, writeBounds, writeColor3f, writeColor4f, writeMatrix4d, 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
- RandomAccessFileControl
```
public RandomAccessFileControl()
```
  Creates new RandomAccessFileControl

Method Detail

createFile

public void createFile(File file,
                       SimpleUniverse universe,
                       boolean writeUniverseContent,
                       String description,
                       Serializable userData)
                throws IOException,
                       UnsupportedUniverseException,
                       CapabilityNotSetException

Create the file and write the inital header information

Throws:: IOException; UnsupportedUniverseException; CapabilityNotSetException

openFile

public void openFile(File file)
              throws IOException

Open the file for reading

Throws:: IOException

readUniverse

public ConfiguredUniverse readUniverse(boolean attachBranchGraphs,
                                       Canvas3D canvas)
                                throws IOException

Throws:: IOException

getUserData
```
public Object getUserData()
```

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 will read all graphs in the stream

Specified by:

readBranchGraphs in class Controller

Throws:

IOException

getBranchGraphCount
```
public int getBranchGraphCount()
```
Return the number of branchgraphs in the file

writeBranchGraph

public void writeBranchGraph(BranchGroup bg,
                             Serializable userData)
                      throws IOException

Specified by:: writeBranchGraph in class Controller
Throws:: IOException

readBranchGraph

public BranchGroup[] readBranchGraph(int graphID)
                              throws IOException

Throws:: IOException

readAllBranchGraphs

public BranchGroup[] readAllBranchGraphs()
                                  throws IOException

Read and return all the graphs in the file

Throws:: IOException

readBranchGraphUserData

public Object readBranchGraphUserData(int graphID)
                               throws IOException

Throws:: IOException

writeNodeComponents
```
protected void writeNodeComponents(DataOutput out)
                            throws IOException
```
Write all the unsaved NodeComponents and SharedGroups to DataOutput. Mark all the NodeComponents as saved.

Overrides:

writeNodeComponents in class Controller

Throws:

IOException

readNodeComponents
```
protected void readNodeComponents(DataInput in)
                           throws IOException
```
Read in all the node components in this block

Overrides:

readNodeComponents in class Controller

Throws:

IOException

writeObject

public void writeObject(DataOutput out,
                        SceneGraphObjectState obj)
                 throws IOException

Overrides:: writeObject in class Controller
Throws:: IOException

readFileDescription

public String readFileDescription()
                           throws IOException

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

loadSharedGroup

public void loadSharedGroup(SymbolTableData symbol)
                     throws IOException

Loads the specified SharedGroup

Throws:: IOException

close
```
public void close()
           throws IOException
```
Specified by:

close in class Controller

Throws:

IOException

getFilePointer
```
public long getFilePointer()
```
Description copied from class: Controller

Get the current file 'pointer' location.

Specified by:

getFilePointer in class Controller

getBranchGraphPosition
```
public int getBranchGraphPosition(BranchGroup graph)
```
Given a branchgraph, return the corresponding index of the graph in the file. Returns -1 if graph not found.

Class RandomAccessFileControl

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

RandomAccessFileControl

Method Detail

createFile

openFile

readUniverse

getUserData

readBranchGraphs

getBranchGraphCount

writeBranchGraph

readBranchGraph

readAllBranchGraphs

readBranchGraphUserData

writeNodeComponents

readNodeComponents

writeObject

readFileDescription

loadNodeComponent

loadSharedGroup

close

getFilePointer

getBranchGraphPosition