Package com.sun.j3d.utils.scenegraph.io
Class SceneGraphFileReader
java.lang.Object
com.sun.j3d.utils.scenegraph.io.SceneGraphFileReader
Read Java3D BranchGraphs and/or Universe from a file. Individual branchgraphs or an
entire Universe can be read and references (shared nodes and components)
between the graphs are handled correctly.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Close the file and cleanup internal data structuresvoid
Remove the IO system's reference to this branchgraph and all its nodes.int
Return the number of BranchGraphs in the fileint
Given a BranchGraph that has been loaded return the index of the graph in the file.Get the ClassLoader used to load the scene graph objects and deserialize user datagetNamedObject
(String name) Return the named object.String[]
getNames()
Return the names of all the named objectsRead and return all the branchgraphs in the filereadBranchGraph
(int index) Read the BranchGraph at index in the file.readBranchGraphUserData
(int index) Read the userdata for the branchgraph at 'index' in the fileGet the Description of this file's contentsreadUniverse
(boolean attachBranchGraphs) Create and return a ConfiguredUniverse with the PlatformGeometry, ViewerAvatar, and Locales saved in the file.readUniverse
(boolean attachBranchGraphs, Canvas3D canvas) Create and return a ConfiguredUniverse with the PlatformGeometry, ViewerAvatar, and Locales saved in the file.Get the UserData in the File headervoid
setClassLoader
(ClassLoader classLoader) Set the ClassLoader used to load the scene graph objects and deserialize user data
-
Constructor Details
-
SceneGraphFileReader
Creates new SceneGraphFileReader.- Throws:
IOException
-
-
Method Details
-
readUniverse
Create and return a ConfiguredUniverse with the PlatformGeometry, ViewerAvatar, and Locales saved in the file. The MultiTransformGroup between the ViewingPlatform and the View is also restored. Universe configuration information is retrieved viaConfiguredUniverse.getConfigURL()
.If the file does not contain universe information, null is returned.
- Parameters:
attachBranchGraphs
- load and attach all the branchgraphs to the universe.- Throws:
IOException
- See Also:
-
setClassLoader
Set the ClassLoader used to load the scene graph objects and deserialize user data -
getClassLoader
Get the ClassLoader used to load the scene graph objects and deserialize user data -
readUniverse
public ConfiguredUniverse readUniverse(boolean attachBranchGraphs, Canvas3D canvas) throws IOException Create and return a ConfiguredUniverse with the PlatformGeometry, ViewerAvatar, and Locales saved in the file. The MultiTransformGroup between the ViewingPlatform and the View is also restored.If the file does not contain universe information, null is returned.
- Parameters:
attachBranchGraphs
- load and attach all the branchgraphs to the universe.canvas
- The canvas to be associated with the Universe.- Throws:
IOException
-
readUserData
Get the UserData in the File header- Throws:
IOException
-
readDescription
Get the Description of this file's contents- Throws:
IOException
-
getBranchGraphCount
public int getBranchGraphCount()Return the number of BranchGraphs in the file -
readBranchGraph
Read the BranchGraph at index in the file. If the graph contains references to nodes in other BranchGraphs that have not already been loaded, they will also be loaded and returned.The requested graph will always be the first element in the array.
The file index of all the Graphs can be discovered using
getBranchGraphPosition
.- Parameters:
index
- The index of the Graph in the file. First graph is at index 0- Throws:
IOException
- See Also:
-
readAllBranchGraphs
Read and return all the branchgraphs in the file- Throws:
IOException
-
dereferenceBranchGraph
Remove the IO system's reference to this branchgraph and all its nodes.References to all loaded graphs are maintained by the IO system in order to facilitate node and component sharing between the graphs.
This call removes the references to graph
index
NOT CURRENTLY IMPLEMENTED
-
getBranchGraphPosition
Given a BranchGraph that has been loaded return the index of the graph in the file. The the Branchgroup isn't found, -1 is returned. -
readBranchGraphUserData
Read the userdata for the branchgraph at 'index' in the file- Parameters:
index
- the index of the graph in the file- Throws:
IOException
-
getNames
Return the names of all the named objects -
getNamedObject
public SceneGraphObject getNamedObject(String name) throws NamedObjectException, ObjectNotLoadedException Return the named object.- Parameters:
name
- The name of the object- Throws:
NamedObjectException
- is thrown if the name is not known to the systemObjectNotLoadedException
- is thrown if the named object has not been loaded yet
-
close
Close the file and cleanup internal data structures- Throws:
IOException
-