summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKevin Rushforth <[email protected]>2005-10-26 21:56:40 +0000
committerKevin Rushforth <[email protected]>2005-10-26 21:56:40 +0000
commitfa2bb8e89d549471f52b53acebd83f75c10c6aaa (patch)
tree23422c79d1cec8144825b8500be3f4a5741c0690
parent3f8aaf3394f9eae3fc084e71c362dfc998d6f3e2 (diff)
Added package descriptions for all public packages
git-svn-id: https://svn.java.net/svn/j3d-core-utils~svn/trunk@84 9497e636-51bd-65ba-982d-a4982e1767a5
-rw-r--r--src/classes/share/com/sun/j3d/audioengines/javasound/package.html11
-rw-r--r--src/classes/share/com/sun/j3d/audioengines/package.html11
-rw-r--r--src/classes/share/com/sun/j3d/loaders/lw3d/package.html11
-rw-r--r--src/classes/share/com/sun/j3d/loaders/objectfile/package.html11
-rw-r--r--src/classes/share/com/sun/j3d/loaders/package.html11
-rw-r--r--src/classes/share/com/sun/j3d/utils/applet/package.html12
-rw-r--r--src/classes/share/com/sun/j3d/utils/audio/package.html11
-rw-r--r--src/classes/share/com/sun/j3d/utils/behaviors/interpolators/package.html11
-rw-r--r--src/classes/share/com/sun/j3d/utils/behaviors/keyboard/package.html11
-rw-r--r--src/classes/share/com/sun/j3d/utils/behaviors/mouse/package.html11
-rw-r--r--src/classes/share/com/sun/j3d/utils/behaviors/picking/package.html13
-rw-r--r--src/classes/share/com/sun/j3d/utils/behaviors/sensor/package.html11
-rw-r--r--src/classes/share/com/sun/j3d/utils/behaviors/vp/package.html11
-rw-r--r--src/classes/share/com/sun/j3d/utils/compression/package.html11
-rw-r--r--src/classes/share/com/sun/j3d/utils/geometry/package.html12
-rw-r--r--src/classes/share/com/sun/j3d/utils/image/package.html11
-rw-r--r--src/classes/share/com/sun/j3d/utils/pickfast/behaviors/package.html11
-rw-r--r--src/classes/share/com/sun/j3d/utils/pickfast/package.html11
-rw-r--r--src/classes/share/com/sun/j3d/utils/picking/behaviors/package.html12
-rw-r--r--src/classes/share/com/sun/j3d/utils/picking/package.html12
-rw-r--r--src/classes/share/com/sun/j3d/utils/scenegraph/transparency/package.html11
-rw-r--r--src/classes/share/com/sun/j3d/utils/shader/package.html11
-rw-r--r--src/classes/share/com/sun/j3d/utils/timer/package.html68
-rw-r--r--src/classes/share/com/sun/j3d/utils/universe/package.html12
24 files changed, 271 insertions, 57 deletions
diff --git a/src/classes/share/com/sun/j3d/audioengines/javasound/package.html b/src/classes/share/com/sun/j3d/audioengines/javasound/package.html
new file mode 100644
index 0000000..5897bc9
--- /dev/null
+++ b/src/classes/share/com/sun/j3d/audioengines/javasound/package.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <meta content="text/html; charset=ISO-8859-1"
+ http-equiv="content-type">
+ <title>com.sun.j3d.audioengines.javasound</title>
+</head>
+<body>
+<p>Provides a JavaSound-based implementation of a Java 3D audio device.</p>
+</body>
+</html>
diff --git a/src/classes/share/com/sun/j3d/audioengines/package.html b/src/classes/share/com/sun/j3d/audioengines/package.html
new file mode 100644
index 0000000..59b80b4
--- /dev/null
+++ b/src/classes/share/com/sun/j3d/audioengines/package.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <meta content="text/html; charset=ISO-8859-1"
+ http-equiv="content-type">
+ <title>com.sun.j3d.audioengines</title>
+</head>
+<body>
+<p>Provides abstract classes for creating Java 3D audio devices.</p>
+</body>
+</html>
diff --git a/src/classes/share/com/sun/j3d/loaders/lw3d/package.html b/src/classes/share/com/sun/j3d/loaders/lw3d/package.html
new file mode 100644
index 0000000..e87c100
--- /dev/null
+++ b/src/classes/share/com/sun/j3d/loaders/lw3d/package.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <meta content="text/html; charset=ISO-8859-1"
+ http-equiv="content-type">
+ <title>com.sun.j3d.loaders.lw3d</title>
+</head>
+<body>
+<p>Provides a Java 3D loader for Lightwave 3D scene files.</p>
+</body>
+</html>
diff --git a/src/classes/share/com/sun/j3d/loaders/objectfile/package.html b/src/classes/share/com/sun/j3d/loaders/objectfile/package.html
new file mode 100644
index 0000000..1171815
--- /dev/null
+++ b/src/classes/share/com/sun/j3d/loaders/objectfile/package.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <meta content="text/html; charset=ISO-8859-1"
+ http-equiv="content-type">
+ <title>com.sun.j3d.loaders.objectfile</title>
+</head>
+<body>
+<p>Provides a Java 3D loader for Wavefront .obj files.</p>
+</body>
+</html>
diff --git a/src/classes/share/com/sun/j3d/loaders/package.html b/src/classes/share/com/sun/j3d/loaders/package.html
new file mode 100644
index 0000000..6b38d00
--- /dev/null
+++ b/src/classes/share/com/sun/j3d/loaders/package.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <meta content="text/html; charset=ISO-8859-1"
+ http-equiv="content-type">
+ <title>com.sun.j3d.loaders</title>
+</head>
+<body>
+<p>Provides interfaces and abstract classes for writing Java 3D loaders.</p>
+</body>
+</html>
diff --git a/src/classes/share/com/sun/j3d/utils/applet/package.html b/src/classes/share/com/sun/j3d/utils/applet/package.html
new file mode 100644
index 0000000..3e0334e
--- /dev/null
+++ b/src/classes/share/com/sun/j3d/utils/applet/package.html
@@ -0,0 +1,12 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <meta content="text/html; charset=ISO-8859-1"
+ http-equiv="content-type">
+ <title>com.sun.j3d.utils.applet</title>
+</head>
+<body>
+<p>Provides utility classes for running applets as stand-alone
+applications.</p>
+</body>
+</html>
diff --git a/src/classes/share/com/sun/j3d/utils/audio/package.html b/src/classes/share/com/sun/j3d/utils/audio/package.html
new file mode 100644
index 0000000..c0ccbfc
--- /dev/null
+++ b/src/classes/share/com/sun/j3d/utils/audio/package.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <meta content="text/html; charset=ISO-8859-1"
+ http-equiv="content-type">
+ <title>com.sun.j3d.utils.audio</title>
+</head>
+<body>
+<p>Provides audio utility classes.</p>
+</body>
+</html>
diff --git a/src/classes/share/com/sun/j3d/utils/behaviors/interpolators/package.html b/src/classes/share/com/sun/j3d/utils/behaviors/interpolators/package.html
new file mode 100644
index 0000000..7f18f4a
--- /dev/null
+++ b/src/classes/share/com/sun/j3d/utils/behaviors/interpolators/package.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <meta content="text/html; charset=ISO-8859-1"
+ http-equiv="content-type">
+ <title>com.sun.j3d.utils.behaviors.interpolators</title>
+</head>
+<body>
+<p>Provides spline-based interpolation behaviors.</p>
+</body>
+</html>
diff --git a/src/classes/share/com/sun/j3d/utils/behaviors/keyboard/package.html b/src/classes/share/com/sun/j3d/utils/behaviors/keyboard/package.html
new file mode 100644
index 0000000..b22646e
--- /dev/null
+++ b/src/classes/share/com/sun/j3d/utils/behaviors/keyboard/package.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <meta content="text/html; charset=ISO-8859-1"
+ http-equiv="content-type">
+ <title>com.sun.j3d.utils.behaviors.keyboard</title>
+</head>
+<body>
+<p>Provides keyboard navigation utility classes.</p>
+</body>
+</html>
diff --git a/src/classes/share/com/sun/j3d/utils/behaviors/mouse/package.html b/src/classes/share/com/sun/j3d/utils/behaviors/mouse/package.html
new file mode 100644
index 0000000..d943a49
--- /dev/null
+++ b/src/classes/share/com/sun/j3d/utils/behaviors/mouse/package.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <meta content="text/html; charset=ISO-8859-1"
+ http-equiv="content-type">
+ <title>com.sun.j3d.utils.behaviors.mouse</title>
+</head>
+<body>
+<p>Provides mouse navigation utility classes.</p>
+</body>
+</html>
diff --git a/src/classes/share/com/sun/j3d/utils/behaviors/picking/package.html b/src/classes/share/com/sun/j3d/utils/behaviors/picking/package.html
new file mode 100644
index 0000000..a0f813c
--- /dev/null
+++ b/src/classes/share/com/sun/j3d/utils/behaviors/picking/package.html
@@ -0,0 +1,13 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <meta content="text/html; charset=ISO-8859-1"
+ http-equiv="content-type">
+ <title>com.sun.j3d.utils.behaviors.picking</title>
+</head>
+<body>
+<p><i><b>Deprecated</b>: this package is deprecated; use <code><a
+ href="../../pickfast/behaviors/package-summary.html">com.sun.j3d.utils.pickfast.behaviors</a></code>
+instead.</i></p>
+</body>
+</html>
diff --git a/src/classes/share/com/sun/j3d/utils/behaviors/sensor/package.html b/src/classes/share/com/sun/j3d/utils/behaviors/sensor/package.html
new file mode 100644
index 0000000..25c9b13
--- /dev/null
+++ b/src/classes/share/com/sun/j3d/utils/behaviors/sensor/package.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <meta content="text/html; charset=ISO-8859-1"
+ http-equiv="content-type">
+ <title>com.sun.j3d.utils.behaviors.sensor</title>
+</head>
+<body>
+<p>Provides 6DOF sensor behavior classes.</p>
+</body>
+</html>
diff --git a/src/classes/share/com/sun/j3d/utils/behaviors/vp/package.html b/src/classes/share/com/sun/j3d/utils/behaviors/vp/package.html
new file mode 100644
index 0000000..4900193
--- /dev/null
+++ b/src/classes/share/com/sun/j3d/utils/behaviors/vp/package.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <meta content="text/html; charset=ISO-8859-1"
+ http-equiv="content-type">
+ <title>com.sun.j3d.utils.behaviors.vp</title>
+</head>
+<body>
+<p>Provides ViewPlatform navigation utility classes.</p>
+</body>
+</html>
diff --git a/src/classes/share/com/sun/j3d/utils/compression/package.html b/src/classes/share/com/sun/j3d/utils/compression/package.html
new file mode 100644
index 0000000..538b9ea
--- /dev/null
+++ b/src/classes/share/com/sun/j3d/utils/compression/package.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <meta content="text/html; charset=ISO-8859-1"
+ http-equiv="content-type">
+ <title>com.sun.j3d.utils.compression</title>
+</head>
+<body>
+<p>Provides geometry compression utility classes.</p>
+</body>
+</html>
diff --git a/src/classes/share/com/sun/j3d/utils/geometry/package.html b/src/classes/share/com/sun/j3d/utils/geometry/package.html
new file mode 100644
index 0000000..49da2ca
--- /dev/null
+++ b/src/classes/share/com/sun/j3d/utils/geometry/package.html
@@ -0,0 +1,12 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <meta content="text/html; charset=ISO-8859-1"
+ http-equiv="content-type">
+ <title>com.sun.j3d.utils.geometry</title>
+</head>
+<body>
+<p>Provides geometry construction, triangulation, and optimization
+utility classes.</p>
+</body>
+</html>
diff --git a/src/classes/share/com/sun/j3d/utils/image/package.html b/src/classes/share/com/sun/j3d/utils/image/package.html
new file mode 100644
index 0000000..e32c5d8
--- /dev/null
+++ b/src/classes/share/com/sun/j3d/utils/image/package.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <meta content="text/html; charset=ISO-8859-1"
+ http-equiv="content-type">
+ <title>com.sun.j3d.utils.image</title>
+</head>
+<body>
+<p>Provides texture image utility classes.</p>
+</body>
+</html>
diff --git a/src/classes/share/com/sun/j3d/utils/pickfast/behaviors/package.html b/src/classes/share/com/sun/j3d/utils/pickfast/behaviors/package.html
new file mode 100644
index 0000000..c401786
--- /dev/null
+++ b/src/classes/share/com/sun/j3d/utils/pickfast/behaviors/package.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <meta content="text/html; charset=ISO-8859-1"
+ http-equiv="content-type">
+ <title>com.sun.j3d.utils.pickfast.behaviors</title>
+</head>
+<body>
+<p>Provides picking behaviors for the new core picking methods.</p>
+</body>
+</html>
diff --git a/src/classes/share/com/sun/j3d/utils/pickfast/package.html b/src/classes/share/com/sun/j3d/utils/pickfast/package.html
new file mode 100644
index 0000000..b23eb91
--- /dev/null
+++ b/src/classes/share/com/sun/j3d/utils/pickfast/package.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <meta content="text/html; charset=ISO-8859-1"
+ http-equiv="content-type">
+ <title>com.sun.j3d.utils.pickfast</title>
+</head>
+<body>
+<p>Provides picking utility classes for the new core picking methods.</p>
+</body>
+</html>
diff --git a/src/classes/share/com/sun/j3d/utils/picking/behaviors/package.html b/src/classes/share/com/sun/j3d/utils/picking/behaviors/package.html
new file mode 100644
index 0000000..21ef9e7
--- /dev/null
+++ b/src/classes/share/com/sun/j3d/utils/picking/behaviors/package.html
@@ -0,0 +1,12 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <meta content="text/html; charset=ISO-8859-1"
+ http-equiv="content-type">
+ <title>com.sun.j3d.utils.picking.behaviors</title>
+</head>
+<body>
+<p><i>OBSOLETE</i>: provides picking behaviors for the old picking
+methods.</p>
+</body>
+</html>
diff --git a/src/classes/share/com/sun/j3d/utils/picking/package.html b/src/classes/share/com/sun/j3d/utils/picking/package.html
new file mode 100644
index 0000000..1b9d21b
--- /dev/null
+++ b/src/classes/share/com/sun/j3d/utils/picking/package.html
@@ -0,0 +1,12 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <meta content="text/html; charset=ISO-8859-1"
+ http-equiv="content-type">
+ <title>com.sun.j3d.utils.picking</title>
+</head>
+<body>
+<p><i>OBSOLETE</i>: provides picking utility classes for the old
+picking methods.</p>
+</body>
+</html>
diff --git a/src/classes/share/com/sun/j3d/utils/scenegraph/transparency/package.html b/src/classes/share/com/sun/j3d/utils/scenegraph/transparency/package.html
new file mode 100644
index 0000000..710fa54
--- /dev/null
+++ b/src/classes/share/com/sun/j3d/utils/scenegraph/transparency/package.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <meta content="text/html; charset=ISO-8859-1"
+ http-equiv="content-type">
+ <title>com.sun.j3d.utils.scenegraph.transparency</title>
+</head>
+<body>
+<p>Provides transparency sorting utility classes.</p>
+</body>
+</html>
diff --git a/src/classes/share/com/sun/j3d/utils/shader/package.html b/src/classes/share/com/sun/j3d/utils/shader/package.html
new file mode 100644
index 0000000..b5102d9
--- /dev/null
+++ b/src/classes/share/com/sun/j3d/utils/shader/package.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <meta content="text/html; charset=ISO-8859-1"
+ http-equiv="content-type">
+ <title>com.sun.j3d.utils.shader</title>
+</head>
+<body>
+<p>Provides shader utility classes.</p>
+</body>
+</html>
diff --git a/src/classes/share/com/sun/j3d/utils/timer/package.html b/src/classes/share/com/sun/j3d/utils/timer/package.html
index 4f90836..33e3b6b 100644
--- a/src/classes/share/com/sun/j3d/utils/timer/package.html
+++ b/src/classes/share/com/sun/j3d/utils/timer/package.html
@@ -1,57 +1,11 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
-
-<!--
-/*
- * $RCSfile$
- *
- * Copyright (c) 2005 Sun Microsystems, Inc. All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * - Redistribution of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
- * - Redistribution in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in
- * the documentation and/or other materials provided with the
- * distribution.
- *
- * Neither the name of Sun Microsystems, Inc. or the names of
- * contributors may be used to endorse or promote products derived
- * from this software without specific prior written permission.
- *
- * This software is provided "AS IS," without a warranty of any
- * kind. ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND
- * WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY
- * EXCLUDED. SUN MICROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL
- * NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF
- * USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS
- * DERIVATIVES. IN NO EVENT WILL SUN OR ITS LICENSORS BE LIABLE FOR
- * ANY LOST REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT, SPECIAL,
- * CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER CAUSED AND
- * REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF THE USE OF OR
- * INABILITY TO USE THIS SOFTWARE, EVEN IF SUN HAS BEEN ADVISED OF THE
- * POSSIBILITY OF SUCH DAMAGES.
- *
- * You acknowledge that this software is not designed, licensed or
- * intended for use in the design, construction, operation or
- * maintenance of any nuclear facility.
- *
- * $Revision$
- * $Date$
- * $State$
- */
- -->
-
-<HTML>
-<HEAD>
- <META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=iso-8859-1">
- <TITLE>com.sun.j3d.utils.timer</TITLE>
-</HEAD>
-<BODY>
-<P> A High Resolution operating system dependent interval timer.</P>
-</BODY>
-</HTML>
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <meta content="text/html; charset=ISO-8859-1"
+ http-equiv="content-type">
+ <title>com.sun.j3d.XXXXX</title>
+</head>
+<body>
+<p>Provides a high-resolution, operating-system-dependent interval timer.</p>
+</body>
+</html>
diff --git a/src/classes/share/com/sun/j3d/utils/universe/package.html b/src/classes/share/com/sun/j3d/utils/universe/package.html
new file mode 100644
index 0000000..1ef0eaf
--- /dev/null
+++ b/src/classes/share/com/sun/j3d/utils/universe/package.html
@@ -0,0 +1,12 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <meta content="text/html; charset=ISO-8859-1"
+ http-equiv="content-type">
+ <title>com.sun.j3d.utils.universe</title>
+</head>
+<body>
+<p>Provides utility classes for setting up the Java 3D universe,
+including the viewing configuration.</p>
+</body>
+</html>