Package gov.nih.mipav.view.renderer.J3D.model.file

Class FileSurfaceXML_J3D

java.lang.Object

gov.nih.mipav.model.file.FileBase

gov.nih.mipav.model.file.FileXML

gov.nih.mipav.model.file.FileSurfaceXML

gov.nih.mipav.view.renderer.J3D.model.file.FileSurfaceXML_J3D

public class FileSurfaceXML_J3D
extends FileSurfaceXML

Inherits from FileXML, reads Surface.XML files based on the "surface.xsd" file. Defines specific variables for reading and writing surface.xml files:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	FileSurfaceXML_J3D.SurfaceXMLHandler	Used by the XML Parser to parse the Surface.XML header.

Nested classes/interfaces inherited from class gov.nih.mipav.model.file.FileXML

FileXML.XMLAttributes

Field Summary

Fields inherited from class gov.nih.mipav.model.file.FileSurfaceXML

m_kMaterialStr, m_kMeshStr, m_kSurfaceStr

Fields inherited from class gov.nih.mipav.model.file.FileXML

bw, fileDir, fileInfo, fileName, m_kHandler, MIPAV_HEADER, pInterface, TAB, tabLevel, W3C_XML_SCHEMA, XML_ENCODING, XML_HEADER

Fields inherited from class gov.nih.mipav.model.file.FileBase

BIG_ENDIAN, bitsPerPixel, fileNames, LITTLE_ENDIAN, pBarVisible, raFile, READ, READ_WRITE

Constructor Summary

Constructors

Constructor	Description
FileSurfaceXML_J3D(java.lang.String fName, java.lang.String fDir)	Constructs new file object.

Method Summary

Modifier and Type	Method	Description
void	finalize()	Prepares class for cleanup.
FileInfoSurfaceXML_J3D	getFileInfo()	Returns the FileInfoSurfaceXML read from the file.
FileInfoSurfaceXML_J3D	readSurfaceXML(java.lang.String headerFileName, java.lang.String headerDir)	Reads and parses a Surface.XML header.
boolean	writeHeader(java.lang.String headerName, java.lang.String headerDir, ModelTriangleMesh[] kMesh, javax.media.j3d.Material kMaterial, float opacity, int levelDetail)	Writes the XML header information, including the ModelTriangleMesh surface out to the given filename and path:
boolean	writeXMLsurface(java.lang.String fileName, ModelTriangleMesh kMesh, javax.media.j3d.Material kMaterial, float opacity, int levelDetail)	Writes the XML file information, including the ModelTriangleMesh surface out to the given filename and path:

Methods inherited from class gov.nih.mipav.model.file.FileXML

closedTag, closedTag, closedTag, openTag, readHeader, setPBar

Methods inherited from class gov.nih.mipav.model.file.FileBase

addProgressChangeListener, bytesToDouble, bytesToFloat, bytesToInt, bytesToShort, doubleToBytes, fireProgressStateChanged, fireProgressStateChanged, fireProgressStateChanged, floatToBytes, getBufferDouble, getBufferFloat, getBufferInt, getBufferLong, getBufferShort, getBufferUShort, getDataType, getDouble, getFloat, getInt, getLong, getProgressChangeListeners, getRaFile, getSignedShort, getString, getUInt, getUnsignedByte, getUnsignedShort, intToBytes, isBigEndian, isProgressBarVisible, linkProgress, longToBytes, readDouble, readFloat, readInt, readLong, readShort, readString, readUnsignedShort, removeProgressChangeListener, setBigEndian, setBufferFloat, setBufferInt, setBufferLong, setBufferShort, setBufferString, setDataType, setEndianess, shortToBytes, writeBytes, writeDouble, writeFloat, writeInt, writeLong, writeShort

Methods inherited from class java.lang.Object

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

Constructor Detail

FileSurfaceXML_J3D

public FileSurfaceXML_J3D(java.lang.String fName,
                          java.lang.String fDir)

Constructs new file object.

Parameters:

fName - File name.

fDir - File directory.

Method Detail

finalize

public void finalize()

Prepares class for cleanup.

Overrides:

finalize in class FileSurfaceXML

getFileInfo

public FileInfoSurfaceXML_J3D getFileInfo()

Returns the FileInfoSurfaceXML read from the file.

Overrides:

getFileInfo in class FileSurfaceXML

Returns:

File info read from file, or null if it has not been read.

readSurfaceXML

public FileInfoSurfaceXML_J3D readSurfaceXML(java.lang.String headerFileName,
                                             java.lang.String headerDir)
                                      throws java.io.IOException

Reads and parses a Surface.XML header.

Parameters:

headerFileName - file name of xml header

headerDir - directory

Returns:

FileInfoSurfaceXML

Throws:

java.io.IOException - file exception

writeHeader

public boolean writeHeader(java.lang.String headerName,
                           java.lang.String headerDir,
                           ModelTriangleMesh[] kMesh,
                           javax.media.j3d.Material kMaterial,
                           float opacity,
                           int levelDetail)
                    throws java.io.IOException

Writes the XML header information, including the ModelTriangleMesh surface out to the given filename and path:

Parameters:

headerName - file name to write to

headerDir - name of directory to write to

kMesh - ModelTriangleMesh representing the surface

kMaterial - surface material

opacity - DOCUMENT ME!

levelDetail - DOCUMENT ME!

Returns:

if header write was successful

Throws:

java.io.IOException - if a file I/O problem is encoutered while writing the header

writeXMLsurface

public boolean writeXMLsurface(java.lang.String fileName,
                               ModelTriangleMesh kMesh,
                               javax.media.j3d.Material kMaterial,
                               float opacity,
                               int levelDetail)
                        throws java.io.IOException

Writes the XML file information, including the ModelTriangleMesh surface out to the given filename and path:

Parameters:

fileName - file name to write to

kMesh - ModelTriangleMesh representing the surface

kMaterial - surface material

opacity - DOCUMENT ME!

levelDetail - DOCUMENT ME!

Returns:

if header write was successful

Throws:

java.io.IOException - if a file I/O problem is encoutered while writing the header