Controller (Java 3D Javadocs 0-SNAPSHOT API)

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

Direct Known Subclasses:

RandomAccessFileControl, StreamControl
```
public abstract class Controller
extends Object
```
Provides code to control the reading and writing of Java3D objects to and from any Java IO mechanism.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static long`	`BG_DIR_PTR`
`protected static long`	`BRANCH_GRAPH_COUNT`
`protected ClassLoader`	`classLoader` When running the application within webstart this may not be the correct ClassLoader.
`protected int`	`currentFileVersion` The currentFileVersion being read
`protected static long`	`FILE_DESCRIPTION`
`protected static long`	`NAMES_OBJECTS_TABLE_PTR`
`protected static long`	`NODE_TYPES_PTR`
`protected NullSceneGraphObjectState`	`nullObject`
`protected int`	`outputFileVersion` The File version which will be written 1 = Java3D 1.3 beta 1 2 = Java3D 1.3 FCS, 1) fix to allow skipping user data written via SceneGraphIO interface 2) Add missing duplicateOnCloneTree flag (bug 4690159) 3 = Java3D 1.5.1 1) Add support for SceneGraphObject Name field 4 = Java3D 1.5.2 issue 532, for saving Background Geometry 5 = Java3D 1.5.2+ issue 654, for saving required SpotLight attributes
`protected static long`	`SYMBOL_TABLE_PTR`
`protected SymbolTable`	`symbolTable`
`protected static long`	`UNIVERSE_CONFIG_PTR`

Constructor Summary

Constructors
Constructor and Description

Controller()
Creates new Controller

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

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addNamedObject(String name, SceneGraphObject object)` Associate the name with the scene graph object
`abstract void`	`close()`
`SceneGraphObjectState`	`createState(SceneGraphObject obj)` Create a new state object and check for a pre-existing symbol table entry
`SceneGraphObjectState`	`createState(SceneGraphObject obj, SymbolTableData symbol)` Given a scene graph object instantiate the correct State class for that object.
`SceneGraphObjectState`	`createState(SymbolTableData symbol)` Return the state class for the SceneGraphObject, creating one if it does not already exist
`ClassLoader`	`getClassLoader()` Get the class loader used to load the Scene Graph Objects and the serialized user data.
`int`	`getCurrentFileVersion()` Get the file version of the file we are reading
`abstract long`	`getFilePointer()` Get the current file 'pointer' location.
`int`	`getImageCompression()` Returns the imageCompression to be used IMAGE_COMPRESSION_NONE, IMAGE_COMPRESSION_GZIP, IMAGE_COMPRESSION_JPEG
`SceneGraphObject`	`getNamedObject(String name)` Return the SceneGraphObject associated with the name
`String[]`	`getNames()` Get all the names of the named objects
`Class`	`getNodeClassFromID(int classID)`
`int`	`getNodeClassID(SceneGraphObject node)`
`int`	`getOutputFileVersion()` Get the file version that we should write
`SymbolTable`	`getSymbolTable()`
`Bounds`	`readBounds(DataInput in)`
`protected abstract void`	`readBranchGraphs(int[] graphs)` Read the set of branchgraps.
`Color3f`	`readColor3f(DataInput in)`
`Color4f`	`readColor4f(DataInput in)`
`Matrix4d`	`readMatrix4d(DataInput in)`
`protected void`	`readNodeComponents(DataInput in)` Read in all the node components in this block
`SceneGraphObjectState`	`readObject(DataInput in)`
`Point3d`	`readPoint3d(DataInput in)`
`Point3f`	`readPoint3f(DataInput in)`
`Quat4f`	`readQuat4f(DataInput in)`
`Object`	`readSerializedData(DataInput dataInput)`
`int`	`readSharedGroup(DataInput in)` Read a Shared group and it's node components from the IO Stream
`Transform3D`	`readTransform3D(DataInput in)`
`Tuple3d`	`readTuple3d(DataInput in, Tuple3d tuple)`
`Tuple3f`	`readTuple3f(DataInput in, Tuple3f tuple)`
`Tuple4d`	`readTuple4d(DataInput in, Tuple4d tuple)`
`Tuple4f`	`readTuple4f(DataInput in, Tuple4f tuple)`
`ConfiguredUniverse`	`readUniverse(DataInput in, boolean attachBranchGraphs, Canvas3D canvas)` Read and create a new Universe matching the one used during save.
`Vector3f`	`readVector3f(DataInput in)`
`Vector4d`	`readVector4d(DataInput in)`
`Vector4f`	`readVector4f(DataInput in)`
`void`	`reset()` Reset the controller, ready to load/save data to a new file
`void`	`setClassLoader(ClassLoader classLoader)` Set the class loader used to load the Scene Graph Objects and the serialized user data.
`void`	`skipUserData(DataInput dataInput)` Skip past the user data object
`boolean`	`useSuperClassIfNoChildClass()` Indicates to SceneGraphObjectState that it should use the Java3D core superclass for any tree nodes whose classes are not in the classpath during a load.
`void`	`writeBounds(DataOutput out, Bounds bounds)`
`abstract void`	`writeBranchGraph(BranchGroup bg, Serializable userData)`
`void`	`writeColor3f(DataOutput out, Color3f color)`
`void`	`writeColor4f(DataOutput out, Color4f vec)`
`void`	`writeMatrix4d(DataOutput out, Matrix4d m)`
`protected void`	`writeNodeComponents(DataOutput out)` Write all the unsaved NodeComponents and SharedGroups to DataOutput.
`void`	`writeObject(DataOutput out, SceneGraphObjectState obj)`
`void`	`writePoint3d(DataOutput out, Point3d pt)`
`void`	`writePoint3f(DataOutput out, Point3f pt)`
`void`	`writeQuat4f(DataOutput out, Quat4f vec)`
`void`	`writeSerializedData(DataOutput dataOutput, Serializable userData)` Write a serializable object to the current file position, proceeded by the size of the object
`void`	`writeSharedGroup(DataOutput out, SharedGroup sharedGroup, SymbolTableData symbol)` Write the shared group and it's node components to the IO stream
`void`	`writeTransform3D(DataOutput out, Transform3D tran)`
`void`	`writeTuple3d(DataOutput out, Tuple3d tuple)`
`void`	`writeTuple3f(DataOutput out, Tuple3f tuple)`
`void`	`writeTuple4d(DataOutput out, Tuple4d tuple)`
`void`	`writeTuple4f(DataOutput out, Tuple4f tuple)`
`void`	`writeUniverse(DataOutput out, SimpleUniverse universe, boolean writeUniverseContent)` Write out the Universe information.
`void`	`writeVector3f(DataOutput out, Vector3f vec)`
`void`	`writeVector4d(DataOutput out, Vector4d vec)`
`void`	`writeVector4f(DataOutput out, Vector4f vec)`

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

Field Detail
- SYMBOL_TABLE_PTR
```
protected static final long SYMBOL_TABLE_PTR
```
  See Also:
  
  Constant Field Values
- BG_DIR_PTR
```
protected static final long BG_DIR_PTR
```
  See Also:
  
  Constant Field Values
- NAMES_OBJECTS_TABLE_PTR
```
protected static final long NAMES_OBJECTS_TABLE_PTR
```
  See Also:
  
  Constant Field Values
- NODE_TYPES_PTR
```
protected static final long NODE_TYPES_PTR
```
  See Also:
  
  Constant Field Values
- UNIVERSE_CONFIG_PTR
```
protected static final long UNIVERSE_CONFIG_PTR
```
  See Also:
  
  Constant Field Values
- BRANCH_GRAPH_COUNT
```
protected static final long BRANCH_GRAPH_COUNT
```
  See Also:
  
  Constant Field Values
- FILE_DESCRIPTION
```
protected static final long FILE_DESCRIPTION
```
  See Also:
  
  Constant Field Values
- symbolTable
```
protected SymbolTable symbolTable
```
- nullObject
```
protected NullSceneGraphObjectState nullObject
```
- currentFileVersion
```
protected int currentFileVersion
```
  The currentFileVersion being read
- outputFileVersion
```
protected int outputFileVersion
```
  The File version which will be written 1 = Java3D 1.3 beta 1 2 = Java3D 1.3 FCS, 1) fix to allow skipping user data written via SceneGraphIO interface 2) Add missing duplicateOnCloneTree flag (bug 4690159) 3 = Java3D 1.5.1 1) Add support for SceneGraphObject Name field 4 = Java3D 1.5.2 issue 532, for saving Background Geometry 5 = Java3D 1.5.2+ issue 654, for saving required SpotLight attributes
- classLoader
```
protected ClassLoader classLoader
```
  When running the application within webstart this may not be the correct ClassLoader. If Java 3D is not installed in the local vm and is instead installed by webstart then this definitely is NOT the correct classloader, in this case Thread.getCurrent().getClass().getClassLoader() would probably be a good default. The user can also set their preferred classloader by calling setClassLoader in SceneGraph[Stream|File]Reader.

Constructor Detail
- Controller
```
public Controller()
```
  Creates new Controller

Method Detail

getSymbolTable

public final SymbolTable getSymbolTable()

getOutputFileVersion
```
public int getOutputFileVersion()
```
Get the file version that we should write

getCurrentFileVersion
```
public int getCurrentFileVersion()
```
Get the file version of the file we are reading

createState
```
public SceneGraphObjectState createState(SceneGraphObject obj)
```
Create a new state object and check for a pre-existing symbol table entry

createState
```
public SceneGraphObjectState createState(SceneGraphObject obj,
                                         SymbolTableData symbol)
```
Given a scene graph object instantiate the correct State class for that object. If the symbol already exists (is not null) then increment the reference count, otherwise create a new symbol.

createState
```
public SceneGraphObjectState createState(SymbolTableData symbol)
```
Return the state class for the SceneGraphObject, creating one if it does not already exist

writeObject

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

Throws:: IOException

readObject

public SceneGraphObjectState readObject(DataInput in)
                                 throws IOException

Throws:: IOException

setClassLoader
```
public void setClassLoader(ClassLoader classLoader)
```
Set the class loader used to load the Scene Graph Objects and the serialized user data. The default is ClassLoader.getSystemClassLoader()

getClassLoader
```
public ClassLoader getClassLoader()
```
Get the class loader used to load the Scene Graph Objects and the serialized user data. The default is ClassLoader.getSystemClassLoader()

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

Throws:

IOException

readNodeComponents

protected void readNodeComponents(DataInput in)
                           throws IOException

Read in all the node components in this block

Throws:: IOException

writeSharedGroup

public void writeSharedGroup(DataOutput out,
                             SharedGroup sharedGroup,
                             SymbolTableData symbol)
                      throws IOException

Write the shared group and it's node components to the IO stream

Throws:: IOException

readSharedGroup
```
public int readSharedGroup(DataInput in)
                    throws IOException
```
Read a Shared group and it's node components from the IO Stream

Throws:

IOException

writeUniverse

public void writeUniverse(DataOutput out,
                          SimpleUniverse universe,
                          boolean writeUniverseContent)
                   throws IOException,
                          UnsupportedUniverseException,
                          CapabilityNotSetException

Write out the Universe information.

Throws:: IOException; UnsupportedUniverseException; CapabilityNotSetException

readUniverse

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

Read and create a new Universe matching the one used during save.

Parameters:: attachBranchGraphs - If true then all the branchGraph attached to the universe when it was saved will be loaded and reattached.
Throws:: IOException

readBranchGraphs
```
protected abstract 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

Throws:

IOException

writeBranchGraph

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

Throws:: IOException

reset
```
public void reset()
```
Reset the controller, ready to load/save data to a new file

getNodeClassFromID

public Class getNodeClassFromID(int classID)

getNodeClassID

public int getNodeClassID(SceneGraphObject node)

addNamedObject

public void addNamedObject(String name,
                           SceneGraphObject object)

Associate the name with the scene graph object

getNamedObject

public SceneGraphObject getNamedObject(String name)
                                throws NamedObjectException,
                                       ObjectNotLoadedException

Return the SceneGraphObject associated with the name

Throws:: NamedObjectException; ObjectNotLoadedException

getNames
```
public String[] getNames()
```
Get all the names of the named objects

writeSerializedData

public void writeSerializedData(DataOutput dataOutput,
                                Serializable userData)
                         throws IOException

Write a serializable object to the current file position, proceeded by the size of the object

Throws:: IOException

readSerializedData

public Object readSerializedData(DataInput dataInput)
                          throws IOException

Throws:: IOException

skipUserData

public void skipUserData(DataInput dataInput)
                  throws IOException

Skip past the user data object

Throws:: IOException

writeColor3f

public void writeColor3f(DataOutput out,
                         Color3f color)
                  throws IOException

Throws:: IOException

readColor3f

public Color3f readColor3f(DataInput in)
                    throws IOException

Throws:: IOException

writeColor4f

public void writeColor4f(DataOutput out,
                         Color4f vec)
                  throws IOException

Throws:: IOException

readColor4f

public Color4f readColor4f(DataInput in)
                    throws IOException

Throws:: IOException

writePoint3f

public void writePoint3f(DataOutput out,
                         Point3f pt)
                  throws IOException

Throws:: IOException

readPoint3f

public Point3f readPoint3f(DataInput in)
                    throws IOException

Throws:: IOException

writePoint3d

public void writePoint3d(DataOutput out,
                         Point3d pt)
                  throws IOException

Throws:: IOException

readPoint3d

public Point3d readPoint3d(DataInput in)
                    throws IOException

Throws:: IOException

writeVector3f

public void writeVector3f(DataOutput out,
                          Vector3f vec)
                   throws IOException

Throws:: IOException

readVector3f

public Vector3f readVector3f(DataInput in)
                      throws IOException

Throws:: IOException

writeVector4d

public void writeVector4d(DataOutput out,
                          Vector4d vec)
                   throws IOException

Throws:: IOException

readVector4d

public Vector4d readVector4d(DataInput in)
                      throws IOException

Throws:: IOException

writeVector4f

public void writeVector4f(DataOutput out,
                          Vector4f vec)
                   throws IOException

Throws:: IOException

readVector4f

public Vector4f readVector4f(DataInput in)
                      throws IOException

Throws:: IOException

writeQuat4f

public void writeQuat4f(DataOutput out,
                        Quat4f vec)
                 throws IOException

Throws:: IOException

readQuat4f

public Quat4f readQuat4f(DataInput in)
                  throws IOException

Throws:: IOException

writeMatrix4d

public void writeMatrix4d(DataOutput out,
                          Matrix4d m)
                   throws IOException

Throws:: IOException

readMatrix4d

public Matrix4d readMatrix4d(DataInput in)
                      throws IOException

Throws:: IOException

writeTuple3f

public void writeTuple3f(DataOutput out,
                         Tuple3f tuple)
                  throws IOException

Throws:: IOException

readTuple3f

public Tuple3f readTuple3f(DataInput in,
                           Tuple3f tuple)
                    throws IOException

Throws:: IOException

writeTuple3d

public void writeTuple3d(DataOutput out,
                         Tuple3d tuple)
                  throws IOException

Throws:: IOException

readTuple3d

public Tuple3d readTuple3d(DataInput in,
                           Tuple3d tuple)
                    throws IOException

Throws:: IOException

writeTuple4d

public void writeTuple4d(DataOutput out,
                         Tuple4d tuple)
                  throws IOException

Throws:: IOException

readTuple4d

public Tuple4d readTuple4d(DataInput in,
                           Tuple4d tuple)
                    throws IOException

Throws:: IOException

writeTuple4f

public void writeTuple4f(DataOutput out,
                         Tuple4f tuple)
                  throws IOException

Throws:: IOException

readTuple4f

public Tuple4f readTuple4f(DataInput in,
                           Tuple4f tuple)
                    throws IOException

Throws:: IOException

writeTransform3D

public void writeTransform3D(DataOutput out,
                             Transform3D tran)
                      throws IOException

Throws:: IOException

readTransform3D

public Transform3D readTransform3D(DataInput in)
                            throws IOException

Throws:: IOException

writeBounds

public void writeBounds(DataOutput out,
                        Bounds bounds)
                 throws IOException

Throws:: IOException

readBounds

public Bounds readBounds(DataInput in)
                  throws IOException

Throws:: IOException

getFilePointer
```
public abstract long getFilePointer()
```
Get the current file 'pointer' location.

close

public abstract void close()
                    throws IOException

Throws:: IOException

useSuperClassIfNoChildClass
```
public boolean useSuperClassIfNoChildClass()
```
Indicates to SceneGraphObjectState that it should use the Java3D core superclass for any tree nodes whose classes are not in the classpath during a load.

getImageCompression
```
public int getImageCompression()
```
Returns the imageCompression to be used IMAGE_COMPRESSION_NONE, IMAGE_COMPRESSION_GZIP, IMAGE_COMPRESSION_JPEG

Class Controller

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SYMBOL_TABLE_PTR

BG_DIR_PTR

NAMES_OBJECTS_TABLE_PTR

NODE_TYPES_PTR

UNIVERSE_CONFIG_PTR

BRANCH_GRAPH_COUNT

FILE_DESCRIPTION

symbolTable

nullObject

currentFileVersion

outputFileVersion

classLoader

Constructor Detail

Controller

Method Detail

getSymbolTable

getOutputFileVersion

getCurrentFileVersion

createState

createState

createState

writeObject

readObject

setClassLoader

getClassLoader

writeNodeComponents

readNodeComponents

writeSharedGroup

readSharedGroup

writeUniverse

readUniverse

readBranchGraphs

writeBranchGraph

reset

getNodeClassFromID

getNodeClassID

addNamedObject

getNamedObject

getNames

writeSerializedData

readSerializedData

skipUserData

writeColor3f

readColor3f

writeColor4f

readColor4f

writePoint3f

readPoint3f

writePoint3d

readPoint3d

writeVector3f

readVector3f

writeVector4d

readVector4d

writeVector4f

readVector4f

writeQuat4f

readQuat4f

writeMatrix4d

readMatrix4d

writeTuple3f

readTuple3f

writeTuple3d

readTuple3d

writeTuple4d

readTuple4d

writeTuple4f

readTuple4f

writeTransform3D

readTransform3D

writeBounds

readBounds

getFilePointer

close