Address more TODOs; etc.

Author: peteroupc

demos/bsp.js

@@ -263,8 +263,8 @@ BspTree.prototype._clipInternal = function(polygons) {
   return ret;
 };
 /**
- * TODO: Not documented yet.
- * @param {*} node
+ * Clips the solid areas of another BSP tree out of this one.
+ * @param {BspTree} node Another BSP tree.
  * @returns {BspTree} This object.
  * @memberof! BspTree#
  */
@@ -316,8 +316,9 @@ BspTree.prototype._clipflip2 = function(other) {
   return this;
 };
 /**
- * TODO: Not documented yet.
- * @param {*} other
+ * Generates a BSP tree that consists of the solid areas of
+ * this tree or the given tree or both.
+ * @param {BspTree} other The second BSP tree.
  * @returns {BspTree} The resulting tree.
  * @memberof! BspTree#
  */
@@ -330,8 +331,9 @@ BspTree.prototype.union = function(other) {
         otherBsp._clipflip2(thisBsp).getPolygons()));
 };
 /**
- * TODO: Not documented yet.
- * @param {*} other
+ * Generates a BSP tree that consists of the solid areas of
+ * this tree that are not common to the given tree.
+ * @param {BspTree} other The second BSP tree.
  * @returns {BspTree} The resulting tree.
  * @memberof! BspTree#
  */
@@ -344,8 +346,9 @@ BspTree.prototype.difference = function(other) {
          otherBsp._clipflip2(thisBsp).getPolygons())).flip();
 };
 /**
- * TODO: Not documented yet.
- * @param {*} other
+ * Generates a BSP tree that consists of the solid areas common
+ * to both this tree and the given tree.
+ * @param {BspTree} other The second BSP tree.
  * @returns {BspTree} The resulting tree.
  * @memberof! BspTree#
  */
@@ -358,8 +361,9 @@ BspTree.prototype.intersection = function(other) {
          otherBsp.getPolygons())).flip();
 };
 /**
- * TODO: Not documented yet.
- * @param {*} other
+ * Generates a BSP tree that consists of the solid areas of
+ * this tree or the given tree but not both.
+ * @param {BspTree} other The second BSP tree.
  * @returns {BspTree} The resulting tree.
  * @memberof! BspTree#
  */

demos/gears.html

@@ -34,7 +34,7 @@
   mesh.mode(H3DU.Mesh.QUAD_STRIP );
   var angleStep = H3DU.Math.PiTimes2 / teeth;
   var cosStep = Math.cos(angleStep);
-  var sinStep = (angleStep>=0 && angleStep<6.283185307179586) ? (angleStep<=3.141592653589793 ? Math.sqrt(1.0-cosStep*cosStep) : -Math.sqrt(1.0-cosStep*cosStep)) : Math.sin(angleStep);
+  var sinStep = angleStep >= 0 && angleStep < 6.283185307179586 ? angleStep <= 3.141592653589793 ? Math.sqrt(1.0 - cosStep * cosStep) : -Math.sqrt(1.0 - cosStep * cosStep) : Math.sin(angleStep);
   sinAngle = 0.0; // sin(0.0deg)
   cosAngle = 1.0; // cos(0.0deg)
   for(i = 0; i <= teeth; i++) {
@@ -55,7 +55,7 @@
   da = 2.0 * Math.PI / teeth / 4.0;
   angleStep = H3DU.Math.PiTimes2 / teeth;
   cosStep = Math.cos(angleStep);
-  sinStep = (angleStep>=0 && angleStep<6.283185307179586) ? (angleStep<=3.141592653589793 ? Math.sqrt(1.0-cosStep*cosStep) : -Math.sqrt(1.0-cosStep*cosStep)) : Math.sin(angleStep);
+  sinStep = angleStep >= 0 && angleStep < 6.283185307179586 ? angleStep <= 3.141592653589793 ? Math.sqrt(1.0 - cosStep * cosStep) : -Math.sqrt(1.0 - cosStep * cosStep) : Math.sin(angleStep);
   sinAngle = 0.0; // sin(0.0deg)
   cosAngle = 1.0; // cos(0.0deg)
   for(i = 0; i < teeth; i++) {

demos/picking.js

@@ -73,6 +73,27 @@ function getIntersectionRayBox(ray, box) {
   ];
 }
 
+/* exported polygonToPlane */
+function polygonToPlane(polygon) {
+  "use strict";
+  if(polygon.length < 3) {
+    return [0, 0, 0, 0, 0, 0];
+  }
+  var normal = H3DU.Math.vec3cross(polygon[0], polygon[1]);
+  var centroid = H3DU.Math.vec3copy(polygon[0]);
+  for(var i = 1; i < polygon.length; i++) {
+    var nextIndex = i + 1 === polygon.length ? 0 : i + 1;
+    H3DU.Math.vec3addInPlace(normal,
+       H3DU.Math.vec3cross(polygon[i], polygon[nextIndex]));
+    H3DU.Math.vec3addInPlace(centroid, polygon[i]);
+  }
+  H3DU.Math.vec3scaleInPlace(centroid, 1.0 / polygon.length);
+  var plane = [
+    normal[0], normal[1], normal[2],
+    centroid[0], centroid[1], centroid[2]];
+  return plane;
+}
+
 function triangleToPlane(face) {
   "use strict";
   var ac = H3DU.Math.vec3sub(face[0], face[2]);

doc/H3DU.CubeMap.md

@@ -5,12 +5,12 @@
  <a name='H3DU.CubeMap'></a>
 ### H3DU.CubeMap(name)
 
-TODO: Not documented yet.
+A cube map, or a set of six textures forming the sides of a cube.
 
 #### Parameters
 
-* `name` (Type: Array.&lt;(String|Texture)>)<br>
-    An array of six elements, each of which is a URL of the texture data or the texture object itself. However, this constructor will not load those images yet. The six images are, in order, the image seen when looking toward the positive X axis, the negative X axis, positive Y, negative Y, positive Z, and negative Z.
+* `name` (Type: Array.&lt;(String|Texture|TextureInfo)>)<br>
+    An array of six elements, each of which is a URL of the texture data or the texture object itself. However, this constructor will not load those images yet. The six texture are, in order, the texture seen when looking toward the positive X axis, the negative X axis, positive Y, negative Y, positive Z, and negative Z.
 
 ### Methods
 
@@ -62,8 +62,8 @@ Sets a texture used by this cube map.
 
 * `index` (Type: Number)<br>
     Texture index to set, from 0 through 5.
-* `texture` (Type: <a href="H3DU.Texture.md">H3DU.Texture</a> | String)<br>
-    An <a href="H3DU.Texture.md">H3DU.Texture</a> object or a string with the URL of the texture data.
+* `texture` (Type: <a href="H3DU.Texture.md">H3DU.Texture</a> | <a href="H3DU.TextureInfo.md">H3DU.TextureInfo</a> | String)<br>
+    An <a href="H3DU.Texture.md">H3DU.Texture</a> object, a texture information object, or a string with the URL of the texture data.
 
 #### Return Value
 

doc/H3DU.MeshBuffer.md

@@ -25,7 +25,7 @@ and points) composed by all shapes in this mesh.
 mesh buffer (or sets an
 existing attribute's information).
 * [setIndices](#H3DU.MeshBuffer_H3DU.MeshBuffer_setIndices)<br>Sets the array of vertex indices used by this mesh buffer.
-* [setPrimitiveType](#H3DU.MeshBuffer_H3DU.MeshBuffer_setPrimitiveType)<br>TODO: Not documented yet.
+* [setPrimitiveType](#H3DU.MeshBuffer_H3DU.MeshBuffer_setPrimitiveType)<br>Sets the type of graphics primitives stored in this mesh buffer.
 * [vertexCount](#H3DU.MeshBuffer_H3DU.MeshBuffer_vertexCount)<br>Gets the number of vertices in this mesh buffer
 
  <a name='H3DU.MeshBuffer_H3DU.MeshBuffer_getBounds'></a>
@@ -128,15 +128,16 @@ This object. (Type: <a href="H3DU.MeshBuffer.md">H3DU.MeshBuffer</a>)
  <a name='H3DU.MeshBuffer_H3DU.MeshBuffer_setPrimitiveType'></a>
 ### H3DU.MeshBuffer#setPrimitiveType(primType)
 
-TODO: Not documented yet.
+Sets the type of graphics primitives stored in this mesh buffer.
 
 #### Parameters
 
-* `primType` (Type: *)
+* `primType` (Type: Number)<br>
+    The primitive type, either <a href="H3DU.Mesh.md#H3DU.Mesh.TRIANGLES">H3DU.Mesh.TRIANGLES</a>, <a href="H3DU.Mesh.md#H3DU.Mesh.LINES">H3DU.Mesh.LINES</a>, or <a href="H3DU.Mesh.md#H3DU.Mesh.POINTS">H3DU.Mesh.POINTS</a>.
 
 #### Return Value
 
-Return value. (Type: *)
+This object. (Type: <a href="H3DU.MeshBuffer.md">H3DU.MeshBuffer</a>)
 
  <a name='H3DU.MeshBuffer_H3DU.MeshBuffer_vertexCount'></a>
 ### H3DU.MeshBuffer#vertexCount()

doc/H3DU.TextureLoader.md

@@ -15,7 +15,7 @@ to WebGL contexts.
 * [loadAndMapTexture](#H3DU.TextureLoader_H3DU.TextureLoader_loadAndMapTexture)<br>Loads the texture referred to in an array of URLs and
 uploads its texture data to a WebGL context.
 * [loadAndMapTexturesAll](#H3DU.TextureLoader_H3DU.TextureLoader_loadAndMapTexturesAll)<br>Loads one or more textures by their URL and uploads their data to a WebGL context.
-* [loadCubeMap](#H3DU.TextureLoader_H3DU.TextureLoader_loadCubeMap)<br>TODO: Not documented yet.
+* [loadCubeMap](#H3DU.TextureLoader_H3DU.TextureLoader_loadCubeMap)<br>Loads the textures described in a cube map.
 * [loadTexture](#H3DU.TextureLoader_H3DU.TextureLoader_loadTexture)<br>Loads a texture by its URL and stores its data.
 * [loadTexturesAll](#H3DU.TextureLoader_H3DU.TextureLoader_loadTexturesAll)<br>Loads the textures referred to in an array of URLs and
 stores their texture data.
@@ -89,12 +89,12 @@ resolves, each item in the resulting array will be a loaded
  <a name='H3DU.TextureLoader_H3DU.TextureLoader_loadCubeMap'></a>
 ### H3DU.TextureLoader#loadCubeMap(texturesOrCubeMap, [resolve], [reject])
 
-TODO: Not documented yet.
+Loads the textures described in a cube map.
 
 #### Parameters
 
 * `texturesOrCubeMap` (Type: Array.&lt;(String|<a href="H3DU.TextureInfo.md">H3DU.TextureInfo</a>|<a href="H3DU.Texture.md">H3DU.Texture</a>)> | <a href="H3DU.CubeMap.md">H3DU.CubeMap</a>)<br>
-    TODO: Not documented yet
+    Either an array of objects described in H3DU.TextureLoader.loadTexture or a cube map object.
 * `resolve` (Type: function) (optional)<br>
     A function called as each individual texture is loaded and its promise resolves.
 * `reject` (Type: function) (optional)<br>

doc/index.md

@@ -5,6 +5,7 @@
 * <a href="Epitrochoid.md">Epitrochoid</a><br><b>Deprecated: Use <a href="H3DU.Epitrochoid.md">H3DU.Epitrochoid</a> instead.</b>
 * <a href="FrameCounter.md">FrameCounter</a><br><b>Deprecated: Use <a href="H3DU.FrameCounter.md">H3DU.FrameCounter</a> instead.</b>
 * <a href="FrameCounterDiv.md">FrameCounterDiv</a><br><b>Deprecated: Use <a href="H3DU.FrameCounterDiv.md">H3DU.FrameCounterDiv</a> instead.</b>
+* <a href="GraphicsPath.md">GraphicsPath</a><br><b>Deprecated: Use <a href="H3DU.GraphicsPath.md">H3DU.GraphicsPath</a> instead.</b>
 * <a href="H3DU.md">H3DU</a><br>The Public Domain HTML 3D Library contains classes and utility
 methods to ease the development of HTML 3D applications, such
 as Web sites, in browsers that support 3D drawing using the HTML5 Canvas.
@@ -18,7 +19,7 @@ Use the <a href="H3DU.MeshBuffer.md">H3DU.MeshBuffer</a> class instead, which is
 contexts.</b>
 * <a href="H3DU.Camera.md">H3DU.Camera</a><br>A class for controlling the projection and
 view of a 3D scene, in the nature of an abstract "camera".
-* <a href="H3DU.CubeMap.md">H3DU.CubeMap</a><br>TODO: Not documented yet.
+* <a href="H3DU.CubeMap.md">H3DU.CubeMap</a><br>A cube map, or a set of six textures forming the sides of a cube.
 * <a href="H3DU.CurveEval.md">H3DU.CurveEval</a><br>An evaluator of parametric curve functions for generating
 vertex positions and colors of a curve.
 * <a href="H3DU.CurveTube.md">H3DU.CurveTube</a><br>Evaluator for a parametric surface in the form
@@ -32,6 +33,7 @@ contexts.</b>
 * <a href="H3DU.FrameBufferInfo.md">H3DU.FrameBufferInfo</a><br>Describes a frame buffer.
 * <a href="H3DU.FrameCounter.md">H3DU.FrameCounter</a><br>A class for finding the frame rate of an HTML rendering.
 * <a href="H3DU.FrameCounterDiv.md">H3DU.FrameCounterDiv</a><br>A class that displays a frame counter HTML element.
+* <a href="H3DU.GraphicsPath.md">H3DU.GraphicsPath</a><br>Represents a two-dimensional path.
 * <a href="H3DU.Hypotrochoid.md">H3DU.Hypotrochoid</a><br>Parametric evaluator for a
 curve drawn by a circle that rolls along the inside
 of another circle, whose position is fixed with a center of (0,0).

doc/tutorial-history.md

@@ -32,7 +32,7 @@ There are many, many changes to version 2.0.0-beta1 from version 1.5.1. Here are
 - The experimental 2D canvas renderer in _surfaces2d.html_, was abandoned.
 - Added `dispose` method to `H3DU.Scene3D`.
 - Added `createPointedStar` and `createLathe` methods to `H3DU.Meshes`.
-- Added `getBounds` and `toLinePath` methods to H3DU.GraphicsPath, an extra, as well
+- Added `getBounds` and `toLinePath` methods to <a href="H3DU.GraphicsPath.md">H3DU.GraphicsPath</a>, an extra, as well
  as an extra that adds methods that compute the intersection, difference, union, and XOR of two
  polygons. Path triangulation now supports polygons with holes.
 - The default light configuration is no lights when creating a <a href="H3DU.LightSource.md">H3DU.LightSource</a>. The exception, for compatibility purposes, is when using a <a href="H3DU.Scene3D.md">H3DU.Scene3D</a> without rendering a custom `Batch3D`, in which case the default is one light source with its default values.

doc/tutorial-overview.md

@@ -394,7 +394,7 @@ Version 2.0.0-beta1:
 - The experimental 2D canvas renderer in _surfaces2d.html_, was abandoned.
 - Added `dispose` method to `H3DU.Scene3D`.
 - Added `createPointedStar` and `createLathe` methods to `H3DU.Meshes`.
-- Added `getBounds` and `toLinePath` methods to H3DU.GraphicsPath, an extra, as well
+- Added `getBounds` and `toLinePath` methods to <a href="H3DU.GraphicsPath.md">H3DU.GraphicsPath</a>, an extra, as well
  as an extra that adds methods that compute the intersection, difference, union, and XOR of two
  polygons. Path triangulation now supports polygons with holes.
 - The default light configuration is no lights when creating a <a href="H3DU.LightSource.md">H3DU.LightSource</a>. The exception, for compatibility purposes, is when using a <a href="H3DU.Scene3D.md">H3DU.Scene3D</a> without rendering a custom `Batch3D`, in which case the default is one light source with its default values.

doc/tutorial-paths.md

@@ -25,7 +25,7 @@ as well as closed figures made from several path segments.
 <a id=How_to_Use></a>
 ## How to Use
 
-2D paths are implemented in a class called `H3DU.GraphicsPath`, found in the file _extras/path.js_ in
+2D paths are implemented in a class called <a href="H3DU.GraphicsPath.md">`H3DU.GraphicsPath`</a>, found in the file _extras/path.js_ in
 the HTML 3D Library download.  To use this class, you must include the script "extras/path.js",
 as in this example.
 
@@ -56,7 +56,7 @@ lines, the "Q", "C", "S", and "T" commands create B&eacute;zier curves, the "A"
 creates elliptical arcs, and the "Z" command closes the path. If the letters are
 lower-cased, X and Y coordinates are relative to the current position.
 
-For more information, see the H3DU.GraphicsPath.fromString method documentation.
+For more information, see the <a href="H3DU.GraphicsPath.md#H3DU.GraphicsPath.fromString">H3DU.GraphicsPath.fromString</a> method documentation.
 That method is also how you create a 2D path from an SVG path string, as in this
 example: