use better default schema with the requiresNetworkUpdate optimization…

… for position and rotation (#367)
networked-aframe · Sep 17, 2022 · d4e80ae · d4e80ae
1 parent 8ca8d57
commit d4e80ae
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -327,17 +327,19 @@ and rotation precision of 0.5 degree, use it like this:
   template: '#avatar-template',
   components: [
     {
-      component: "position",
+      component: 'position',
       requiresNetworkUpdate: NAF.utils.vectorRequiresUpdate(0.001)
     },
     {
-      component: "rotation",
+      component: 'rotation',
       requiresNetworkUpdate: NAF.utils.vectorRequiresUpdate(0.5)
     }
   ]
 }
 ```
 
+The default schema that sync position and rotation uses the above optimization since version 0.11.0.
+
 ### Syncing nested templates - eg. hands
 
 To sync nested templates setup your HTML nodes like so:
@@ -404,16 +406,28 @@ Default templates and networked schemas are already defined as follow:
 NAF.schemas.add({
   template: '#left-hand-default-template'
   components: [
-    'position',
-    'rotation',
+    {
+      component: 'position',
+      requiresNetworkUpdate: NAF.utils.vectorRequiresUpdate(0.001)
+    },
+    {
+      component: 'rotation',
+      requiresNetworkUpdate: NAF.utils.vectorRequiresUpdate(0.5)
+    },
     'networked-hand-controls'
   ]
 });
 NAF.schemas.add({
   template: '#right-hand-default-template'
   components: [
-    'position',
-    'rotation',
+    {
+      component: 'position',
+      requiresNetworkUpdate: NAF.utils.vectorRequiresUpdate(0.001)
+    },
+    {
+      component: 'rotation',
+      requiresNetworkUpdate: NAF.utils.vectorRequiresUpdate(0.5)
+    },
     'networked-hand-controls'
   ]
 });

diff --git a/src/Schemas.js b/src/Schemas.js
@@ -11,8 +11,14 @@ class Schemas {
     return {
       template: name,
       components: [
-        'position',
-        'rotation',
+        {
+          component: 'position',
+          requiresNetworkUpdate: NAF.utils.vectorRequiresUpdate(0.001)
+        },
+        {
+          component: 'rotation',
+          requiresNetworkUpdate: NAF.utils.vectorRequiresUpdate(0.5)
+        }
       ]
     }
   }

diff --git a/src/components/networked-hand-controls.js b/src/components/networked-hand-controls.js
@@ -29,9 +29,15 @@ function addHandTemplate(hand) {
   NAF.schemas.schemaDict[refTemplateId] = {
     template: refTemplateId,
     components: [
-      'position',
-      'rotation',
-      'networked-hand-controls',
+      {
+        component: 'position',
+        requiresNetworkUpdate: NAF.utils.vectorRequiresUpdate(0.001)
+      },
+      {
+        component: 'rotation',
+        requiresNetworkUpdate: NAF.utils.vectorRequiresUpdate(0.5)
+      },
+      'networked-hand-controls'
     ]
   };
   NAF.schemas.templateCache[refTemplateId] = templateOuter;