| java.lang.Object
 com.sun.j3d.utils.scenegraph.io.SceneGraphFileWriter
| SceneGraphFileWriter | | public class SceneGraphFileWriter extends java.lang.Object (Code) | | Write a (set) of Java3D BranchGraphs and/or Universe to a file. The BranchGraphs
are stored in the order in which they are written, they can be read in any order
using SceneGraphFileReader.
The API handles Nodes and NodeComponents that are shared between seperate
graphs. It will handle all Java3D 1.3 core classes and any user
subclass of a Node or NodeComponent that implements the SceneGraphIO
interface.
|
| Method Summary | |
| public void | addObjectName(String name, SceneGraphObject object)
Add a named reference to a SceneGraphObject in the file.
object must have been written to the file before this method is
called. | | public void | close()
Close the file and cleanup internal data structures. | | public void | writeBranchGraph(BranchGroup graph)
Write the graph to the end of the file.
close() MUST be called when IO is complete. | | public void | writeBranchGraph(BranchGroup graph, java.io.Serializable data)
Write a branch graph and some user associated data to the
end of the file.
close() MUST be called when IO is complete. |
| SceneGraphFileWriter | | public SceneGraphFileWriter(java.io.File file, SimpleUniverse universe, boolean writeUniverseContent, String fileDescription, java.io.Serializable fileUserData) throws IOException, UnsupportedUniverseException(Code) | | Creates new SceneGraphFileWriter and opens the file for writing.
Writes the
Java3D Universe structure to the file. This includes the number and position of
the Locales, PlatformGeometry, ViewerAvatar, and the MultitransformGroup between
the ViewingPlatform and the View. However this
call does not write the content of the branch graphs unless writeUniverseContent is true.
universe may be null.
This call will overwrite any existing universe, fileDescription and
userData in the file.
close() MUST be called when IO is complete. If close() is not called
the file contents will be undefined.
Parameters:
file - The file to write the data to
Parameters:
universe - The SimpleUniverse to write
Parameters:
writeUniverseContent - If true, the content of the Locales will be written.Otherwise just the universe configuration data will be written.
Parameters:
fileDescription - A description of the file's content
Parameters:
fileUserData - User defined object
exception:
IOException - Thrown if there are any IO errors
exception:
UnsupportedUniverseException - Thrown if universe is nota supported universe class. Currently SimpleUniverse and ConfiguredUniverseare supported. |
| addObjectName | | public void addObjectName(String name, SceneGraphObject object) throws NamedObjectException(Code) | | Add a named reference to a SceneGraphObject in the file.
object must have been written to the file before this method is
called. If the object is not in the file a NamedObjectException will be thrown.
Adding duplicate names will result in the old name being overwritten.
Different names can reference the same object
|
| close | | public void close() throws IOException(Code) | | Close the file and cleanup internal data structures.
|
| writeBranchGraph | | public void writeBranchGraph(BranchGroup graph) throws IOException(Code) | | Write the graph to the end of the file.
close() MUST be called when IO is complete. If close() is not called
the file contents will be undefined.
|
| writeBranchGraph | | public void writeBranchGraph(BranchGroup graph, java.io.Serializable data) throws IOException(Code) | | Write a branch graph and some user associated data to the
end of the file.
close() MUST be called when IO is complete. If close() is not called
the file contents will be undefined.
|
|
|