diff options
| author | kcr <kcr@28c7f869-5b4e-e670-f602-82bfaf57f300> | 2004-06-09 03:28:13 +0000 |
|---|---|---|
| committer | kcr <kcr@28c7f869-5b4e-e670-f602-82bfaf57f300> | 2004-06-09 03:28:13 +0000 |
| commit | 53ebfcc5ad5554b67d2287f8b02c22ec8405af0f (patch) | |
| tree | 70c8fabf4cbef5a9d2a50735c4e502d56ce156da /src/GeometryCompression/ObjectFileCompressor.html | |
| parent | 4dead457a59220406dd9fcd40997d7a7b27571b0 (diff) | |
Initial creation of j3d-examples sources in CVS repository
Diffstat (limited to 'src/GeometryCompression/ObjectFileCompressor.html')
| -rw-r--r-- | src/GeometryCompression/ObjectFileCompressor.html | 437 |
1 files changed, 437 insertions, 0 deletions
diff --git a/src/GeometryCompression/ObjectFileCompressor.html b/src/GeometryCompression/ObjectFileCompressor.html new file mode 100644 index 0000000..7540a8f --- /dev/null +++ b/src/GeometryCompression/ObjectFileCompressor.html @@ -0,0 +1,437 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd"> +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc on Sat May 22 22:02:52 PDT 1999 --> +<TITLE> +: Class ObjectFileCompressor +</TITLE> +<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style"> +</HEAD> +<BODY BGCOLOR="white"> + +<!-- ========== START OF NAVBAR ========== --> +<A NAME="navbar_top"><!-- --></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="help-doc.html"><FONT ID="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + PREV CLASS + NEXT CLASS</FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="index.html" TARGET="_top"><B>FRAMES</B></A> + <A HREF="ObjectFileCompressor.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: INNER | <A HREF="#fields_inherited_from_class_com.sun.j3d.loaders.objectfile.ObjectFile">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<!-- =========== END OF NAVBAR =========== --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +Class ObjectFileCompressor</H2> +<PRE> +java.lang.Object + | + +--com.sun.j3d.loaders.objectfile.ObjectFile + | + +--<B>ObjectFileCompressor</B> +</PRE> +<HR> +<DL> +<DT>public class <B>ObjectFileCompressor</B><DT>extends com.sun.j3d.loaders.objectfile.ObjectFile</DL> + +<P> +This extension of ObjectFile provides the methods setQuantization() and + compress() to compress Wavefront .obj files into the format described by + appendix B of the Java 3D specification. +<P> +<HR> + +<P> +<!-- ======== INNER CLASS SUMMARY ======== --> + + +<!-- =========== FIELD SUMMARY =========== --> + +<A NAME="fields_inherited_from_class_com.sun.j3d.loaders.objectfile.ObjectFile"><!-- --></A> +<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TD><B>Fields inherited from class com.sun.j3d.loaders.objectfile.ObjectFile</B></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>RESIZE, +REVERSE, +STRIPIFY, +TRIANGULATE</CODE></TD> +</TR> +</TABLE> + +<!-- ======== CONSTRUCTOR SUMMARY ======== --> + +<A NAME="constructor_summary"><!-- --></A> +<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=2><FONT SIZE="+2"> +<B>Constructor Summary</B></FONT></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="ObjectFileCompressor.html#ObjectFileCompressor()">ObjectFileCompressor</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="ObjectFileCompressor.html#ObjectFileCompressor(int)">ObjectFileCompressor</A></B>(int flags)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="ObjectFileCompressor.html#ObjectFileCompressor(int, float)">ObjectFileCompressor</A></B>(int flags, + float radians)</CODE> + +<BR> + </TD> +</TR> +</TABLE> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=2><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> javax.media.j3d.CompressedGeometry</CODE></FONT></TD> +<TD><CODE><B><A HREF="ObjectFileCompressor.html#compress(java.io.Reader)">compress</A></B>(java.io.Reader reader)</CODE> + +<BR> + Compress the specified .obj file into a CompressedGeometry node + component.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="ObjectFileCompressor.html#compress(java.io.Reader, com.sun.j3d.utils.compression.CompressedGeometryFile)">compress</A></B>(java.io.Reader reader, + com.sun.j3d.utils.compression.CompressedGeometryFile file)</CODE> + +<BR> + Compress the specified .obj file and add it to the end of an open + compressed geometry file.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> javax.media.j3d.CompressedGeometry</CODE></FONT></TD> +<TD><CODE><B><A HREF="ObjectFileCompressor.html#compress(java.lang.String)">compress</A></B>(java.lang.String objFileName)</CODE> + +<BR> + Compress the specified .obj file into a CompressedGeometry node + component.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="ObjectFileCompressor.html#compress(java.lang.String, com.sun.j3d.utils.compression.CompressedGeometryFile)">compress</A></B>(java.lang.String objFileName, + com.sun.j3d.utils.compression.CompressedGeometryFile file)</CODE> + +<BR> + Compress the specified .obj file and add it to the end of an open + compressed geometry file.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> javax.media.j3d.CompressedGeometry</CODE></FONT></TD> +<TD><CODE><B><A HREF="ObjectFileCompressor.html#compress(java.net.URL)">compress</A></B>(java.net.URL url)</CODE> + +<BR> + Compress the specified .obj file into a CompressedGeometry node + component.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="ObjectFileCompressor.html#compress(java.net.URL, com.sun.j3d.utils.compression.CompressedGeometryFile)">compress</A></B>(java.net.URL url, + com.sun.j3d.utils.compression.CompressedGeometryFile file)</CODE> + +<BR> + Compress the specified .obj file and add it to the end of an open + compressed geometry file.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="ObjectFileCompressor.html#setFlags(int)">setFlags</A></B>(int flags)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="ObjectFileCompressor.html#setQuantization(int, int, int)">setQuantization</A></B>(int positionQuant, + int colorQuant, + int normalQuant)</CODE> + +<BR> + Set the position, normal, and color quantization values for compression.</TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_com.sun.j3d.loaders.objectfile.ObjectFile"><!-- --></A> +<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TD><B>Methods inherited from class com.sun.j3d.loaders.objectfile.ObjectFile</B></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>getBasePath, +getBaseUrl, +getFlags, +load, +load, +load, +setBasePath, +setBaseUrl</CODE></TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TD><B>Methods inherited from class java.lang.Object</B></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>clone, +equals, +finalize, +getClass, +hashCode, +notify, +notifyAll, +toString, +wait, +wait, +wait</CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ============ FIELD DETAIL =========== --> + + +<!-- ========= CONSTRUCTOR DETAIL ======== --> + +<A NAME="constructor_detail"><!-- --></A> +<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=1><FONT SIZE="+2"> +<B>Constructor Detail</B></FONT></TD> +</TR> +</TABLE> + +<A NAME="ObjectFileCompressor()"><!-- --></A><H3> +ObjectFileCompressor</H3> +<PRE> +public <B>ObjectFileCompressor</B>()</PRE> +<DL> +</DL> +<HR> + +<A NAME="ObjectFileCompressor(int)"><!-- --></A><H3> +ObjectFileCompressor</H3> +<PRE> +public <B>ObjectFileCompressor</B>(int flags)</PRE> +<DL> +</DL> +<HR> + +<A NAME="ObjectFileCompressor(int, float)"><!-- --></A><H3> +ObjectFileCompressor</H3> +<PRE> +public <B>ObjectFileCompressor</B>(int flags, + float radians)</PRE> +<DL> +</DL> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=1><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TD> +</TR> +</TABLE> + +<A NAME="setFlags(int)"><!-- --></A><H3> +setFlags</H3> +<PRE> +public void <B>setFlags</B>(int flags)</PRE> +<DL> +<DD><DL> +<DT><B>Overrides:</B><DD>setFlags in class com.sun.j3d.loaders.objectfile.ObjectFile</DL> +</DD> +</DL> +<HR> + +<A NAME="setQuantization(int, int, int)"><!-- --></A><H3> +setQuantization</H3> +<PRE> +public void <B>setQuantization</B>(int positionQuant, + int colorQuant, + int normalQuant)</PRE> +<DL> +<DD>Set the position, normal, and color quantization values for compression.<DD><DL> +<DT><B>Parameters:</B><DD><CODE>positionQuant</CODE> - number of bits to quantize each position's X, Y, + and Z components, ranging from 1 to 16 with a default of 10<DD><CODE>colorQuant</CODE> - number of bits to quantize each color's R, G, B, and + alpha components, ranging from 2 to 16 with a default of 8<DD><CODE>normalQuant</CODE> - number of bits for quantizing each normal's U and V + components, ranging from 0 to 6 with a default of 3</DL> +</DD> +</DL> +<HR> + +<A NAME="compress(java.lang.String)"><!-- --></A><H3> +compress</H3> +<PRE> +public javax.media.j3d.CompressedGeometry <B>compress</B>(java.lang.String objFileName)</PRE> +<DL> +<DD>Compress the specified .obj file into a CompressedGeometry node + component.<DD><DL> +<DT><B>Parameters:</B><DD><CODE>objFileName</CODE> - String object representing the path to a .obj file<DT><B>Returns:</B><DD>a CompressedGeometry node component</DL> +</DD> +</DL> +<HR> + +<A NAME="compress(java.lang.String, com.sun.j3d.utils.compression.CompressedGeometryFile)"><!-- --></A><H3> +compress</H3> +<PRE> +public void <B>compress</B>(java.lang.String objFileName, + com.sun.j3d.utils.compression.CompressedGeometryFile file) + throws java.io.IOException</PRE> +<DL> +<DD>Compress the specified .obj file and add it to the end of an open + compressed geometry file.<DD><DL> +<DT><B>Parameters:</B><DD><CODE>objFileName</CODE> - String object representing the path to a .obj file<DD><CODE>file</CODE> - a currently open CompressedGeometryFile object<DT><B>Throws:</B><DD>java.io.IOException - - if write fails</DL> +</DD> +</DL> +<HR> + +<A NAME="compress(java.io.Reader)"><!-- --></A><H3> +compress</H3> +<PRE> +public javax.media.j3d.CompressedGeometry <B>compress</B>(java.io.Reader reader)</PRE> +<DL> +<DD>Compress the specified .obj file into a CompressedGeometry node + component.<DD><DL> +<DT><B>Parameters:</B><DD><CODE>reader</CODE> - an open .obj file<DT><B>Returns:</B><DD>a CompressedGeometry node component</DL> +</DD> +</DL> +<HR> + +<A NAME="compress(java.io.Reader, com.sun.j3d.utils.compression.CompressedGeometryFile)"><!-- --></A><H3> +compress</H3> +<PRE> +public void <B>compress</B>(java.io.Reader reader, + com.sun.j3d.utils.compression.CompressedGeometryFile file) + throws java.io.IOException</PRE> +<DL> +<DD>Compress the specified .obj file and add it to the end of an open + compressed geometry file.<DD><DL> +<DT><B>Parameters:</B><DD><CODE>reader</CODE> - an open .obj file<DD><CODE>file</CODE> - an open CompressedGeometryFile object<DT><B>Throws:</B><DD>java.io.IOException - - if write fails</DL> +</DD> +</DL> +<HR> + +<A NAME="compress(java.net.URL)"><!-- --></A><H3> +compress</H3> +<PRE> +public javax.media.j3d.CompressedGeometry <B>compress</B>(java.net.URL url)</PRE> +<DL> +<DD>Compress the specified .obj file into a CompressedGeometry node + component.<DD><DL> +<DT><B>Parameters:</B><DD><CODE>url</CODE> - Uniform Resource Locator for the .obj file<DT><B>Returns:</B><DD>a CompressedGeometry node component</DL> +</DD> +</DL> +<HR> + +<A NAME="compress(java.net.URL, com.sun.j3d.utils.compression.CompressedGeometryFile)"><!-- --></A><H3> +compress</H3> +<PRE> +public void <B>compress</B>(java.net.URL url, + com.sun.j3d.utils.compression.CompressedGeometryFile file) + throws java.io.IOException</PRE> +<DL> +<DD>Compress the specified .obj file and add it to the end of an open + compressed geometry file.<DD><DL> +<DT><B>Parameters:</B><DD><CODE>url</CODE> - Uniform Resource Locator for the .obj file<DD><CODE>file</CODE> - a currently open CompressedGeometryFile object<DT><B>Throws:</B><DD>java.io.IOException - - if write fails</DL> +</DD> +</DL> +<!-- ========= END OF CLASS DATA ========= --> +<HR> + +<!-- ========== START OF NAVBAR ========== --> +<A NAME="navbar_bottom"><!-- --></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="help-doc.html"><FONT ID="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + PREV CLASS + NEXT CLASS</FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="index.html" TARGET="_top"><B>FRAMES</B></A> + <A HREF="ObjectFileCompressor.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: INNER | <A HREF="#fields_inherited_from_class_com.sun.j3d.loaders.objectfile.ObjectFile">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<!-- =========== END OF NAVBAR =========== --> + +<HR> + +</BODY> +</HTML> |