Documentation tweaks

xeokit · May 27, 2019 · ba925ec · ba925ec
1 parent 47bb177
commit ba925ec
Show file tree

Hide file tree

Showing 11 changed files with 5,643 additions and 5,630 deletions.
diff --git a/docs/ast/source/plugins/AnnotationsPlugin/AnnotationsPlugin.js.json b/docs/ast/source/plugins/AnnotationsPlugin/AnnotationsPlugin.js.json
diff --git a/docs/class/src/plugins/AnnotationsPlugin/AnnotationsPlugin.js~AnnotationsPlugin.html b/docs/class/src/plugins/AnnotationsPlugin/AnnotationsPlugin.js~AnnotationsPlugin.html
@@ -116,13 +116,13 @@
 </nav>
 
 <div class="content" data-ice="content"><div class="header-notice">
-  <div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {AnnotationsPlugin} from &apos;<span><a href="file/src/plugins/AnnotationsPlugin/AnnotationsPlugin.js.html#lineNumber329">xeokit-sdk/src/plugins/AnnotationsPlugin/AnnotationsPlugin.js</a></span>&apos;</code></pre></div>
+  <div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {AnnotationsPlugin} from &apos;<span><a href="file/src/plugins/AnnotationsPlugin/AnnotationsPlugin.js.html#lineNumber332">xeokit-sdk/src/plugins/AnnotationsPlugin/AnnotationsPlugin.js</a></span>&apos;</code></pre></div>
   <span data-ice="access">public</span>
   <span data-ice="kind">class</span>
 
 
 
-  <span data-ice="source">| <span><a href="file/src/plugins/AnnotationsPlugin/AnnotationsPlugin.js.html#lineNumber329">source</a></span></span>
+  <span data-ice="source">| <span><a href="file/src/plugins/AnnotationsPlugin/AnnotationsPlugin.js.html#lineNumber332">source</a></span></span>
 </div>
 
 <div class="self-detail detail">
@@ -143,8 +143,13 @@ <h1 data-ice="name">AnnotationsPlugin</h1>
 
 
   <div class="description" data-ice="description"><p>AnnotationsPlugin is a <span><a href="class/src/viewer/Viewer.js~Viewer.html">Viewer</a></span> plugin that creates <span><a href="class/src/plugins/AnnotationsPlugin/Annotation.js~Annotation.html">Annotation</a></span>s.</p>
-<p><img src="https://user-images.githubusercontent.com/83100/58403089-26589280-8062-11e9-8652-aed61a4e8c64.gif"></p>
-<p>[<a href="https://xeokit.github.io/xeokit-sdk/examples/#annotations_hoverShowLabels">Run this example</a>]</p>
+<p><a href="https://xeokit.github.io/xeokit-sdk/examples/#annotations_clickToFlyToPosition"><img src="https://user-images.githubusercontent.com/83100/58403089-26589280-8062-11e9-8652-aed61a4e8c64.gif"></a></p>
+<ul>
+<li>[<a href="https://xeokit.github.io/xeokit-sdk/examples/#annotations_createWithMouse">Example 1: Create annotations with mouse</a>]</li>
+<li>[<a href="https://xeokit.github.io/xeokit-sdk/examples/#annotations_clickShowLabels">Example 2: Click annotations to toggle labels</a>]</li>
+<li>[<a href="https://xeokit.github.io/xeokit-sdk/examples/#annotations_hoverShowLabels">Example 3: Hover annotations to show labels</a>]</li>
+<li>[<a href="https://xeokit.github.io/xeokit-sdk/examples/#annotations_clickFlyToPosition">Example 4: Click annotations to fly to viewpoint</a>]</li>
+</ul>
 <h2 id="overview">Overview</h2><ul>
 <li>An <span><a href="class/src/plugins/AnnotationsPlugin/Annotation.js~Annotation.html">Annotation</a></span> is a 3D position with a label attached.</li>
 <li>Annotations render themselves with HTML elements that float over the canvas. Customize the appearance of
@@ -872,7 +877,7 @@ <h3 data-ice="anchor" id="instance-constructor-constructor">
     <span class="right-info">
 
 
-      <span data-ice="source"><span><a href="file/src/plugins/AnnotationsPlugin/AnnotationsPlugin.js.html#lineNumber341">source</a></span></span>
+      <span data-ice="source"><span><a href="file/src/plugins/AnnotationsPlugin/AnnotationsPlugin.js.html#lineNumber344">source</a></span></span>
     </span>
   </h3>
 
@@ -980,7 +985,7 @@ <h3 data-ice="anchor" id="instance-member-annotations">
     <span class="right-info">
 
 
-      <span data-ice="source"><span><a href="file/src/plugins/AnnotationsPlugin/AnnotationsPlugin.js.html#lineNumber354">source</a></span></span>
+      <span data-ice="source"><span><a href="file/src/plugins/AnnotationsPlugin/AnnotationsPlugin.js.html#lineNumber357">source</a></span></span>
     </span>
   </h3>
 
@@ -1027,7 +1032,7 @@ <h3 data-ice="anchor" id="instance-method-clear">
     <span class="right-info">
 
 
-      <span data-ice="source"><span><a href="file/src/plugins/AnnotationsPlugin/AnnotationsPlugin.js.html#lineNumber452">source</a></span></span>
+      <span data-ice="source"><span><a href="file/src/plugins/AnnotationsPlugin/AnnotationsPlugin.js.html#lineNumber455">source</a></span></span>
     </span>
   </h3>
 
@@ -1071,7 +1076,7 @@ <h3 data-ice="anchor" id="instance-method-createAnnotation">
     <span class="right-info">
 
 
-      <span data-ice="source"><span><a href="file/src/plugins/AnnotationsPlugin/AnnotationsPlugin.js.html#lineNumber390">source</a></span></span>
+      <span data-ice="source"><span><a href="file/src/plugins/AnnotationsPlugin/AnnotationsPlugin.js.html#lineNumber393">source</a></span></span>
     </span>
   </h3>
 
@@ -1243,7 +1248,7 @@ <h3 data-ice="anchor" id="instance-method-destroy">
     <span class="right-info">
 
 
-      <span data-ice="source"><span><a href="file/src/plugins/AnnotationsPlugin/AnnotationsPlugin.js.html#lineNumber464">source</a></span></span>
+      <span data-ice="source"><span><a href="file/src/plugins/AnnotationsPlugin/AnnotationsPlugin.js.html#lineNumber467">source</a></span></span>
     </span>
   </h3>
 
@@ -1288,7 +1293,7 @@ <h3 data-ice="anchor" id="instance-method-destroyAnnotation">
     <span class="right-info">
 
 
-      <span data-ice="source"><span><a href="file/src/plugins/AnnotationsPlugin/AnnotationsPlugin.js.html#lineNumber440">source</a></span></span>
+      <span data-ice="source"><span><a href="file/src/plugins/AnnotationsPlugin/AnnotationsPlugin.js.html#lineNumber443">source</a></span></span>
     </span>
   </h3>
 

diff --git a/docs/coverage.json b/docs/coverage.json
@@ -29,10 +29,10 @@
         6,
         7,
         8,
-        345,
-        346,
-        347,
-        348
+        348,
+        349,
+        350,
+        351
       ]
     },
     "src/plugins/AxisGizmoPlugin/AxisGizmoPlugin.js": {

diff --git a/docs/file/src/plugins/AnnotationsPlugin/AnnotationsPlugin.js.html b/docs/file/src/plugins/AnnotationsPlugin/AnnotationsPlugin.js.html
@@ -128,9 +128,12 @@
 /**
  * AnnotationsPlugin is a {@link Viewer} plugin that creates {@link Annotation}s.
  *
- * &lt;img src=&quot;https://user-images.githubusercontent.com/83100/58403089-26589280-8062-11e9-8652-aed61a4e8c64.gif&quot;&gt;
+ * [&lt;img src=&quot;https://user-images.githubusercontent.com/83100/58403089-26589280-8062-11e9-8652-aed61a4e8c64.gif&quot;&gt;](https://xeokit.github.io/xeokit-sdk/examples/#annotations_clickToFlyToPosition)
  *
- * [[Run this example](https://xeokit.github.io/xeokit-sdk/examples/#annotations_hoverShowLabels)]
+ * * [[Example 1: Create annotations with mouse](https://xeokit.github.io/xeokit-sdk/examples/#annotations_createWithMouse)]
+ * * [[Example 2: Click annotations to toggle labels](https://xeokit.github.io/xeokit-sdk/examples/#annotations_clickShowLabels)]
+ * * [[Example 3: Hover annotations to show labels](https://xeokit.github.io/xeokit-sdk/examples/#annotations_hoverShowLabels)]
+ * * [[Example 4: Click annotations to fly to viewpoint](https://xeokit.github.io/xeokit-sdk/examples/#annotations_clickFlyToPosition)]
  *
  * ## Overview
  *

diff --git a/docs/index.json b/docs/index.json
diff --git a/docs/source.html b/docs/source.html
@@ -139,12 +139,12 @@
       <td style="display: none;" data-ice="updated">2019-05-02 08:50:48 (UTC)</td>
     </tr>
 <tr data-ice="file">
-      <td data-ice="filePath"><span><a href="file/src/plugins/AnnotationsPlugin/AnnotationsPlugin.js.html#errorLines=345,346,347,348,6,7,8">src/plugins/AnnotationsPlugin/AnnotationsPlugin.js</a></span></td>
+      <td data-ice="filePath"><span><a href="file/src/plugins/AnnotationsPlugin/AnnotationsPlugin.js.html#errorLines=348,349,350,351,6,7,8">src/plugins/AnnotationsPlugin/AnnotationsPlugin.js</a></span></td>
       <td data-ice="identifier" class="identifiers"><span><a href="class/src/plugins/AnnotationsPlugin/AnnotationsPlugin.js~AnnotationsPlugin.html">AnnotationsPlugin</a></span></td>
       <td class="coverage"><span data-ice="coverage">53 %</span><span data-ice="coverageCount" class="coverage-count">8/15</span></td>
-      <td style="display: none;" data-ice="size">20005 byte</td>
-      <td style="display: none;" data-ice="lines">470</td>
-      <td style="display: none;" data-ice="updated">2019-05-02 08:50:48 (UTC)</td>
+      <td style="display: none;" data-ice="size">20507 byte</td>
+      <td style="display: none;" data-ice="lines">473</td>
+      <td style="display: none;" data-ice="updated">2019-05-02 09:27:13 (UTC)</td>
     </tr>
 <tr data-ice="file">
       <td data-ice="filePath"><span><a href="file/src/plugins/AxisGizmoPlugin/AxisGizmoPlugin.js.html">src/plugins/AxisGizmoPlugin/AxisGizmoPlugin.js</a></span></td>

diff --git a/examples/annotations_clickFlyToPosition.html b/examples/annotations_clickFlyToPosition.html
@@ -87,9 +87,9 @@
 <canvas id="myCanvas"></canvas>
 
 <div id="info">
-    <h1>Click an Annotation marker to position camera at associated viewpoint</h1>
-    <p>Each Annotation can be associated with a camera viewpoint. Click the markers in this example to fly the camera to
-        their associated camera positions.</p>
+    <h1>Click an Annotation to position camera at associated viewpoint</h1>
+    <p><br>Each Annotation can be associated with a camera viewpoint. Click the markers in this example to fly the camera to
+        their associated camera positions.</p><br>
     <ul>
         <li>
             <a target="_other"

diff --git a/examples/annotations_clickShowLabels.html b/examples/annotations_clickShowLabels.html
@@ -89,8 +89,8 @@
 <body>
 <canvas id="myCanvas"></canvas>
 <div id="info">
-    <h1>Click Annotation markers to show labels</h1>
-    <p>Shows how to customize annotation interaction using callbacks</p>
+    <h1>Click Annotations to show labels</h1>
+    <p><br>Shows how to customize annotation interaction using callbacks.</p><br>
     <ul>
         <li>
             <a target="_other"

diff --git a/examples/annotations_createWithMouse.html b/examples/annotations_createWithMouse.html
@@ -85,7 +85,8 @@
 <body>
 <canvas id="myCanvas"></canvas>
 <div id="info">
-    <h1>Click on objects to create Annotations</h1>
+    <h1>Click objects to create Annotations</h1>
+    <p><br>Demonstrates how to create Annotations by picking objects.</p><br>
     <ul>
 
         <li>

diff --git a/examples/annotations_hoverShowLabels.html b/examples/annotations_hoverShowLabels.html
@@ -85,7 +85,8 @@
 <body>
 <canvas id="myCanvas"></canvas>
 <div id="info">
-    <h1>Hover over Annotation markers to show labels</h1>
+    <h1>Hover over Annotation to show labels</h1>
+    <p><br>Shows how to customize annotation interaction using callbacks.</p><br>
     <ul>
         <li>
             <a target="_other"

diff --git a/src/plugins/AnnotationsPlugin/AnnotationsPlugin.js b/src/plugins/AnnotationsPlugin/AnnotationsPlugin.js
@@ -10,16 +10,19 @@ const tempVec3c = math.vec3();
 /**
  * AnnotationsPlugin is a {@link Viewer} plugin that creates {@link Annotation}s.
  *
- * <img src="https://user-images.githubusercontent.com/83100/58403089-26589280-8062-11e9-8652-aed61a4e8c64.gif">
+ * [<img src="https://user-images.githubusercontent.com/83100/58403089-26589280-8062-11e9-8652-aed61a4e8c64.gif">](https://xeokit.github.io/xeokit-sdk/examples/#annotations_clickToFlyToPosition)
  *
- * [[Run this example](https://xeokit.github.io/xeokit-sdk/examples/#annotations_hoverShowLabels)]
+ * * [[Example 1: Create annotations with mouse](https://xeokit.github.io/xeokit-sdk/examples/#annotations_createWithMouse)]
+ * * [[Example 2: Click annotations to toggle labels](https://xeokit.github.io/xeokit-sdk/examples/#annotations_clickShowLabels)]
+ * * [[Example 3: Hover annotations to show labels](https://xeokit.github.io/xeokit-sdk/examples/#annotations_hoverShowLabels)]
+ * * [[Example 4: Click annotations to fly to viewpoint](https://xeokit.github.io/xeokit-sdk/examples/#annotations_clickFlyToPosition)]
  *
  * ## Overview
  *
  * * An {@link Annotation} is a 3D position with a label attached.
- * * Annotations render themselves with HTML elements that float over the canvas. Customize the appearance of
- * individual Annotations using HTML templates. Configure default appearance by setting templates on the AnnotationsPlugin.
- * * Dynamically insert data values into each Annotation's HTML templates. Configure default values on the AnnotationsPlugin.
+ * * Annotations render themselves with HTML elements that float over the canvas; customize the appearance of
+ * individual Annotations using HTML template; configure default appearance by setting templates on the AnnotationsPlugin.
+ * * Dynamically insert data values into each Annotation's HTML templates; configure default values on the AnnotationsPlugin.
  * * Optionally configure Annotations to hide themselves whenever occluded by {@link Entity}s.
  * * Optionally configure each Annotation with a position we can jump or fly the {@link Camera} to.
  *