rebuilt doc

cfourney · Jun 16, 2020 · 2a0db2c · 2a0db2c
1 parent 8b6e767
commit 2a0db2c
Show file tree

Hide file tree

Showing 52 changed files with 122 additions and 90 deletions.
diff --git a/docs/$.html b/docs/$.html
@@ -6186,7 +6186,7 @@ <h4 class="name" id="undo">
 
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Jun 14 2020 01:16:06 GMT+0000 (Coordinated Universal Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Jun 16 2020 13:26:20 GMT+0000 (Coordinated Universal Time)
         </footer>
     </div>
 </div>

diff --git a/docs/$.oApp.html b/docs/$.oApp.html
@@ -4173,7 +4173,7 @@ <h5>Returns:</h5>
 
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Jun 14 2020 01:16:06 GMT+0000 (Coordinated Universal Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Jun 16 2020 13:26:20 GMT+0000 (Coordinated Universal Time)
         </footer>
     </div>
 </div>

diff --git a/docs/$.oArtLayer.html b/docs/$.oArtLayer.html
@@ -3411,7 +3411,7 @@ <h4 class="name" id="clear">
 
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Jun 14 2020 01:16:06 GMT+0000 (Coordinated Universal Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Jun 16 2020 13:26:20 GMT+0000 (Coordinated Universal Time)
         </footer>
     </div>
 </div>

diff --git a/docs/$.oAttribute.html b/docs/$.oAttribute.html
@@ -4579,7 +4579,7 @@ <h5>Returns:</h5>
 
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Jun 14 2020 01:16:06 GMT+0000 (Coordinated Universal Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Jun 16 2020 13:26:20 GMT+0000 (Coordinated Universal Time)
         </footer>
     </div>
 </div>

diff --git a/docs/$.oBackdrop.html b/docs/$.oBackdrop.html
@@ -3817,7 +3817,7 @@ <h4 class="name" id="y">y<span class="type-signature type float">float</span> </
 
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Jun 14 2020 01:16:06 GMT+0000 (Coordinated Universal Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Jun 16 2020 13:26:20 GMT+0000 (Coordinated Universal Time)
         </footer>
     </div>
 </div>

diff --git a/docs/$.oBox.html b/docs/$.oBox.html
@@ -3828,7 +3828,7 @@ <h4 class="name" id="includeNodes">
 
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Jun 14 2020 01:16:06 GMT+0000 (Coordinated Universal Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Jun 16 2020 13:26:20 GMT+0000 (Coordinated Universal Time)
         </footer>
     </div>
 </div>

diff --git a/docs/$.oColor.html b/docs/$.oColor.html
@@ -4244,7 +4244,7 @@ <h4 class="name" id="rgbaToHex">
 
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Jun 14 2020 01:16:06 GMT+0000 (Coordinated Universal Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Jun 16 2020 13:26:20 GMT+0000 (Coordinated Universal Time)
         </footer>
     </div>
 </div>

diff --git a/docs/$.oColorValue.html b/docs/$.oColorValue.html
@@ -3986,7 +3986,7 @@ <h4 class="name" id="toString">
 
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Jun 14 2020 01:16:06 GMT+0000 (Coordinated Universal Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Jun 16 2020 13:26:20 GMT+0000 (Coordinated Universal Time)
         </footer>
     </div>
 </div>

diff --git a/docs/$.oColumn.html b/docs/$.oColumn.html
@@ -4670,7 +4670,7 @@ <h4 class="name" id="setValue">
 
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Jun 14 2020 01:16:06 GMT+0000 (Coordinated Universal Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Jun 16 2020 13:26:20 GMT+0000 (Coordinated Universal Time)
         </footer>
     </div>
 </div>

diff --git a/docs/$.oDatabase.html b/docs/$.oDatabase.html
@@ -3627,7 +3627,7 @@ <h5>Returns:</h5>
 
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Jun 14 2020 01:16:06 GMT+0000 (Coordinated Universal Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Jun 16 2020 13:26:20 GMT+0000 (Coordinated Universal Time)
         </footer>
     </div>
 </div>

diff --git a/docs/$.oDialog.html b/docs/$.oDialog.html
@@ -4498,7 +4498,7 @@ <h4 class="name" id="prompt">
 
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Jun 14 2020 01:16:06 GMT+0000 (Coordinated Universal Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Jun 16 2020 13:26:20 GMT+0000 (Coordinated Universal Time)
         </footer>
     </div>
 </div>

diff --git a/docs/$.oDrawing.html b/docs/$.oDrawing.html
@@ -4578,7 +4578,7 @@ <h4 class="name" id="toString">
 
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Jun 14 2020 01:16:06 GMT+0000 (Coordinated Universal Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Jun 16 2020 13:26:20 GMT+0000 (Coordinated Universal Time)
         </footer>
     </div>
 </div>

diff --git a/docs/$.oDrawingColumn.html b/docs/$.oDrawingColumn.html
@@ -4966,7 +4966,7 @@ <h4 class="name" id="setValue">
 
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Jun 14 2020 01:16:06 GMT+0000 (Coordinated Universal Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Jun 16 2020 13:26:20 GMT+0000 (Coordinated Universal Time)
         </footer>
     </div>
 </div>

diff --git a/docs/$.oDrawingNode.html b/docs/$.oDrawingNode.html
@@ -4686,7 +4686,7 @@ <h5>Example</h5>
 }
 
 // timings are keyframe objects, so they are dynamic.
-timings[2].value = "5";                                 // sets the displayed image of the second key to the drawing named "5"       
+timings[2].value = "5";                                 // sets the displayed image of the second key to the drawing named "5"
 
 // to set a new value to a frame that wasn't a keyframe before, it's possible to use the attribute keyword like so:
 
@@ -11104,7 +11104,7 @@ <h4 class="name" id="update">
 
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Jun 14 2020 01:16:06 GMT+0000 (Coordinated Universal Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Jun 16 2020 13:26:20 GMT+0000 (Coordinated Universal Time)
         </footer>
     </div>
 </div>

diff --git a/docs/$.oElement.html b/docs/$.oElement.html
@@ -4238,7 +4238,7 @@ <h5>Returns:</h5>
 
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Jun 14 2020 01:16:06 GMT+0000 (Coordinated Universal Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Jun 16 2020 13:26:20 GMT+0000 (Coordinated Universal Time)
         </footer>
     </div>
 </div>

diff --git a/docs/$.oFile.html b/docs/$.oFile.html
@@ -4870,7 +4870,7 @@ <h4 class="name" id="write">
 
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Jun 14 2020 01:16:06 GMT+0000 (Coordinated Universal Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Jun 16 2020 13:26:20 GMT+0000 (Coordinated Universal Time)
         </footer>
     </div>
 </div>

diff --git a/docs/$.oFolder.html b/docs/$.oFolder.html
@@ -5082,7 +5082,7 @@ <h5>Returns:</h5>
 
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Jun 14 2020 01:16:06 GMT+0000 (Coordinated Universal Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Jun 16 2020 13:26:20 GMT+0000 (Coordinated Universal Time)
         </footer>
     </div>
 </div>

diff --git a/docs/$.oFrame.html b/docs/$.oFrame.html
@@ -4424,7 +4424,7 @@ <h4 class="name" id="extend">
 
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Jun 14 2020 01:16:06 GMT+0000 (Coordinated Universal Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Jun 16 2020 13:26:20 GMT+0000 (Coordinated Universal Time)
         </footer>
     </div>
 </div>

diff --git a/docs/$.oGroupNode.html b/docs/$.oGroupNode.html
@@ -5059,7 +5059,7 @@ <h4 class="name" id="addBackdrop">
 
 
         <div class="tag-source">
-            openHarmony/openHarmony_node.js, line 2423
+            openHarmony/openHarmony_node.js, line 2424
         </div>
 
     </div>
@@ -5435,7 +5435,7 @@ <h4 class="name" id="addBackdropToNodes">
 
 
         <div class="tag-source">
-            openHarmony/openHarmony_node.js, line 2505
+            openHarmony/openHarmony_node.js, line 2506
         </div>
 
     </div>
@@ -10329,7 +10329,7 @@ <h4 class="name" id="importImage">
 
 
         <div class="tag-source">
-            openHarmony/openHarmony_node.js, line 2807
+            openHarmony/openHarmony_node.js, line 2808
         </div>
 
     </div>
@@ -10557,7 +10557,7 @@ <h4 class="name" id="importPSD">
 
 
         <div class="tag-source">
-            openHarmony/openHarmony_node.js, line 2562
+            openHarmony/openHarmony_node.js, line 2563
         </div>
 
     </div>
@@ -10917,7 +10917,7 @@ <h4 class="name" id="importQT">
 
 
         <div class="tag-source">
-            openHarmony/openHarmony_node.js, line 2856
+            openHarmony/openHarmony_node.js, line 2857
         </div>
 
     </div>
@@ -14078,7 +14078,7 @@ <h4 class="name" id="updatePSD">
 
 
         <div class="tag-source">
-            openHarmony/openHarmony_node.js, line 2664
+            openHarmony/openHarmony_node.js, line 2665
         </div>
 
     </div>
@@ -14278,7 +14278,7 @@ <h5>Returns:</h5>
 
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Jun 14 2020 01:16:06 GMT+0000 (Coordinated Universal Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Jun 16 2020 13:26:20 GMT+0000 (Coordinated Universal Time)
         </footer>
     </div>
 </div>

diff --git a/docs/$.oLink.html b/docs/$.oLink.html
@@ -3127,7 +3127,7 @@ <h4 class="name" id="oLink">
 
 
         <div class="tag-source">
-            openHarmony/openHarmony_nodeLink.js, line 1058
+            openHarmony/openHarmony_nodeLink.js, line 1084
         </div>
 
     </div>
@@ -3411,6 +3411,38 @@ <h4 class="name" id="oLink">
 
 
 
+        <h5>Example</h5>
+
+
+
+    <pre class="prettyprint"><code>// find out if two nodes are linked, and through which ports
+var doc = $.scn;
+var myNode = doc.root.$node("Drawing");
+var sceneComp = doc.root.$node("Composite");
+
+var myLink = new $.oLink(myNode, sceneComp);
+
+log(myLink.linked+" "+myLink.inPort+" "+myLink.outPort+" "+myLink.outLink); // trace the details of the connection.
+
+// activate/deactivate connections simply:
+myLink.connect();
+log (myLink.linked)  // true
+
+myLink.disconnect();
+log (myLink.linked)  // false
+
+// it is also possible to set the linked status directly on the linked property:
+myLink.linked = true;
+
+// however, changing the ports of the link object don't physically change the connection
+
+myLink.inPort = 2    // the connection didn't change, the link object simply represents now a different connection possible.
+log (myLink.linked)  // false
+
+myLink.connect()     // this will connect the nodes once more, with different ports. A new connection is created.</code></pre>
+
+
+
 </dd>
 
 
@@ -3854,7 +3886,7 @@ <h4 class="name" id="connect">
 
 
         <div class="tag-source">
-            openHarmony/openHarmony_nodeLink.js, line 1275
+            openHarmony/openHarmony_nodeLink.js, line 1311
         </div>
 
     </div>
@@ -3954,7 +3986,7 @@ <h4 class="name" id="disconnect">
 
 
         <div class="tag-source">
-            openHarmony/openHarmony_nodeLink.js, line 1312
+            openHarmony/openHarmony_nodeLink.js, line 1349
         </div>
 
     </div>
@@ -4054,7 +4086,7 @@ <h4 class="name" id="getValidLink">
 
 
         <div class="tag-source">
-            openHarmony/openHarmony_nodeLink.js, line 1226
+            openHarmony/openHarmony_nodeLink.js, line 1262
         </div>
 
     </div>
@@ -4162,7 +4194,7 @@ <h5>Returns:</h5>
 
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Jun 14 2020 01:16:07 GMT+0000 (Coordinated Universal Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Jun 16 2020 13:26:20 GMT+0000 (Coordinated Universal Time)
         </footer>
     </div>
 </div>

diff --git a/docs/$.oLinkPath.html b/docs/$.oLinkPath.html
@@ -3127,7 +3127,7 @@ <h4 class="name" id="oLinkPath">
 
 
         <div class="tag-source">
-            openHarmony/openHarmony_nodeLink.js, line 1426
+            openHarmony/openHarmony_nodeLink.js, line 1463
         </div>
 
     </div>
@@ -3391,7 +3391,7 @@ <h4 class="name" id="connectPath">
 
 
         <div class="tag-source">
-            openHarmony/openHarmony_nodeLink.js, line 1597
+            openHarmony/openHarmony_nodeLink.js, line 1634
         </div>
 
     </div>
@@ -3491,7 +3491,7 @@ <h4 class="name" id="findExistingPath">
 
 
         <div class="tag-source">
-            openHarmony/openHarmony_nodeLink.js, line 1476
+            openHarmony/openHarmony_nodeLink.js, line 1513
         </div>
 
     </div>
@@ -3591,7 +3591,7 @@ <h4 class="name" id="findNewPath">
 
 
         <div class="tag-source">
-            openHarmony/openHarmony_nodeLink.js, line 1537
+            openHarmony/openHarmony_nodeLink.js, line 1574
         </div>
 
     </div>
@@ -3691,7 +3691,7 @@ <h4 class="name" id="getValidLink">
 
 
         <div class="tag-source">
-            openHarmony/openHarmony_nodeLink.js, line 1526
+            openHarmony/openHarmony_nodeLink.js, line 1563
         </div>
 
     </div>
@@ -3937,7 +3937,7 @@ <h5>Returns:</h5>
 
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Jun 14 2020 01:16:07 GMT+0000 (Coordinated Universal Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Jun 16 2020 13:26:20 GMT+0000 (Coordinated Universal Time)
         </footer>
     </div>
 </div>

diff --git a/docs/$.oList.html b/docs/$.oList.html
@@ -5125,7 +5125,7 @@ <h5>Returns:</h5>
 
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Jun 14 2020 01:16:07 GMT+0000 (Coordinated Universal Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Jun 16 2020 13:26:20 GMT+0000 (Coordinated Universal Time)
         </footer>
     </div>
 </div>

diff --git a/docs/$.oMetadata.html b/docs/$.oMetadata.html
@@ -3452,7 +3452,7 @@ <h4 class="name" id="refresh">
 
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Jun 14 2020 01:16:07 GMT+0000 (Coordinated Universal Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Jun 16 2020 13:26:20 GMT+0000 (Coordinated Universal Time)
         </footer>
     </div>
 </div>

diff --git a/docs/$.oNetwork.html b/docs/$.oNetwork.html
@@ -3731,7 +3731,7 @@ <h4 class="name" id="webQuery">
 
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Jun 14 2020 01:16:07 GMT+0000 (Coordinated Universal Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Jun 16 2020 13:26:20 GMT+0000 (Coordinated Universal Time)
         </footer>
     </div>
 </div>