Automated package and docs

dvisionlab · Mar 14, 2022 · fcf509d · fcf509d
1 parent a12d0be
commit fcf509d
Show file tree

Hide file tree

Showing 10 changed files with 61 additions and 7,244 deletions.
diff --git a/dist/diglettk.js b/dist/diglettk.js
diff --git a/docs/documentation/MPRManager.html b/docs/documentation/MPRManager.html
@@ -83,7 +83,7 @@ <h4 class="name" id="MPRManager"><span class="type-signature"></span>new MPRMana
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="mprManager.js.html">mprManager.js</a>, <a href="mprManager.js.html#line32">line 32</a>
+        <a href="mprManager.js.html">mprManager.js</a>, <a href="mprManager.js.html#line33">line 33</a>
     </li></ul></dd>
 
 
@@ -313,7 +313,7 @@ <h4 class="name" id="wwwl"><span class="type-signature"></span>wwwl<span class="
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="mprManager.js.html">mprManager.js</a>, <a href="mprManager.js.html#line61">line 61</a>
+        <a href="mprManager.js.html">mprManager.js</a>, <a href="mprManager.js.html#line62">line 62</a>
     </li></ul></dd>
 
 
@@ -396,7 +396,7 @@ <h4 class="name" id="destroy"><span class="type-signature"></span>destroy<span c
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="mprManager.js.html">mprManager.js</a>, <a href="mprManager.js.html#line471">line 471</a>
+        <a href="mprManager.js.html">mprManager.js</a>, <a href="mprManager.js.html#line472">line 472</a>
     </li></ul></dd>
 
 
@@ -483,7 +483,7 @@ <h4 class="name" id="getInitialState"><span class="type-signature"></span>getIni
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="mprManager.js.html">mprManager.js</a>, <a href="mprManager.js.html#line96">line 96</a>
+        <a href="mprManager.js.html">mprManager.js</a>, <a href="mprManager.js.html#line97">line 97</a>
     </li></ul></dd>
 
 
@@ -592,7 +592,7 @@ <h4 class="name" id="onRotate"><span class="type-signature"></span>onRotate<span
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="mprManager.js.html">mprManager.js</a>, <a href="mprManager.js.html#line370">line 370</a>
+        <a href="mprManager.js.html">mprManager.js</a>, <a href="mprManager.js.html#line371">line 371</a>
     </li></ul></dd>
 
 
@@ -797,7 +797,7 @@ <h4 class="name" id="onThickness"><span class="type-signature"></span>onThicknes
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="mprManager.js.html">mprManager.js</a>, <a href="mprManager.js.html#line405">line 405</a>
+        <a href="mprManager.js.html">mprManager.js</a>, <a href="mprManager.js.html#line406">line 406</a>
     </li></ul></dd>
 
 
@@ -1002,7 +1002,7 @@ <h4 class="name" id="resize"><span class="type-signature"></span>resize<span cla
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="mprManager.js.html">mprManager.js</a>, <a href="mprManager.js.html#line457">line 457</a>
+        <a href="mprManager.js.html">mprManager.js</a>, <a href="mprManager.js.html#line458">line 458</a>
     </li></ul></dd>
 
 
@@ -1138,7 +1138,7 @@ <h4 class="name" id="setImage"><span class="type-signature"></span>setImage<span
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="mprManager.js.html">mprManager.js</a>, <a href="mprManager.js.html#line139">line 139</a>
+        <a href="mprManager.js.html">mprManager.js</a>, <a href="mprManager.js.html#line140">line 140</a>
     </li></ul></dd>
 
 
@@ -1297,7 +1297,7 @@ <h4 class="name" id="setTool"><span class="type-signature"></span>setTool<span c
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="mprManager.js.html">mprManager.js</a>, <a href="mprManager.js.html#line171">line 171</a>
+        <a href="mprManager.js.html">mprManager.js</a>, <a href="mprManager.js.html#line172">line 172</a>
     </li></ul></dd>
 
 
@@ -1459,7 +1459,7 @@ <h5>Parameters:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/documentation/VRView.html b/docs/documentation/VRView.html
@@ -2117,7 +2117,7 @@ <h4 class="name" id="setupCropWidget"><span class="type-signature"></span>setupC
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/documentation/global.html b/docs/documentation/global.html
@@ -418,7 +418,7 @@ <h4 class="name" id="State">State</h4>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="mprManager.js.html">mprManager.js</a>, <a href="mprManager.js.html#line16">line 16</a>
+        <a href="mprManager.js.html">mprManager.js</a>, <a href="mprManager.js.html#line17">line 17</a>
     </li></ul></dd>
 
 
@@ -780,7 +780,7 @@ <h5>Type:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/documentation/index.html b/docs/documentation/index.html
@@ -131,7 +131,13 @@ <h2 id="use">Use</h2>
   mpr.onThickness(&quot;top&quot;, &quot;x&quot;, 50, state);
 });
 </code></pre>
+<h2 id="dev">DEV</h2>
+<p><code>yarn dev &amp;&amp; cp ./dist/diglettk.js ./docs/examples/diglettk.js</code> to build the lib and move it from <code>dist</code> folder to <code>examples</code>.</p>
+<p>then load the desired example with a webserver (eg VS code liveserver).</p>
+<p><code>yarn build</code> to build the librery for production</p>
+<p><code>yarn generate-docs</code> to build the documentation in the <code>documentation</code> folder.</p>
 <h3 id="roadmap">RoadMap</h3>
+<p>--</p>
 <ul>
 <li>[x] Volume Rendering</li>
 <li>[x] Measuring tools</li>
@@ -145,6 +151,7 @@ <h3 id="todo">TODO</h3>
 <li>[x] <s>rollup config</s> webpack config</li>
 <li>[x] examples</li>
 <li>[ ] npm package</li>
+<li>[ ] webpack-dev-server for a better dev experience</li>
 </ul></article>
     </section>
 
@@ -160,7 +167,7 @@ <h3 id="todo">TODO</h3>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/documentation/mprManager.js.html b/docs/documentation/mprManager.js.html
@@ -54,8 +54,9 @@ <h1 class="page-title">mprManager.js</h1>
 import vtkInteractorStyleMPRWindowLevel from "./vtk/vtkInteractorStyleMPRWindowLevel";
 import vtkInteractorStyleMPRCrosshairs from "./vtk/vtkInteractorStyleMPRCrosshairs";
 import vtkInteractorStyleMPRPanZoom from "./vtk/vtkInteractorStyleMPRPanZoom";
-import vtkCoordinate from "vtk.js/Sources/Rendering/Core/Coordinate";
-import vtkMatrixBuilder from "vtk.js/Sources/Common/Core/MatrixBuilder";
+
+import vtkCoordinate from "@kitware/vtk.js/Rendering/Core/Coordinate";
+import vtkMatrixBuilder from "@kitware/vtk.js/Common/Core/MatrixBuilder";
 
 import {
   getPlaneIntersection,
@@ -540,7 +541,7 @@ <h1 class="page-title">mprManager.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/documentation/mprView.js.html b/docs/documentation/mprView.js.html
@@ -50,7 +50,8 @@ <h1 class="page-title">mprView.js</h1>
 
     <section>
         <article>
-            <pre class="prettyprint source linenums"><code>import vtkGenericRenderWindow from "vtk.js/Sources/Rendering/Misc/GenericRenderWindow";
+            <pre class="prettyprint source linenums"><code>import vtkGenericRenderWindow from "@kitware/vtk.js/Rendering/Misc/GenericRenderWindow";
+
 import vtkInteractorStyleMPRSlice from "./vtk/vtkInteractorMPRSlice";
 
 import { quat, vec3, mat4 } from "gl-matrix";
@@ -449,7 +450,7 @@ <h1 class="page-title">mprView.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/documentation/vrView.js.html b/docs/documentation/vrView.js.html
@@ -50,27 +50,27 @@ <h1 class="page-title">vrView.js</h1>
 
     <section>
         <article>
-            <pre class="prettyprint source linenums"><code>import vtkGenericRenderWindow from "vtk.js/Sources/Rendering/Misc/GenericRenderWindow";
-import vtkColorTransferFunction from "vtk.js/Sources/Rendering/Core/ColorTransferFunction";
-import vtkPiecewiseFunction from "vtk.js/Sources/Common/DataModel/PiecewiseFunction";
-import vtkImageCroppingWidget from "vtk.js/Sources/Widgets/Widgets3D/ImageCroppingWidget";
-import vtkImageCropFilter from "vtk.js/Sources/Filters/General/ImageCropFilter";
-import vtkWidgetManager from "vtk.js/Sources/Widgets/Core/WidgetManager";
-import vtkColorMaps from "vtk.js/Sources/Rendering/Core/ColorTransferFunction/ColorMaps";
-import vtkPiecewiseGaussianWidget from "vtk.js/Sources/Interaction/Widgets/PiecewiseGaussianWidget";
-
-import vtkMouseCameraTrackballRotateManipulator from "vtk.js/Sources/Interaction/Manipulators/MouseCameraTrackballRotateManipulator";
-import vtkMouseCameraTrackballPanManipulator from "vtk.js/Sources/Interaction/Manipulators/MouseCameraTrackballPanManipulator";
-import vtkMouseCameraTrackballZoomManipulator from "vtk.js/Sources/Interaction/Manipulators/MouseCameraTrackballZoomManipulator";
-import vtkMouseRangeManipulator from "vtk.js/Sources/Interaction/Manipulators/MouseRangeManipulator";
-import vtkInteractorStyleManipulator from "vtk.js/Sources/Interaction/Style/InteractorStyleManipulator";
-
-import vtkPointPicker from "vtk.js/Sources/Rendering/Core/PointPicker";
-import vtkPlaneSource from "vtk.js/Sources/Filters/Sources/PlaneSource";
-import vtkMapper from "vtk.js/Sources/Rendering/Core/Mapper";
-import vtkActor from "vtk.js/Sources/Rendering/Core/Actor";
-import vtkSphereSource from "vtk.js/Sources/Filters/Sources/SphereSource";
-import vtkCoordinate from "vtk.js/Sources/Rendering/Core/Coordinate";
+            <pre class="prettyprint source linenums"><code>import vtkGenericRenderWindow from "@kitware/vtk.js/Rendering/Misc/GenericRenderWindow";
+import vtkColorTransferFunction from "@kitware/vtk.js/Rendering/Core/ColorTransferFunction";
+import vtkPiecewiseFunction from "@kitware/vtk.js/Common/DataModel/PiecewiseFunction";
+import vtkImageCroppingWidget from "@kitware/vtk.js/Widgets/Widgets3D/ImageCroppingWidget";
+import vtkImageCropFilter from "@kitware/vtk.js/Filters/General/ImageCropFilter";
+import vtkWidgetManager from "@kitware/vtk.js/Widgets/Core/WidgetManager";
+import vtkColorMaps from "@kitware/vtk.js/Rendering/Core/ColorTransferFunction/ColorMaps";
+import vtkPiecewiseGaussianWidget from "@kitware/vtk.js/Interaction/Widgets/PiecewiseGaussianWidget";
+
+import vtkMouseCameraTrackballRotateManipulator from "@kitware/vtk.js/Interaction/Manipulators/MouseCameraTrackballRotateManipulator";
+import vtkMouseCameraTrackballPanManipulator from "@kitware/vtk.js/Interaction/Manipulators/MouseCameraTrackballPanManipulator";
+import vtkMouseCameraTrackballZoomManipulator from "@kitware/vtk.js/Interaction/Manipulators/MouseCameraTrackballZoomManipulator";
+import vtkMouseRangeManipulator from "@kitware/vtk.js/Interaction/Manipulators/MouseRangeManipulator";
+import vtkInteractorStyleManipulator from "@kitware/vtk.js/Interaction/Style/InteractorStyleManipulator";
+
+import vtkPointPicker from "@kitware/vtk.js/Rendering/Core/PointPicker";
+import vtkPlaneSource from "@kitware/vtk.js/Filters/Sources/PlaneSource";
+import vtkMapper from "@kitware/vtk.js/Rendering/Core/Mapper";
+import vtkActor from "@kitware/vtk.js/Rendering/Core/Actor";
+import vtkSphereSource from "@kitware/vtk.js/Filters/Sources/SphereSource";
+import vtkCoordinate from "@kitware/vtk.js/Rendering/Core/Coordinate";
 
 import { createVolumeActor, getCroppingPlanes } from "./utils/utils";
 import { applyStrategy } from "./utils/strategies";
@@ -935,7 +935,7 @@ <h1 class="page-title">vrView.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/documentation/vtk_vtkInteractorMPRSlice.js.html b/docs/documentation/vtk_vtkInteractorMPRSlice.js.html
@@ -55,14 +55,14 @@ <h1 class="page-title">vtk/vtkInteractorMPRSlice.js</h1>
  */
 
 // Temporarily using a modified version of this interactor to deal with a camera subscription issue
-import macro from "vtk.js/Sources/macro";
-import vtkMath from "vtk.js/Sources/Common/Core/Math";
-import vtkMatrixBuilder from "vtk.js/Sources/Common/Core/MatrixBuilder";
-import vtkInteractorStyleManipulator from "vtk.js/Sources/Interaction/Style/InteractorStyleManipulator";
-import vtkMouseCameraTrackballRotateManipulator from "vtk.js/Sources/Interaction/Manipulators/MouseCameraTrackballRotateManipulator";
-import vtkMouseCameraTrackballPanManipulator from "vtk.js/Sources/Interaction/Manipulators/MouseCameraTrackballPanManipulator";
-import vtkMouseCameraTrackballZoomManipulator from "vtk.js/Sources/Interaction/Manipulators/MouseCameraTrackballZoomManipulator";
-import vtkMouseRangeManipulator from "vtk.js/Sources/Interaction/Manipulators/MouseRangeManipulator";
+import macro from "@kitware/vtk.js/macro";
+import vtkMath from "@kitware/vtk.js/Common/Core/Math";
+import vtkMatrixBuilder from "@kitware/vtk.js/Common/Core/MatrixBuilder";
+import vtkInteractorStyleManipulator from "@kitware/vtk.js/Interaction/Style/InteractorStyleManipulator";
+import vtkMouseCameraTrackballRotateManipulator from "@kitware/vtk.js/Interaction/Manipulators/MouseCameraTrackballRotateManipulator";
+import vtkMouseCameraTrackballPanManipulator from "@kitware/vtk.js/Interaction/Manipulators/MouseCameraTrackballPanManipulator";
+import vtkMouseCameraTrackballZoomManipulator from "@kitware/vtk.js/Interaction/Manipulators/MouseCameraTrackballZoomManipulator";
+import vtkMouseRangeManipulator from "@kitware/vtk.js/Interaction/Manipulators/MouseRangeManipulator";
 
 // ----------------------------------------------------------------------------
 // Global methods
@@ -507,7 +507,7 @@ <h1 class="page-title">vtk/vtkInteractorMPRSlice.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>