docs and examples

wmurphyrd · wmurphyrd · commit 162aad248770 · 2020-11-25T16:31:14.000-06:00
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Super Hands
 
-[![Build Status](https://travis-ci.org/wmurphyrd/aframe-super-hands-component.svg?branch=master)](https://travis-ci.org/wmurphyrd/aframe-super-hands-component)
+[![Build Status](https://travis-ci.com/wmurphyrd/aframe-super-hands-component.svg?branch=master)](https://travis-ci.com/wmurphyrd/aframe-super-hands-component)
 [![npm Dowloads](https://img.shields.io/npm/dt/super-hands.svg?style=flat-square)](https://www.npmjs.com/package/super-hands)
 [![npm Version](http://img.shields.io/npm/v/super-hands.svg?style=flat-square)](https://www.npmjs.com/package/super-hands)
 [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
@@ -56,9 +56,9 @@ Install and use by directly by including the [browser files](dist):
 ```html
 <head>
   <title>Most Basic Super-Hands Example</title>
-  <script src="https://aframe.io/releases/0.8.2/aframe.min.js"></script>
+  <script src="https://aframe.io/releases/1.0.4/aframe.min.js"></script>
   <script src="https://cdn.rawgit.com/donmccurdy/aframe-extras/v4.1.2/dist/aframe-extras.min.js"></script>
-  <script src="https://unpkg.com/super-hands@3.0.0/dist/super-hands.min.js"></script>
+  <script src="https://unpkg.com/super-hands@^3.0.1/dist/super-hands.min.js"></script>
 </head>
 
 <body>
@@ -117,6 +117,12 @@ The [examples page](https://wmurphyrd.github.io/aframe-super-hands-component/exa
 
 ## News
 
+v3.0.1
+
+* A-Frame 1.0.4 support confirmation
+  * Updated dependencies and fixed tests
+  * No notable changes
+
 v3.0.0
 
 * The 'Less is More' update. This package has scope has been narrowed to keep
@@ -155,15 +161,16 @@ v3.0.0
 
 ## Compatibility
 
-With `progressive-controls`, `super-hands` can provide interactive controls
+With the right configuration, `super-hands` can provide interactive controls
 for any device: desktop, mobile ("magic window"), cardboard viewer + button,
-Daydream, GearVR, Vive, and Rift + Touch.
+3DOF (Daydream, GearVR) and full 6DOF tracked controls (Vive, Oculus Touch, Valve Index, et c).
 
 `super-hands` dependency version compatibility:
 
 | super-hands Version | A-Frame Version | aframe-extras Version | aframe-physics-system Version |
 | --- | --- | --- | --- |
-| ^v3.0.0 | >=v0.8.2 | ^v4.1.2 | ^v3.1.2 |
+| ^v3.0.1 | ^v1.0.4 | ^v6.1.1 | ^v4.0.1 |
+| v3.0.0 | ^v0.8.2 | ^v4.1.2 | ^v3.1.2 |
 | ^v2.0.0 | v0.6.x | ^v3.11.4 | ^v2.0.0 |
 
 ## Core Component
diff --git a/examples/events/index.html b/examples/events/index.html
@@ -4,7 +4,7 @@
     <!-- Replace "../build.js" with the super-hands and
          A-Frame distributions to run : -->
     <script src="../build.js"></script>
-    <!-- <script src="https://aframe.io/releases/0.8.2/aframe.min.js"></script> -->
+    <!-- <script src="https://aframe.io/releases/1.0.4/aframe.min.js"></script> -->
     <!-- <script src="https://unpkg.com/super-hands/dist/super-hands.min.js"></script> -->
     <script src="//cdn.rawgit.com/donmccurdy/aframe-extras/v3.12.4/dist/aframe-extras.min.js"></script>
     <script src="https://rawgit.com/feiss/aframe-environment-component/master/dist/aframe-environment-component.min.js"></script>
diff --git a/examples/index.html b/examples/index.html
@@ -72,7 +72,7 @@ <h1>A-Frame Super Hands Component</h1>
       <img class="preview" src="./assets/physics.jpg"/>
       <!-- <div class="bonus"></div> -->
     </a>
-    <p><a href="mouse/index-mouse.html">Mouse cursor based version for desktop</a></p>
+    <p><a href="physics/index-mouse.html">Mouse cursor based version for desktop</a></p>
     <p><ul>
       <li>Grabbed boxes lock position and rotation to controller</li>
       <li><code>color-randomizer</code> changes the color of entities dropped inside of the color changer box</li>
@@ -119,6 +119,7 @@ <h1>A-Frame Super Hands Component</h1>
              colliderEndEventProperty: clearedEls"</pre>
     <p>This scene also shows the fallback movement that occurs when physics
       is not available.</p>
+  <!--
     <a id="sticky" class="example" href="sticky/">Sticky Grab via
       Custom Button Mapping<br />
       <img class="preview" src="./assets/sticky.jpg"/>
@@ -130,6 +131,7 @@ <h1>A-Frame Super Hands Component</h1>
       <li>Press trackpad to drop the bat</li>
       <li>Stretch the balls by pressing both trackpads</li>
     </ul>
+  -->
     <!-- GitHub Corner. -->
     <a href="https://github.com/wmurphyrd/aframe-super-hands-component" class="github-corner">
       <svg width="80" height="80" viewBox="0 0 250 250" style="fill:#222; color:#fff; position: absolute; top: 0; border: 0; right: 0;">
diff --git a/examples/mouse/index-mouse.html b/examples/mouse/index-mouse.html
@@ -4,7 +4,7 @@
     <!-- Replace "../build.js" with the super-hands and
          A-Frame distributions to run : -->
     <script src="../build.js"></script>
-    <!-- <script src="https://aframe.io/releases/0.8.2/aframe.min.js"></script> -->
+    <!-- <script src="https://aframe.io/releases/1.0.4/aframe.min.js"></script> -->
     <!-- <script src="https://unpkg.com/super-hands/dist/super-hands.min.js"></script> -->
     <script src="https://unpkg.com/aframe-event-set-component@^4.0.0/dist/aframe-event-set-component.min.js"></script>
     <script src="https://rawgit.com/feiss/aframe-environment-component/master/dist/aframe-environment-component.min.js"></script>
diff --git a/examples/mouse/index.html b/examples/mouse/index.html
@@ -4,7 +4,7 @@
     <!-- Replace "../build.js" with the super-hands and
          A-Frame distributions to run : -->
     <script src="../build.js"></script>
-    <!-- <script src="https://aframe.io/releases/0.8.2/aframe.min.js"></script> -->
+    <!-- <script src="https://aframe.io/releases/1.0.4/aframe.min.js"></script> -->
     <!-- <script src="https://unpkg.com/super-hands/dist/super-hands.min.js"></script> -->
     <script src="https://unpkg.com/aframe-event-set-component@^4.0.0/dist/aframe-event-set-component.min.js"></script>
     <script src="https://rawgit.com/feiss/aframe-environment-component/master/dist/aframe-environment-component.min.js"></script>
diff --git a/examples/physics/index-laser.html b/examples/physics/index-laser.html
@@ -4,9 +4,9 @@
     <!-- Replace "../build.js" with the super-hands and
          A-Frame distributions to run : -->
     <script src="../build.js"></script>
-    <!-- <script src="https://aframe.io/releases/0.8.2/aframe.min.js"></script> -->
+    <!-- <script src="https://aframe.io/releases/1.0.4/aframe.min.js"></script> -->
     <!-- <script src="https://unpkg.com/super-hands/dist/super-hands.min.js"></script> -->
-    <script src="//cdn.rawgit.com/donmccurdy/aframe-physics-system/v3.1.2/dist/aframe-physics-system.min.js"></script>
+    <script src="https://cdn.jsdelivr.net/gh/n5ro/aframe-physics-system@v4.0.1/dist/aframe-physics-system.js"></script>
     <script src="https://unpkg.com/aframe-event-set-component@^4.1.1/dist/aframe-event-set-component.min.js"></script>
     <script src="https://unpkg.com/aframe-physics-extras/dist/aframe-physics-extras.min.js"></script>
     <script src="https://rawgit.com/feiss/aframe-environment-component/master/dist/aframe-environment-component.min.js"></script>
diff --git a/examples/physics/index-mouse.html b/examples/physics/index-mouse.html
@@ -92,6 +92,6 @@
         <path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path><path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path><path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path>
       </svg>
     </a>
-    <style>.github-corner:hover .octo-arm{animation:octocat-wave 560ms ease-in-out}@keyframes octocat-wave{0%,100%{transform:rotate(0)}20%,60%{transform:rotate(-25deg)}40%,80%{transform:rotate(10deg)}}@media (max-width:500px){.github-corner:hover .octo-arm{animation:none}.github-corner .octo-arm{animation:octocat-wave 560ms ease-in-out}}
+    <style>.github-corner:hover .octo-arm{animation:octocat-wave 560ms ease-in-out}@keyframes octocat-wave{0%,100%{transform:rotate(0)}20%,60%{transform:rotate(-25deg)}40%,80%{transform:rotate(10deg)}}@media (max-width:500px){.github-corner:hover .octo-arm{animation:none}.github-corner .octo-arm{animation:octocat-wave 560ms ease-in-out}}</style>
   </body>
 </html>
diff --git a/examples/physics/index.html b/examples/physics/index.html
@@ -4,9 +4,9 @@
     <!-- Replace "../build.js" with the super-hands and
          A-Frame distributions to run : -->
     <script src="../build.js"></script>
-    <!-- <script src="https://aframe.io/releases/0.8.2/aframe.min.js"></script> -->
+    <!-- <script src="https://aframe.io/releases/1.0.4/aframe.min.js"></script> -->
     <!-- <script src="https://unpkg.com/super-hands/dist/super-hands.min.js"></script> -->
-    <script src="//cdn.rawgit.com/donmccurdy/aframe-physics-system/v3.1.2/dist/aframe-physics-system.min.js"></script>
+    <script src="https://cdn.jsdelivr.net/gh/n5ro/aframe-physics-system@v4.0.1/dist/aframe-physics-system.js"></script>
     <script src="https://unpkg.com/aframe-event-set-component@^4.1.1/dist/aframe-event-set-component.min.js"></script>
     <script src="https://unpkg.com/aframe-physics-extras/dist/aframe-physics-extras.min.js"></script>
     <script src="https://rawgit.com/feiss/aframe-environment-component/master/dist/aframe-environment-component.min.js"></script>
@@ -67,14 +67,10 @@
       <a-entity>
         <a-camera positon="0 1.6 0"></a-camera>
         <a-entity id="rhand" mixin="touch"
-                  vive-controls="hand: right"
-                  oculus-touch-controls="hand: right"
-                  windows-motion-controls="hand: right">
+                  hand-controls="hand: right">
         </a-entity>
         <a-entity id="lhand" mixin="touch"
-                  vive-controls="hand: left"
-                  oculus-touch-controls="hand: left"
-                  windows-motion-controls="hand: left">
+                  hand-controls="hand: left">
         </a-entity>
       </a-entity>
       <a-entity class="cube" mixin="cube" position="0 0.265 -1" material="color: red"></a-entity>
@@ -86,7 +82,7 @@
       <a-entity class="transformer" mixin="transformer" position = "0 1.6 -1"
                 material="src:#colortransform" shadow></a-entity>
       <!-- ground collider keeps objets from falling -->
-      <a-box static-body width=100 height=0.001 depth=100 visible="false"></a-box>
+      <a-box static-body width="100" height="0.01" depth="100" visible="false"></a-box>
       <a-link href="../mouse" title="Basic Example"
               static-body="shape: sphere; sphereRadius: 0.25"
               image="#portals-preview"
@@ -102,6 +98,6 @@
         <path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path><path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path><path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path>
       </svg>
     </a>
-    <style>.github-corner:hover .octo-arm{animation:octocat-wave 560ms ease-in-out}@keyframes octocat-wave{0%,100%{transform:rotate(0)}20%,60%{transform:rotate(-25deg)}40%,80%{transform:rotate(10deg)}}@media (max-width:500px){.github-corner:hover .octo-arm{animation:none}.github-corner .octo-arm{animation:octocat-wave 560ms ease-in-out}}
+    <style>.github-corner:hover .octo-arm{animation:octocat-wave 560ms ease-in-out}@keyframes octocat-wave{0%,100%{transform:rotate(0)}20%,60%{transform:rotate(-25deg)}40%,80%{transform:rotate(10deg)}}@media (max-width:500px){.github-corner:hover .octo-arm{animation:none}.github-corner .octo-arm{animation:octocat-wave 560ms ease-in-out}}</style>
   </body>
 </html>
diff --git a/examples/portals.html b/examples/portals.html
@@ -4,7 +4,7 @@
     <!-- Replace "../build.js" with the super-hands and
          A-Frame distributions to run : -->
     <script src="./build.js"></script>
-    <!-- <script src="https://aframe.io/releases/0.8.2/aframe.min.js"></script> -->
+    <!-- <script src="https://aframe.io/releases/1.0.4/aframe.min.js"></script> -->
     <!-- <script src="https://unpkg.com/super-hands/dist/super-hands.min.js"></script> -->
     <script src="//cdn.rawgit.com/donmccurdy/aframe-extras/v3.12.4/dist/aframe-extras.min.js"></script>
     <script src="https://cdn.rawgit.com/feiss/aframe-environment-component/a33afd32/dist/aframe-environment-component.min.js"></script>
diff --git a/examples/sticky/index.html b/examples/sticky/index.html
@@ -4,9 +4,8 @@
     <!-- Replace "../build.js" with the super-hands and
          A-Frame distributions to run : -->
     <script src="../build.js"></script>
-    <!-- <script src="https://aframe.io/releases/0.8.2/aframe.min.js"></script> -->
+    <!-- <script src="https://aframe.io/releases/1.0.4/aframe.min.js"></script> -->
     <!-- <script src="https://unpkg.com/super-hands/dist/super-hands.min.js"></script> -->
-    <script src="//cdn.rawgit.com/donmccurdy/aframe-extras/v3.12.4/dist/aframe-extras.min.js"></script>
     <script src="//cdn.rawgit.com/donmccurdy/aframe-physics-system/v2.0.0/dist/aframe-physics-system.min.js"></script>
     <script src="https://unpkg.com/aframe-event-set-component@^4.0.0/dist/aframe-event-set-component.min.js"></script>
     <script src="https://rawgit.com/feiss/aframe-environment-component/master/dist/aframe-environment-component.min.js"></script>
@@ -35,16 +34,16 @@
         <img id="portals-preview" src="../assets/portals.jpg"></img>
       </a-assets>
       <a-entity>
-        <a-entity hand-controls="left" mixin="controller"></a-entity>
-        <a-entity hand-controls="right" mixin="controller"></a-entity>
+        <a-entity hand-controls="hand: left" mixin="controller"></a-entity>
+        <a-entity hand-controls="hand: right" mixin="controller"></a-entity>
       </a-entity>
       <a-entity class="ball" mixin="ball" position="0 0.45 -1" material="color: red"></a-entity>
       <a-entity class="ball" mixin="ball" position="0 0.45 1" material="color: red"></a-entity>
       <a-entity class="ball" mixin="ball" position="-1 0.45 -1" material="color: blue"></a-entity>
       <a-entity class="ball" mixin="ball" position="-1 0.45 1" material="color: blue"></a-entity>
       <a-entity class="ball" mixin="ball" position="1 0.45 -1" material="color: green"></a-entity>
       <a-entity class="ball" mixin="ball" position="1 0.45 1" material="color: green"></a-entity>
-      <a-cone id="stick" mixin="bat" position="0 0.5 0" height="1" dynamic-body
+      <a-cone id="stick" mixin="bat" position="0 1 0" height="1" dynamic-body
               rotation="0 0 -90" radius-top="0.03" radius-bottom="0.02" >
       </a-cone>
       <a-box mixin="floor" rotation="-90 0 0" position="0 0.01 0"></a-box>
@@ -66,6 +65,6 @@
         <path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path><path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path><path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path>
       </svg>
     </a>
-    <style>.github-corner:hover .octo-arm{animation:octocat-wave 560ms ease-in-out}@keyframes octocat-wave{0%,100%{transform:rotate(0)}20%,60%{transform:rotate(-25deg)}40%,80%{transform:rotate(10deg)}}@media (max-width:500px){.github-corner:hover .octo-arm{animation:none}.github-corner .octo-arm{animation:octocat-wave 560ms ease-in-out}}
+    <style>.github-corner:hover .octo-arm{animation:octocat-wave 560ms ease-in-out}@keyframes octocat-wave{0%,100%{transform:rotate(0)}20%,60%{transform:rotate(-25deg)}40%,80%{transform:rotate(10deg)}}@media (max-width:500px){.github-corner:hover .octo-arm{animation:none}.github-corner .octo-arm{animation:octocat-wave 560ms ease-in-out}}</style>
   </body>
 </html>
diff --git a/examples/super-basic/index.html b/examples/super-basic/index.html
@@ -1,6 +1,6 @@
 <head>
   <title>Most Basic Super-Hands Example</title>
-  <script src="https://aframe.io/releases/0.8.2/aframe.min.js"></script>
+  <script src="https://aframe.io/releases/1.0.4/aframe.min.js"></script>
   <script src="https://cdn.rawgit.com/donmccurdy/aframe-extras/v4.1.2/dist/aframe-extras.min.js"></script>
   <script src="https://rawgit.com/wmurphyrd/aframe-super-hands-component/master/dist/super-hands.js"></script>
 </head>
@@ -10,8 +10,8 @@
     <a-assets></a-assets>
     <a-entity>
       <a-camera></a-camera>
-      <a-entity sphere-collider="objects: a-box" super-hands hand-controls="left"></a-entity>
-      <a-entity sphere-collider="objects: a-box" super-hands hand-controls="right"></a-entity>
+      <a-entity sphere-collider="objects: a-box" super-hands hand-controls="hand: left"></a-entity>
+      <a-entity sphere-collider="objects: a-box" super-hands hand-controls="hand: right"></a-entity>
     </a-entity>
     <!-- hover & drag-drop won't have any obvious effect without some additional event handlers or components. See the examples page for more -->
     <a-box hoverable grabbable stretchable draggable dropppable color="blue" position="0 0 -1"></a-box>
diff --git a/examples/touch-test/index.html b/examples/touch-test/index.html
@@ -1,6 +1,6 @@
 <head>
   <title>Most Basic Super-Hands Example</title>
-  <script src="https://aframe.io/releases/0.8.2/aframe.js"></script>
+  <script src="https://aframe.io/releases/1.0.4/aframe.js"></script>
   <script src="//cdn.rawgit.com/donmccurdy/aframe-extras/v3.12.4/dist/aframe-extras.min.js"></script>
   <script src="https://unpkg.com/aframe-state-component/dist/aframe-state-component.min.js"></script>
   <script src="../build.js"></script>
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -47,7 +47,7 @@
   "devDependencies": {
     "aframe": "^1.0.4",
     "aframe-event-set-component": "^4.0.0",
-    "aframe-extras": "^4.1.2",
+    "aframe-extras": "^6.1.1",
     "aframe-machinima-testing": "^0.1.2",
     "aframe-motion-capture-components": "github:wmurphyrd/aframe-motion-capture-components#v0.2.8a",
     "aframe-physics-system": "^4.0.1",
