added docs, tweaked manifest (#339)

bindings/wasm/examples/editor.d.ts

@@ -17,7 +17,7 @@
  * red. This is particularly useful for debugging subtract() as it will allow
  * you find the object even if it doesn't currently intersect the result.
  *
- * @param manifold The object show - returns the input unchanged for chaining.
+ * @param manifold The object to show - returned for chaining.
  */
 declare function show(manifold: Manifold): Manifold;
 
@@ -27,7 +27,7 @@ declare function show(manifold: Manifold): Manifold;
  * debugging as it allows you to see objects that may be hidden in the interior
  * of the result. Multiple objects marked only() will all be shown.
  *
- * @param manifold The object show - returns the input unchanged for chaining.
+ * @param manifold The object to show - returned for chaining.
  */
 declare function only(manifold: Manifold): Manifold;
 

bindings/wasm/examples/index.html

@@ -6,17 +6,17 @@
   <meta charset="utf-8">
   <meta name="viewport" content="width=device-width, initial-scale=1">
   <meta name="description"
-    content="Fast, reliable, parametric solid modeling web app. Programmatic 3D design with JavaScript, inspired by and improving upon OpenSCAD/JSCAD. Demonstrates a new GPU-parallel, open-source geometry kernel: Manifold.">
-  <meta name="theme-color" content="rgb(162 136 179)">
-  <meta property="og:title" content="ManifoldCAD" />
-  <meta property="og:type" content="website" />
+    content="Fast, reliable, parametric solid modeling web app. Programmatic 3D design with JavaScript, inspired by and improving upon OpenSCAD & JSCAD. Demonstrates a new GPU-parallel, open-source geometry kernel: Manifold.">
+  <meta name="theme-color" content="#A288B3">
+  <meta property="og:title" content="ManifoldCAD">
+  <meta property="og:type" content="website">
   <meta property="og:url" content="https://manifoldcad.org/" />
-  <meta property="og:image" content="https://elalish.github.io/manifold/samples/models/mengerSpongeSquare.png" />
-  <meta property="og:image:width" content="850" />
-  <meta property="og:image:height" content="850" />
-  <link rel="shortcut icon" type="image/png" href="https://elalish.github.io/manifold/samples/models/favicon.png" />
+  <meta property="og:image" content="https://elalish.github.io/manifold/samples/models/mengerSpongeSquare.png">
+  <meta property="og:image:width" content="850">
+  <meta property="og:image:height" content="850">
+  <link rel="shortcut icon" type="image/png" href="https://elalish.github.io/manifold/samples/models/favicon.png">
   <link rel="manifest" href="/manifest.json">
-  <link type="text/css" href="editor.css" rel="stylesheet" />
+  <link type="text/css" href="editor.css" rel="stylesheet">
   <script type="application/ld+json">
     {
       "@context": "https://schema.org",
@@ -33,7 +33,7 @@
 
 <body>
   <div class="page">
-    <div class="container header" style="background-color: rgb(162 136 179);">
+    <div class="container header" style="background-color: #A288B3;">
       <p style="flex: 2;"><a target="_blank" href="https://github.com/elalish/manifold">Manifold</a>CAD </p>
       <div class="margin" style="position: relative;">
         <button type="button" id="file" class="blue"><b class="uparrow"></b>&nbsp;&nbsp;<span
@@ -65,7 +65,7 @@
 <link rel="stylesheet"
   href="https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.34.0/min/vs/editor/editor.main.min.css"
   integrity="sha512-iQEIc0rsSDujsfjtD+lfyJ1W23Bh/lbgriubKDAym6VlEIDRj9rrbSIyJRyshOrl8s0yRcQ0+gyrZfSLyjJGWQ=="
-  crossorigin="anonymous" referrerpolicy="no-referrer" />
+  crossorigin="anonymous" referrerpolicy="no-referrer">
 <script type="module" src="editor.js"></script>
 <script type="module" src="https://ajax.googleapis.com/ajax/libs/model-viewer/2.0.1/model-viewer.min.js"></script>
 

bindings/wasm/examples/manifest.json

@@ -12,12 +12,21 @@
       "sizes": "512x512"
     }
   ],
+  "id": "/",
   "start_url": "/",
   "background_color": "#FFFFFF",
   "display": "standalone",
+  "orientation": "landscape",
   "scope": "/",
-  "theme_color": "rgb(162 136 179)",
-  "description": "Fast, reliable, parametric solid modeling web app. Programmatic 3D design with JavaScript, inspired by and improving upon OpenSCAD/JSCAD. Demonstrates a new GPU-parallel, open-source geometry kernel: Manifold.",
+  "theme_color": "#A288B3",
+  "description": "Fast, reliable, parametric solid modeling web app. Programmatic 3D design with JavaScript, inspired by and improving upon OpenSCAD & JSCAD. Demonstrates a new GPU-parallel, open-source geometry kernel: Manifold.",
+  "categories": [
+    "design",
+    "developer",
+    "education",
+    "graphics",
+    "productivity"
+  ],
   "screenshots": [
     {
       "src": "/icons/manifoldCAD.png",

bindings/wasm/manifold.d.ts

@@ -22,6 +22,7 @@ interface SealedFloat32Array<N extends number> extends Float32Array {
 
 type Vec2 = [number, number];
 type Vec3 = [number, number, number];
+// 4x4 matrix stored in column-major order
 type Mat4 = [
   number,
   number,
@@ -98,7 +99,15 @@ declare class Mesh {
 
 declare class Manifold {
   /**
-   * Create a Manifold from a Mesh object.
+   * Convert a Mesh into a Manifold, retaining its properties and merging only
+   * the positions according to the merge vectors. Will throw an error if the
+   * result is not an oriented 2-manifold. Will collapse degenerate triangles
+   * and unnecessary vertices.
+   *
+   * All fields are read, making this structure suitable for a lossless
+   * round-trip of data from getMesh(). For multi-material input, use
+   * reserveIDs() to set a unique originalID for each material, and sort the
+   * materials into triangle runs.
    */
   constructor(mesh: Mesh);
   /**