move some Extras classes to the H3DU namespace; disallow H3DU.Texture in H3DU.Shape setMaterial method; add descriptions to doc summaries

Author: peteroupc

build/publish.js

@@ -66,15 +66,16 @@ function Doc(name) {
   this.methods = {};
   this.events = {};
   this.members = {};
+  this.descriptions = {};
   this.name = name;
   this.getFileName = function() {
     return path.join(Doc.outputDir,
          Doc.typeToName(this.name));
   };
-  this.getText = function() {
+  this.getText = function(docs) {
     var entry = this.entry + this.constructorEntry;
     var keys;
-    function memToIndex(mem, title) {
+    function memToIndex(mem, title, docs) {
       if(Object.keys(mem).length > 0) {
         var indexStr = "### " + helper.htmlsafe(title) + "\n\n";
         Object.keys(mem).sort().forEach(function(name) {
@@ -83,16 +84,20 @@ function Doc(name) {
           if(hname.lastIndexOf("#") >= 0)
             hname = hname.substr(hname.lastIndexOf("#") + 1);
           var tname = "[" + helper.htmlsafe(hname) + "](#" + val[1] + ")";
+          var tdesc = docs.descriptions[val[2]];
+          if(tdesc) {
+            tname += "<br>" + tdesc;
+          }
           indexStr += "* " + tname + "\n";
         });
         return indexStr + "\n";
       } else {
         return "";
       }
     }
-    entry += memToIndex(this.members, "Members");
-    entry += memToIndex(this.events, "Events");
-    entry += memToIndex(this.methods, "Methods");
+    entry += memToIndex(this.members, "Members", docs);
+    entry += memToIndex(this.events, "Events", docs);
+    entry += memToIndex(this.methods, "Methods", docs);
     keys = Object.keys(this.members).sort();
     for(var i = 0;i < keys.length;i++) {
       entry += this.members[keys[i]][0];
@@ -133,13 +138,13 @@ function DocCollection() {
     return this.docs[parent];
   };
   this.addMethod = function(parent, name, entry, longname) {
-    this.get(parent).methods[name] = [entry, Doc.toHash(longname)];
+    this.get(parent).methods[name] = [entry, Doc.toHash(longname), longname];
   };
   this.addEvent = function(parent, name, entry, longname) {
-    this.get(parent).events[name] = [entry, Doc.toHash(longname)];
+    this.get(parent).events[name] = [entry, Doc.toHash(longname), longname];
   };
   this.addMember = function(parent, name, entry, longname) {
-    this.get(parent).members[name] = [entry, Doc.toHash(longname)];
+    this.get(parent).members[name] = [entry, Doc.toHash(longname), longname];
   };
   this.addConstructor = function(parent, entry) {
     this.get(parent).constructorEntry = entry;
@@ -152,13 +157,17 @@ function DocCollection() {
      // Write individual type files
     Object.keys(this.docs).forEach(function(doc) {
       fs.writeFileSync(that.docs[doc].getFileName(),
-         normalizeLines(that.docs[doc].getText()), "utf8");
+         normalizeLines(that.docs[doc].getText(that)), "utf8");
     });
     // Write index
     var indexStr = "# Documentation Index\n\n";
     Object.keys(this.typeNames).sort().forEach(function(name) {
       var tname = name;
       tname = helper.linkto(tname, helper.htmlsafe(tname));
+      var tdesc = that.descriptions[name];
+      if(tdesc) {
+        tname += "<br>" + tdesc;
+      }
       indexStr += "* " + tname + "\n";
     });
     indexStr += "\n";
@@ -226,6 +235,37 @@ function typeNames(nodes) {
   return names;
 }
 
+function descriptions(nodes) {
+  "use strict";
+  var descriptions = {};
+  nodes.forEach(function (node) {
+    if(node.undocumented === true)return;
+    if(node.access === "private") {
+      return;
+    }
+    var desc = "";
+    if(typeof node.deprecated !== "undefined" && node.deprecated !== null) {
+      var dep = node.deprecated === true ? "Yes" : node.deprecated;
+      desc = "<b>Deprecated: " + normspace(dep) + "</b>";
+    } else if(node.kind === "class") {
+      desc = normspace(node.classdesc || "") + " ";
+      desc += normspace(node.description || "");
+   // We only need the first "sentence" of the description
+      desc = desc.replace(/\.\s+[\s\S]*$/, ".");
+    } else {
+      desc = normspace(node.description || "");
+        // We only need the first "sentence" of the description
+      desc = desc.replace(/\.\s+[\s\S]*$/, ".");
+    }
+    desc = desc.replace(/^\s+/, "");
+    desc = desc.replace(/\s+$/, "");
+    if(desc.length > 0) {
+      descriptions[node.longname] = desc;
+    }
+  });
+  return descriptions;
+}
+
 function registerLinks(docCollection, nodes) {
   "use strict";
   nodes.forEach(function(node) {
@@ -402,14 +442,13 @@ function fillCollection(docCollection, nodes, parentlong) {
 exports.publish = function(input, o, t) {
   "use strict";
   helper.fileExtension = ".md";
-  console.log(Object.keys(t));
   helper.setTutorials(t);
   var inputget = input().get();
   var docCollection = new DocCollection();
   docCollection.tutorials = t;
   docCollection.readme = o.readme;
+  docCollection.descriptions = descriptions(inputget);
   docCollection.typeNames = typeNames(inputget);
-  console.log(o.readme);
   registerLinks(docCollection, inputget);
   fillCollection(docCollection, inputget);
   docCollection.write();

demos/builtinshapes.html

@@ -28,7 +28,7 @@
 </p>
 <canvas id=canvas></canvas>
 <script id="demo">
-/* global Camera, FrameCounterDiv, H3DU, InputTracker */
+/* global FrameCounterDiv, H3DU */
 // <!--
 /*
 Written by Peter O. in 2015.
@@ -81,8 +81,8 @@
 var scene = new H3DU.Scene3D(document.getElementById("canvas"))
    .setClearColor("white");
 sub = new H3DU.Batch3D();
-var input = new InputTracker(document);
-var camera = new Camera(sub, 45, 1, 1000).setDistance(5)
+var input = new H3DU.InputTracker(document);
+var camera = new H3DU.Camera(sub, 45, 1, 1000).setDistance(5)
     .moveAngleVertical(-90);
 var xyz = new H3DU.ShapeGroup();
 var pc = new FrameCounterDiv();

demos/clock.html

@@ -16,7 +16,7 @@
 </p>
 <canvas id=canvas></canvas>
 <script id="demo">
-/* global Camera, FrameCounterDiv, H3DU, InputTracker */
+/* global FrameCounterDiv, H3DU */
 // <!--
 /*
 Written by Peter O. in 2015.
@@ -117,8 +117,8 @@
    .setClearColor("white")
    .cullFace(H3DU.Scene3D.BACK);
 var sub = new H3DU.Batch3D();
-var camera = new Camera(sub, 45, 1, 1000).setDistance(5);
-var input = new InputTracker(scene.getCanvas());
+var camera = new H3DU.Camera(sub, 45, 1, 1000).setDistance(5);
+var input = new H3DU.InputTracker(scene.getCanvas());
 var pc = new FrameCounterDiv();
 var clock = new ClockShape(sub);
 document.getElementById("colorsetting").addEventListener("change",

demos/curves.html

@@ -19,7 +19,7 @@
 <canvas id=canvas>
 </canvas>
 <script id="demo">
-/* global Camera, Epitrochoid, FrameCounterDiv, H3DU, Hypotrochoid, InputTracker, Trochoid, addLink, makeMesh, pushSettings */
+/* global FrameCounterDiv, H3DU, addLink, makeMesh, pushSettings */
 // <!--
 /*
 Written by Peter O. in 2015.
@@ -30,26 +30,6 @@
 at: http://peteroupc.github.io/
 */
 
-/*
-var Hypocycloid = {
-  "create":function(outerRadius, innerRadius) {
-    "use strict";
-    return new Hypotrochoid(outerRadius, innerRadius, innerRadius);
-  }
-};
-var Epicycloid = {
-  "create":function(outerRadius, innerRadius) {
-    "use strict";
-    return new Epitrochoid(outerRadius, innerRadius, innerRadius);
-  }
-};
-var HypocycloidSeal={create:function(radius,points) {
- return Hypocycloid.create(radius,radius/points);
-}}
-var EpicycloidSeal={create:function(radius,points) {
- return Epicycloid.create(radius,radius/points);
-}}
-*/
 var allsettings = {};
 function TorusKnot(p, q, outerRadius, innerRadius) {
   "use strict";
@@ -136,7 +116,7 @@
   "use strict";
   pushSettings(allsettings, function(allsettings) {
     return makeThinCurveMesh(
-    new Hypotrochoid(
+    new H3DU.Hypotrochoid(
       allsettings["ht-outer"],
       allsettings["ht-inner"],
       allsettings["ht-dist"]
@@ -152,7 +132,7 @@
   "use strict";
   pushSettings(allsettings, function(allsettings) {
     return makeThinCurveMesh(
-    new Epitrochoid(
+    new H3DU.Epitrochoid(
       allsettings["et-outer"],
       allsettings["et-inner"],
       allsettings["et-dist"]
@@ -168,7 +148,7 @@
   "use strict";
   pushSettings(allsettings, function(allsettings) {
     return makeThinCurveMesh(
-    new Trochoid(
+    new H3DU.Trochoid(
       allsettings["et-inner"],
       allsettings["et-dist"]
     ));
@@ -181,10 +161,10 @@
   // Create the 3D scene; find the HTML canvas and pass it
   // to Scene3D.
 var scene = new H3DU.Scene3D(document.getElementById("canvas"));
-var input = new InputTracker(document);
+var input = new H3DU.InputTracker(document);
 scene.setClearColor("white");
 var sub = new H3DU.Batch3D();
-var camera = new Camera(sub, 45, 1, 100);
+var camera = new H3DU.Camera(sub, 45, 1, 100);
 camera.setDistance(5);
 var pc = new FrameCounterDiv();
 link0();

demos/curvesexpr.html

@@ -37,7 +37,7 @@
 </div>
 <canvas id=canvas></canvas>
 <script id="demo">
-/* global Camera, FrameCounterDiv, H3DU, InputTracker, addRange, getExpression, updateShape */
+/* global FrameCounterDiv, H3DU, addRange, getExpression, updateShape */
 // <!--
 /*
 Written by Peter O. in 2015.
@@ -230,11 +230,11 @@
   // Create the 3D scene; find the HTML canvas and pass it
   // to Scene3D.
 var scene = new H3DU.Scene3D(document.getElementById("canvas"));
-var input = new InputTracker(document);
+var input = new H3DU.InputTracker(document);
 scene.setClearColor("white");
 scene.cullFace(H3DU.Scene3D.FRONT);
 var sub = new H3DU.Batch3D();
-var camera = new Camera(sub, 45, 1, 100).setDistance(5);
+var camera = new H3DU.Camera(sub, 45, 1, 100).setDistance(5);
 var pc = new FrameCounterDiv();
 link0();
 sub.addShape(shapeGroup);

demos/implicit.html

@@ -16,7 +16,7 @@
 <div id="settings" style="position:absolute;left:0;top:3em"></div>
 <canvas id=canvas></canvas>
 <script id="demo">
-/* global Camera, FrameCounterDiv, H3DU, ImplicitSurface, InputTracker, addLink, input, pushSettings */
+/* global FrameCounterDiv, H3DU, ImplicitSurface, addLink, input, pushSettings */
 // <!--
 /*
 Written by Peter O. in 2015.
@@ -222,10 +222,10 @@
   // Create the 3D scene; find the HTML canvas and pass it
   // to Scene3D.
   var scene = new H3DU.Scene3D(document.getElementById("canvas"));
-  var input = new InputTracker(document);
+  var input = new H3DU.InputTracker(document);
   scene.setClearColor("white");
   var sub = new H3DU.Batch3D();
-  var camera = new Camera(sub, 45, 1, 100);
+  var camera = new H3DU.Camera(sub, 45, 1, 100);
   camera.setDistance(5);
   var pc = new FrameCounterDiv();
   link1();

demos/marchingdots.html

@@ -12,7 +12,7 @@
 <body>
 <canvas id=canvas></canvas>
 <script id="demo">
-/* global FrameCounterDiv, GraphicsPath, H3DU */
+/* global FrameCounterDiv, H3DU */
 // <!--
 /*
 Written by Peter O. in 2015.
@@ -25,7 +25,7 @@
 
 // Path taken from a public domain SVG icon, which was
 // created by Jakub Steiner
-var path = GraphicsPath.fromString(
+var path = H3DU.GraphicsPath.fromString(
 "M 44.155643,23.75 C 44.155643,45.413332 45.663332,43.905643 24,43.905643 2.3366679,43.905643 3.8443565,45.413332 3.8443565,23.75 3.8443565,2.0866679 2.3366679,3.5943565 24,3.5943565 c 21.663332,0 20.155643,-1.5076886 20.155643,20.1556435 z"
 );
 var curves = path.getCurves(0.2);

demos/obj.html

@@ -18,7 +18,7 @@
 Spot, a public domain model from Keenan Clark<br>
 </div>
 <script id="demo">
-/* global Camera, H3DU, InputTracker, ObjData, addLink */
+/* global H3DU, ObjData, addLink */
 // <!--
 /*
 Written by Peter O. in 2015.
@@ -35,8 +35,8 @@
   scene.setClearColor("white");
   var sub = new H3DU.Batch3D();
   var loader = new H3DU.TextureLoader();
-  var camera = new Camera(sub, 45, 1, 1000).setDistance(5);
-  var input = new InputTracker(document);
+  var camera = new H3DU.Camera(sub, 45, 1, 1000).setDistance(5);
+  var input = new H3DU.InputTracker(document);
   var startfunc = null;
   var shape = null;
   addLink("Toboggan", startfunc = function() {

demos/pathshapes.html

@@ -23,7 +23,7 @@
 </p>
 <canvas id=canvas></canvas>
 <script id="demo">
-/* global Camera, CurveTube, FrameCounterDiv, GraphicsPath, H3DU, InputTracker */
+/* global CurveTube, FrameCounterDiv, H3DU */
 // <!--
 /*
 Written by Peter O. in 2015.
@@ -35,7 +35,7 @@
 */
 
 // Make a polygon with a hole
-var path = new GraphicsPath()
+var path = new H3DU.GraphicsPath()
  .moveTo(-1, 1, 0)
  .lineTo(0, 1)
  .arcTo(1, 1, 1, 0, 1)
@@ -138,9 +138,9 @@
 var scene = new H3DU.Scene3D(document.getElementById("canvas"));
 scene.setClearColor("white");
 sub = new H3DU.Batch3D();
-var camera = new Camera(sub, 45, 1, 1000).setDistance(5)
+var camera = new H3DU.Camera(sub, 45, 1, 1000).setDistance(5)
    .moveAngleVertical(-90);
-var input = new InputTracker(document);
+var input = new H3DU.InputTracker(document);
 var xyz = new H3DU.ShapeGroup();
 var pc = new FrameCounterDiv();
 shape = null;

demos/pathtube.html

@@ -14,7 +14,7 @@
 <body>
 <canvas id=canvas></canvas>
 <script id="demo">
-/* global FrameCounterDiv, GraphicsPath, H3DU */
+/* global FrameCounterDiv, H3DU */
 // <!--
 /*
 Written by Peter O. in 2015.
@@ -27,7 +27,7 @@
 
 // Path taken from a public domain SVG icon, which was
 // created by Jakub Steiner
-var path = GraphicsPath.fromString(
+var path = H3DU.GraphicsPath.fromString(
 "M 44.155643,23.75 C 44.155643,45.413332 45.663332,43.905643 24,43.905643 2.3366679,43.905643 3.8443565,45.413332 3.8443565,23.75 3.8443565,2.0866679 2.3366679,3.5943565 24,3.5943565 c 21.663332,0 20.155643,-1.5076886 20.155643,20.1556435 z"
 );
 /* exported getPoints */