Class SceneGraphFileWriter

java.lang.Object
com.sun.j3d.utils.scenegraph.io.SceneGraphFileWriter

public class SceneGraphFileWriter extends Object
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.
  • Constructor Details

    • SceneGraphFileWriter

      public SceneGraphFileWriter(File file, SimpleUniverse universe, boolean writeUniverseContent, String fileDescription, Serializable fileUserData) throws IOException, UnsupportedUniverseException
      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
      universe - The SimpleUniverse to write
      writeUniverseContent - If true, the content of the Locales will be written. Otherwise just the universe configuration data will be written.
      fileDescription - A description of the file's content
      fileUserData - User defined object
      Throws:
      IOException - Thrown if there are any IO errors
      UnsupportedUniverseException - Thrown if universe is not a supported universe class. Currently SimpleUniverse and ConfiguredUniverse are supported.
  • Method Details

    • writeBranchGraph

      public void writeBranchGraph(BranchGroup graph) throws IOException
      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.
      Throws:
      IOException
    • writeBranchGraph

      public void writeBranchGraph(BranchGroup graph, Serializable data) throws IOException
      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.
      Throws:
      IOException
    • addObjectName

      public void addObjectName(String name, SceneGraphObject object) throws NamedObjectException
      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
      Throws:
      NamedObjectException
    • close

      public void close() throws IOException
      Close the file and cleanup internal data structures.
      Throws:
      IOException