com.sun.j3d.utils.compression

Class CompressedGeometryFile

java.lang.Object

com.sun.j3d.utils.compression.CompressedGeometryFile

Deprecated.

As of Java 3D 1.5, replaced by com.sun.j3d.utils.geometry.compression.CompressedGeometryFile.

public class CompressedGeometryFile
extends java.lang.Object

This class provides methods to read and write compressed geometry resource files. These files usually end with the .cg extension and support sequential as well as random access to multiple compressed geometry objects.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static int	ALPHA_PRESENT_MASK Deprecated. Bit in compressed geometry data descriptor encoding presence of alphas.
private static boolean	benchmark Deprecated.
(package private) static int	BLOCK_HEADER_SIZE Deprecated. Block header total size in bytes.
(package private) int	bufferNextObjectCount Deprecated.
(package private) int	bufferNextObjectOffset Deprecated.
(package private) int	bufferObjectCount Deprecated.
(package private) int	bufferObjectStart Deprecated.
(package private) byte[]	cgBuffer Deprecated.
(package private) java.io.RandomAccessFile	cgFile Deprecated.
(package private) CompressedGeometryHeader	cgh Deprecated.
(package private) static int	COLOR_PRESENT_MASK Deprecated. Bit in compressed geometry data descriptor encoding presence of colors.
(package private) long[]	directory Deprecated.
(package private) static int	DIRECTORY_OFFSET_OFFSET Deprecated. Byte offset of the directory offset from start of file.
(package private) long	directoryOffset Deprecated.
(package private) java.lang.String	fileName Deprecated.
(package private) boolean	fileUpdate Deprecated.
(package private) static int	GEOM_DATA_OFFSET Deprecated. Byte offset of the compressed geometry data descriptor from start of individual compressed geometry block.
(package private) int	geomDataType Deprecated.
(package private) int	geomSize Deprecated.
(package private) int	geomStart Deprecated.
(package private) static int	HEADER_SIZE Deprecated. File header total size in bytes.
(package private) static int	MAGIC_NUMBER Deprecated. The magic number which identifies the compressed geometry file type.
(package private) static int	MAGIC_NUMBER_OFFSET Deprecated. Byte offset of the magic number from start of file.
(package private) int	magicNumber Deprecated.
(package private) static int	MAJOR_VERSION_OFFSET Deprecated. Byte offset of the major version number from start of file.
(package private) int	majorVersionNumber Deprecated.
(package private) static int	MINOR_MINOR_VERSION_OFFSET Deprecated. Byte offset of the minor minor version number from start of file.
(package private) static int	MINOR_VERSION_OFFSET Deprecated. Byte offset of the minor version number from start of file.
(package private) int	minorMinorVersionNumber Deprecated.
(package private) int	minorVersionNumber Deprecated.
(package private) static int	NORMAL_PRESENT_MASK Deprecated. Bit in compressed geometry data descriptor encoding presence of normals.
(package private) static int	OBJECT_COUNT_OFFSET Deprecated. Byte offset of the number of objects from start of file.
(package private) static int	OBJECT_SIZE_OFFSET Deprecated. Byte offset of the object size from start of individual compressed geometry block.
(package private) int	objectCount Deprecated.
(package private) int	objectIndex Deprecated.
(package private) int[]	objectSizes Deprecated.
private static boolean	print Deprecated.
(package private) static int	TYPE_LINE Deprecated. Value in compressed geometry data descriptor for a line buffer type.
(package private) static int	TYPE_MASK Deprecated. Bits in compressed geometry data descriptor which encode the buffer type.
(package private) static int	TYPE_POINT Deprecated. Value in compressed geometry data descriptor for a point buffer type.
(package private) static int	TYPE_TRIANGLE Deprecated. Value in compressed geometry data descriptor for a triangle buffer type.

Constructor Summary

Constructors

Constructor and Description
CompressedGeometryFile(java.io.RandomAccessFile file) Deprecated. Construct a new CompressedGeometryFile instance associated with a currently open RandomAccessFile.
CompressedGeometryFile(java.lang.String file) Deprecated. Construct a new CompressedGeometryFile instance associated with the specified file.
CompressedGeometryFile(java.lang.String file, boolean rw) Deprecated. Construct a new CompressedGeometryFile instance associated with the specified file.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Deprecated. Delete all compressed objects from this instance.
void	close() Deprecated. Release the resources associated with this instance.
protected void	finalize() Deprecated. Release file resources when this object is garbage collected.
int	getCurrentIndex() Deprecated. Return the current object index associated with this instance.
java.lang.String	getFileName() Deprecated. Return a string containing the file name associated with this instance or null if there is none.
int	getMajorVersionNumber() Deprecated. Return the major version number of the most recent compressor used to compress any of the objects in this instance.
int	getMinorMinorVersionNumber() Deprecated. Return the subminor version number of the most recent compressor used to compress any of the objects in this instance.
int	getMinorVersionNumber() Deprecated. Return the minor version number of the most recent compressor used to compress any of the objects in this instance.
int	getObjectCount() Deprecated. Return the number of compressed objects in this instance.
(package private) void	initialize() Deprecated.
(package private) CompressedGeometry	newCG(int geomSize, int geomStart, int geomDataType) Deprecated.
(package private) void	open(java.lang.String fname, boolean rw) Deprecated.
CompressedGeometry[]	read() Deprecated. Read all compressed geometry objects contained in the instance.
CompressedGeometry	read(int index) Deprecated. Read the compressed geometry object at the specified index.
(package private) void	readDirectory(long offset, long[] directory) Deprecated.
(package private) void	readFileHeader() Deprecated.
CompressedGeometry	readNext() Deprecated. Read the next compressed geometry object in the instance.
(package private) CompressedGeometry	readNext(int bufferReadLimit) Deprecated.
(package private) void	setFilePointer(long offset) Deprecated.
void	write(CompressedGeometry cg) Deprecated. Add a compressed geometry node component to the end of the instance.
void	write(CompressedGeometryHeader cgh, byte[] geometry) Deprecated. Add a buffer of compressed geometry data to the end of the resource.
(package private) void	writeFileDirectory() Deprecated.
(package private) void	writeFileHeader() Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

print

private static final boolean print

Deprecated.

See Also:

Constant Field Values

benchmark

private static final boolean benchmark

Deprecated.

See Also:

Constant Field Values

MAGIC_NUMBER

static final int MAGIC_NUMBER

Deprecated.

The magic number which identifies the compressed geometry file type.

See Also:

Constant Field Values

MAGIC_NUMBER_OFFSET

static final int MAGIC_NUMBER_OFFSET

Deprecated.

Byte offset of the magic number from start of file.

See Also:

Constant Field Values

MAJOR_VERSION_OFFSET

static final int MAJOR_VERSION_OFFSET

Deprecated.

Byte offset of the major version number from start of file.

See Also:

Constant Field Values

MINOR_VERSION_OFFSET

static final int MINOR_VERSION_OFFSET

Deprecated.

Byte offset of the minor version number from start of file.

See Also:

Constant Field Values

MINOR_MINOR_VERSION_OFFSET

static final int MINOR_MINOR_VERSION_OFFSET

Deprecated.

Byte offset of the minor minor version number from start of file.

See Also:

Constant Field Values

OBJECT_COUNT_OFFSET

static final int OBJECT_COUNT_OFFSET

Deprecated.

Byte offset of the number of objects from start of file.

See Also:

Constant Field Values

DIRECTORY_OFFSET_OFFSET

static final int DIRECTORY_OFFSET_OFFSET

Deprecated.

Byte offset of the directory offset from start of file. This offset is long word aligned since the directory offset is a long.

See Also:

Constant Field Values

HEADER_SIZE

static final int HEADER_SIZE

Deprecated.

File header total size in bytes.

See Also:

Constant Field Values

OBJECT_SIZE_OFFSET

static final int OBJECT_SIZE_OFFSET

Deprecated.

Byte offset of the object size from start of individual compressed geometry block.

See Also:

Constant Field Values

GEOM_DATA_OFFSET

static final int GEOM_DATA_OFFSET

Deprecated.

Byte offset of the compressed geometry data descriptor from start of individual compressed geometry block.

See Also:

Constant Field Values

TYPE_MASK

static final int TYPE_MASK

Deprecated.

Bits in compressed geometry data descriptor which encode the buffer type.

See Also:

Constant Field Values

NORMAL_PRESENT_MASK

static final int NORMAL_PRESENT_MASK

Deprecated.

Bit in compressed geometry data descriptor encoding presence of normals.

See Also:

Constant Field Values

COLOR_PRESENT_MASK

static final int COLOR_PRESENT_MASK

Deprecated.

Bit in compressed geometry data descriptor encoding presence of colors.

See Also:

Constant Field Values

ALPHA_PRESENT_MASK

static final int ALPHA_PRESENT_MASK

Deprecated.

Bit in compressed geometry data descriptor encoding presence of alphas.

See Also:

Constant Field Values

TYPE_POINT

static final int TYPE_POINT

Deprecated.

Value in compressed geometry data descriptor for a point buffer type.

See Also:

Constant Field Values

TYPE_LINE

static final int TYPE_LINE

Deprecated.

Value in compressed geometry data descriptor for a line buffer type.

See Also:

Constant Field Values

TYPE_TRIANGLE

static final int TYPE_TRIANGLE

Deprecated.

Value in compressed geometry data descriptor for a triangle buffer type.

See Also:

Constant Field Values

BLOCK_HEADER_SIZE

static final int BLOCK_HEADER_SIZE

Deprecated.

Block header total size in bytes.

See Also:

Constant Field Values

fileName

java.lang.String fileName

Deprecated.

majorVersionNumber

int majorVersionNumber

Deprecated.

minorVersionNumber

int minorVersionNumber

Deprecated.

minorMinorVersionNumber

int minorMinorVersionNumber

Deprecated.

objectCount

int objectCount

Deprecated.

objectIndex

int objectIndex

Deprecated.

cgFile

java.io.RandomAccessFile cgFile

Deprecated.

magicNumber

int magicNumber

Deprecated.

cgBuffer

byte[] cgBuffer

Deprecated.

geomSize

int geomSize

Deprecated.

geomStart

int geomStart

Deprecated.

geomDataType

int geomDataType

Deprecated.

directory

long[] directory

Deprecated.

directoryOffset

long directoryOffset

Deprecated.

objectSizes

int[] objectSizes

Deprecated.

bufferObjectStart

int bufferObjectStart

Deprecated.

bufferObjectCount

int bufferObjectCount

Deprecated.

bufferNextObjectCount

int bufferNextObjectCount

Deprecated.

bufferNextObjectOffset

int bufferNextObjectOffset

Deprecated.

cgh

CompressedGeometryHeader cgh

Deprecated.

fileUpdate

boolean fileUpdate

Deprecated.

Constructor Detail

CompressedGeometryFile

public CompressedGeometryFile(java.lang.String file)
                       throws java.io.IOException

Deprecated.

Construct a new CompressedGeometryFile instance associated with the specified file. An attempt is made to open the file with read-only access; if this fails then a FileNotFoundException is thrown.

Parameters:

file - path to the compressed geometry resource file

Throws:

java.io.FileNotFoundException - if file doesn't exist or cannot be read

java.lang.IllegalArgumentException - if the file is not a compressed geometry resource file

java.io.IOException - if there is a header or directory read error

CompressedGeometryFile

public CompressedGeometryFile(java.lang.String file,
                      boolean rw)
                       throws java.io.IOException

Deprecated.

Construct a new CompressedGeometryFile instance associated with the specified file.

Parameters:

file - path to the compressed geometry resource file

rw - if true, opens the file for read and write access or attempts to create one if it doesn't exist; if false, opens the file with read-only access

Throws:

java.io.FileNotFoundException - if file doesn't exist or access permissions disallow access

java.lang.IllegalArgumentException - if the file is not a compressed geometry resource file

java.io.IOException - if there is a header or directory read error

CompressedGeometryFile

public CompressedGeometryFile(java.io.RandomAccessFile file)
                       throws java.io.IOException

Deprecated.

Construct a new CompressedGeometryFile instance associated with a currently open RandomAccessFile.

Parameters:

file - currently open RandomAccessFile

Throws:

java.lang.IllegalArgumentException - if the file is not a compressed geometry resource file

java.io.IOException - if there is a header or directory read error

Method Detail

clear

public void clear()
           throws java.io.IOException

Deprecated.

Delete all compressed objects from this instance. This method may only be called after successfully creating a CompressedGeometryFile instance with read-write access, so a corrupted or otherwise invalid resource must be removed manually before it can be rewritten. The close() method must be called sometime after invoking clear() in order to write out the new directory structure.

Throws:

java.io.IOException - if clear fails

getFileName

public java.lang.String getFileName()

Deprecated.

Return a string containing the file name associated with this instance or null if there is none.

Returns:

file name associated with this instance or null if there is none

getMajorVersionNumber

public int getMajorVersionNumber()

Deprecated.

Return the major version number of the most recent compressor used to compress any of the objects in this instance.

Returns:

major version number

getMinorVersionNumber

public int getMinorVersionNumber()

Deprecated.

Return the minor version number of the most recent compressor used to compress any of the objects in this instance.

Returns:

minor version number

getMinorMinorVersionNumber

public int getMinorMinorVersionNumber()

Deprecated.

Return the subminor version number of the most recent compressor used to compress any of the objects in this instance.

Returns:

subminor version number

getObjectCount

public int getObjectCount()

Deprecated.

Return the number of compressed objects in this instance.

Returns:

number of compressed objects

getCurrentIndex

public int getCurrentIndex()

Deprecated.

Return the current object index associated with this instance. This is the index of the object that would be returned by an immediately following call to the readNext() method. Its initial value is 0; -1 is returned if the last object has been read.

Returns:

current object index, or -1 if at end

readNext

public CompressedGeometry readNext()
                            throws java.io.IOException

Deprecated.

Read the next compressed geometry object in the instance. This is initially the first object (index 0) in the instance; otherwise, it is whatever object is next after the last one read. The current object index is incremented by 1 after the read. When the last object is read the index becomes invalid and an immediately subsequent call to readNext() returns null.

Returns:

a CompressedGeometry node component, or null if the last object has been read

Throws:

java.io.IOException - if read fails

read

public CompressedGeometry[] read()
                          throws java.io.IOException

Deprecated.

Read all compressed geometry objects contained in the instance. The current object index becomes invalid; an immediately following call to readNext() will return null.

Returns:

an array of CompressedGeometry node components.

Throws:

java.io.IOException - if read fails

read

public CompressedGeometry read(int index)
                        throws java.io.IOException

Deprecated.

Read the compressed geometry object at the specified index. The current object index is set to the subsequent object unless the last object has been read, in which case the index becomes invalid and an immediately following call to readNext() will return null.

Parameters:

index - compressed geometry object to read

Returns:

a CompressedGeometry node component

Throws:

java.lang.IndexOutOfBoundsException - if object index is out of range

java.io.IOException - if read fails

write

public void write(CompressedGeometry cg)
           throws java.io.IOException

Deprecated.

Add a compressed geometry node component to the end of the instance. The current object index becomes invalid; an immediately following call to readNext() will return null. The close() method must be called at some later time in order to create a valid compressed geometry file.

Parameters:

cg - a compressed geometry node component

Throws:

CapabilityNotSetException - if unable to get compressed geometry data from the node component

java.io.IOException - if write fails

write

public void write(CompressedGeometryHeader cgh,
         byte[] geometry)
           throws java.io.IOException

Deprecated.

Add a buffer of compressed geometry data to the end of the resource. The current object index becomes invalid; an immediately following call to readNext() will return null. The close() method must be called at some later time in order to create a valid compressed geometry file.

Parameters:

cgh - a CompressedGeometryHeader object describing the data.

geometry - the compressed geometry data

Throws:

java.io.IOException - if write fails

close

public void close()

Deprecated.

Release the resources associated with this instance. Write out final header and directory if contents were updated. This method must be called in order to create a valid compressed geometry resource file if any updates were made.

open

void open(java.lang.String fname,
        boolean rw)
    throws java.io.FileNotFoundException,
           java.io.IOException

Deprecated.

Throws:

java.io.FileNotFoundException

java.io.IOException

setFilePointer

void setFilePointer(long offset)
              throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

initialize

void initialize()
          throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

readFileHeader

void readFileHeader()
              throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

writeFileHeader

void writeFileHeader()
               throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

readDirectory

void readDirectory(long offset,
                 long[] directory)
             throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

writeFileDirectory

void writeFileDirectory()
                  throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

readNext

CompressedGeometry readNext(int bufferReadLimit)
                      throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

newCG

CompressedGeometry newCG(int geomSize,
                       int geomStart,
                       int geomDataType)

Deprecated.

finalize

protected void finalize()

Deprecated.

Release file resources when this object is garbage collected.

Overrides:

finalize in class java.lang.Object