org.xith3d.io
Class Scribe

java.lang.Object
  org.xith3d.io.Scribe

Direct Known Subclasses:

ScribeGeometryArray

public class Scribe
extends java.lang.Object

Portable reader/writer for all cosm objects. This does not use object serialization for efficiency. This is designed to be fast and portable. Objects which implement Scribable can be written directly to a scribestream :Id: Scribe.java,v 1.7 2003/02/24 00:13:44 wurp Exp $ :Log: Scribe.java,v $ Revision 1.7 2003/02/24 00:13:44 wurp Formatted all java code for cvs (strictSunConvention.xml) Revision 1.6 2002/09/11 00:53:53 dilvish Big commit of new changes Revision 1.5 2002/01/20 05:26:02 dilvish JDK 1.4 port Revision 1.4 2002/01/15 03:36:55 dilvish Improvements to the animation system Revision 1.3 2001/07/14 14:48:10 wurp New animation, sky and avatar movement Revision 1.2 2001/06/20 04:05:41 wurp added log4j. Revision 1.1 2001/06/06 22:42:37 wizofid Massive commit / reintegration

Field Summary

static byte	SCRIBE_EXT
static byte	SCRIBE_GEOMETRY_ARRAY
static boolean	useNIO

Constructor Summary

Scribe()

Method Summary

static SceneGraphObject	read(ScribeInputStream in) Method for reading a scene graph from a stream.
static Scribable	read(java.lang.String filename)
static Geometry	readGeometryFromFile(java.lang.String filename)
static Scribable	readHeader(java.lang.String filename)
static SceneGraphObject	readSceneFromFile(java.lang.String filename) Simple method to read a scene from a compressed file
static void	write(java.lang.String filename, Scribable object)
static void	writeGeometryToFile(java.lang.String filename, Geometry g)
static void	writeSceneToFile(java.lang.String filename, Scribable object) Writes a scene to a compressed file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SCRIBE_GEOMETRY_ARRAY

public static final byte SCRIBE_GEOMETRY_ARRAY

See Also:

Constant Field Values

SCRIBE_EXT

public static final byte SCRIBE_EXT

See Also:

Constant Field Values

useNIO

public static boolean useNIO

Constructor Detail

Scribe

public Scribe()

Method Detail

read

public static SceneGraphObject read(ScribeInputStream in)
                             throws java.io.IOException,
                                    InvalidFormat

Method for reading a scene graph from a stream. Object(s) must have been written by using the scribe method.

Throws:

java.io.IOException

InvalidFormat

writeSceneToFile

public static void writeSceneToFile(java.lang.String filename,
                                    Scribable object)
                             throws java.io.IOException

Writes a scene to a compressed file.

Throws:

java.io.IOException

write

public static void write(java.lang.String filename,
                         Scribable object)
                  throws java.io.IOException

Throws:

java.io.IOException

writeGeometryToFile

public static void writeGeometryToFile(java.lang.String filename,
                                       Geometry g)
                                throws java.io.IOException

Throws:

java.io.IOException

readSceneFromFile

public static SceneGraphObject readSceneFromFile(java.lang.String filename)
                                          throws java.io.IOException,
                                                 InvalidFormat

Simple method to read a scene from a compressed file

Throws:

java.io.IOException

InvalidFormat

read

public static Scribable read(java.lang.String filename)
                      throws java.io.IOException,
                             InvalidFormat

Throws:

java.io.IOException

InvalidFormat

readHeader

public static Scribable readHeader(java.lang.String filename)
                            throws java.io.IOException,
                                   InvalidFormat

Throws:

java.io.IOException

InvalidFormat

readGeometryFromFile

public static Geometry readGeometryFromFile(java.lang.String filename)
                                     throws java.io.IOException

Throws:

java.io.IOException