edit documentation for extras

Author: peteroupc

demos/curves.html

@@ -161,7 +161,6 @@
   });
 })
 
-
   // Create the 3D scene; find the HTML canvas and pass it
   // to Scene3D.
   var scene=new Scene3D(document.getElementById("canvas"));

demos/demoutil.js

@@ -202,7 +202,6 @@ function pushSettings(updateMeshFunc,settings){
  updateShape(updateMeshFunc);
 };
 
-
    function makeMesh(func,resolutionU,resolutionV){
     // Default resolution is 50
     if(resolutionV==null)resolutionV=resolutionU

extras/camera.js

@@ -29,9 +29,16 @@ Perspective.prototype.update=function(){
 /**
 * A class for controlling the projection and
 * view of a 3D scene, in the nature of an abstract "camera".
+* <p>This class is considered a supplementary class to the
+* Public Domain HTML 3D Library and is not considered part of that
+* library. <p>
+* To use this class, you must include the script "extras/camera.js"; the
+ * class is not included in the "glutil_min.js" file which makes up
+ * the HTML 3D Library.  Example:<pre>
+ * &lt;script type="text/javascript" src="extras/camera.js">&lt;/script></pre>
 * @class
 * @alias Camera
-* @param {glutil.Scene} A 3D scene to associate with this
+* @param {glutil.Scene} scene A 3D scene to associate with this
 * camera object.
 * @param {number}  fov Vertical field of view, in degrees. Should be less
 * than 180 degrees. (The smaller

extras/curvetube.js

@@ -167,8 +167,15 @@ _FrenetFrames.prototype.getSampleAndBasisVectors=function(u){
 /**
 * Evaluator for a parametric surface in the form
 * of a tube extruded from a parametric curve.
+* <p>This class is considered a supplementary class to the
+* Public Domain HTML 3D Library and is not considered part of that
+* library. <p>
+* To use this class, you must include the script "extras/curvetube.js"; the
+ * class is not included in the "glutil_min.js" file which makes up
+ * the HTML 3D Library.  Example:<pre>
+ * &lt;script type="text/javascript" src="extras/curvetube.js">&lt;/script></pre>
 * @class
-* @alias glutil.CurveTube
+* @alias CurveTube
 * @param {Object} func An object that must contain a function
 * named "evaluate", which takes the following parameter:<ul>
 * <li><code>u</code> - A curve coordinate, generally from 0 to 1.
@@ -181,11 +188,11 @@ _FrenetFrames.prototype.getSampleAndBasisVectors=function(u){
 * @param {Object} [sweptCurve] Object describing
 * a two-dimensional curve to serve as the cross section of the extruded shape,
 * corresponding to the V coordinate of the CurveTube's
-* "evaluate" method. 
+* "evaluate" method.
 * If this parameter is null or omitted, uses a circular cross section
 * in which the V coordinate ranges from 0 through
 * 1.  The curve object must contain a function
-* named "evaluate", with the same meaning as for the "func" parameter, 
+* named "evaluate", with the same meaning as for the "func" parameter,
 * except the third element, if any, of the return value is ignored.<p>
 * The curve need not be closed.<p>
 * The cross section will generally have a radius of 1 unit; bigger

extras/evaluators.js

@@ -1,4 +1,3 @@
-
 /*
 Written by Peter O. in 2015.
 
@@ -10,6 +9,13 @@ at: http://upokecenter.dreamhosters.com/articles/donate-now-2/
 /**
 * Parametric evaluator for a surface of revolution, which results by revolving
 * an X/Y curve around an axis.
+* <p>This class is considered a supplementary class to the
+* Public Domain HTML 3D Library and is not considered part of that
+* library. <p>
+* To use this class, you must include the script "extras/evaluators.js"; the
+ * class is not included in the "glutil_min.js" file which makes up
+ * the HTML 3D Library.  Example:<pre>
+ * &lt;script type="text/javascript" src="extras/evaluators.js">&lt;/script></pre>
 * @class
 * @alias SurfaceOfRevolution
 * @param {Function} curve Curve to rotate about the Z-axis.
@@ -46,7 +52,7 @@ var SurfaceOfRevolution=function(curve,minval,maxval){
  }
 }
 /**
-* Creates a parametric evaluator for a surface of revolution 
+* Creates a parametric evaluator for a surface of revolution
 * whose curve is the graph of a single-variable function.
 * @param {Function} func Function whose graph will be
 * rotated about the Z-axis.  The function takes a number
@@ -101,12 +107,19 @@ SurfaceOfRevolution.torus=function(outerRadius,innerRadius,curve){
 * Parametric evaluator for a
 * curve drawn by a circle that rolls along the inside
 * of another circle, whose position is fixed.
+* <p>This class is considered a supplementary class to the
+* Public Domain HTML 3D Library and is not considered part of that
+* library. <p>
+* To use this class, you must include the script "extras/evaluators.js"; the
+ * class is not included in the "glutil_min.js" file which makes up
+ * the HTML 3D Library.  Example:<pre>
+ * &lt;script type="text/javascript" src="extras/evaluators.js">&lt;/script></pre>
 * @class
 * @param {number} outerRadius Radius of the circle whose position
 * is fixed.
 * @param {number} innerRadius Radius of the rolling circle.
 * A hypocycloid results when outerRadius=innerRadius.
-* @param {number} innerRadius Distance from the center of the
+* @param {number} distFromInnerCenter Distance from the center of the
 * rolling circle to the drawing pen.
 */
 function Hypotrochoid(outerRadius, innerRadius, distFromInnerCenter){
@@ -157,6 +170,22 @@ function Hypotrochoid(outerRadius, innerRadius, distFromInnerCenter){
    this.distFromInner*ratio);
  }
 }
+
+/**
+* Parametric evaluator for a
+* curve drawn by a circle that rolls along the X-axis.
+* <p>This class is considered a supplementary class to the
+* Public Domain HTML 3D Library and is not considered part of that
+* library. <p>
+* To use this class, you must include the script "extras/evaluators.js"; the
+ * class is not included in the "glutil_min.js" file which makes up
+ * the HTML 3D Library.  Example:<pre>
+ * &lt;script type="text/javascript" src="extras/evaluators.js">&lt;/script></pre>
+* @class
+* @param {number} radius Radius of the rolling circle.
+* @param {number} distFromCenter Distance from the center of the
+* rolling circle to the drawing pen.
+*/
 function Trochoid(radius, distFromCenter){
  this.inner=radius;
  this.distFromCenter=distFromCenter;
@@ -184,12 +213,19 @@ function Trochoid(radius, distFromCenter){
 * Parametric evaluator for a
 * curve drawn by a circle that rolls along the outside
 * of another circle, whose position is fixed.
+* <p>This class is considered a supplementary class to the
+* Public Domain HTML 3D Library and is not considered part of that
+* library. <p>
+* To use this class, you must include the script "extras/evaluators.js"; the
+ * class is not included in the "glutil_min.js" file which makes up
+ * the HTML 3D Library.  Example:<pre>
+ * &lt;script type="text/javascript" src="extras/evaluators.js">&lt;/script></pre>
 * @class
 * @param {number} outerRadius Radius of the circle whose position
 * is fixed.
 * @param {number} innerRadius Radius of the rolling circle.
 * An epicycloid results when outerRadius=innerRadius.
-* @param {number} innerRadius Distance from the center of the
+* @param {number} distFromInnerCenter Distance from the center of the
 * rolling circle to the drawing pen.
 */
 function Epitrochoid(outerRadius, innerRadius, distFromInnerCenter){

extras/matrixstack.js

@@ -21,6 +21,13 @@ MatrixStack is a class that implements a stack
 of 4x4 transformation matrices.<p>
 When the constructor is called, it will create a stack whose
 only element is the identity matrix.
+* <p>This class is considered a supplementary class to the
+* Public Domain HTML 3D Library and is not considered part of that
+* library. <p>
+* To use this class, you must include the script "extras/matrixstack.js"; the
+ * class is not included in the "glutil_min.js" file which makes up
+ * the HTML 3D Library.  Example:<pre>
+ * &lt;script type="text/javascript" src="extras/matrixstack.js">&lt;/script></pre>
  @alias MatrixStack
  @class
  */

extras/objmtl.js

@@ -8,10 +8,13 @@ at: http://upokecenter.dreamhosters.com/articles/donate-now-2/
 */
 /**
 OBJ file.<p>
- * To use this class, you must include the script "objmtl.js"; the
+* <p>This class is considered a supplementary class to the
+* Public Domain HTML 3D Library and is not considered part of that
+* library. <p>
+* To use this class, you must include the script "extras/objmtl.js"; the
  * class is not included in the "glutil_min.js" file which makes up
  * the HTML 3D Library.  Example:<pre>
- * &lt;script type="text/javascript" src="glutil_min.js">&lt;/script></pre>
+ * &lt;script type="text/javascript" src="extras/objmtl.js">&lt;/script></pre>
 @class */
 function ObjData(){
   /** URL of the OBJ file */

extras/stl.js

@@ -14,10 +14,13 @@ if(!GLUtil){
 var StlData={};
 /**
 * Loads a .STL file asynchronously.
-* To use this class, you must include the script "stl.js"; the
+* <p>This method is considered a supplementary method to the
+* Public Domain HTML 3D Library and is not considered part of that
+* library. <p>
+* To use this method, you must include the script "extras/stl.js"; the
  * class is not included in the "glutil_min.js" file which makes up
  * the HTML 3D Library.  Example:<pre>
- * &lt;script type="text/javascript" src="stl.js">&lt;/script></pre>
+ * &lt;script type="text/javascript" src="extras/stl.js">&lt;/script></pre>
 @alias glutil.GLUtil.loadStlFromUrl
 @param {string} url The URL to load.
 @return {Promise} A promise that: