Support for Generic Hands models from the WebXR Input Profiles

Author: De-Panther

MainProject/Packages/manifest.json

@@ -10,7 +10,7 @@
     }
   ],
   "dependencies": {
-    "com.de-panther.webxr-input-profiles-loader": "0.3.5",
+    "com.de-panther.webxr-input-profiles-loader": "0.3.6",
     "com.unity.ide.rider": "2.0.5",
     "com.unity.ide.vscode": "1.2.3",
     "com.unity.test-framework": "1.1.16",

MainProject/Packages/packages-lock.json

@@ -1,7 +1,7 @@
 {
   "dependencies": {
     "com.atteneder.gltfast": {
-      "version": "3.0.2",
+      "version": "3.2.1",
       "depth": 1,
       "source": "registry",
       "dependencies": {
@@ -21,12 +21,12 @@
       }
     },
     "com.de-panther.webxr-input-profiles-loader": {
-      "version": "0.3.5",
+      "version": "0.3.6",
       "depth": 0,
       "source": "registry",
       "dependencies": {
         "com.unity.nuget.newtonsoft-json": "2.0.0",
-        "com.atteneder.gltfast": "3.0.2"
+        "com.atteneder.gltfast": "3.2.1"
       },
       "url": "https://package.openupm.com"
     },

Packages/webxr-interactions/CHANGELOG.md

@@ -5,6 +5,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- Support for Generic Hands models from the WebXR Input Profiles.
+
+### Changed
+- Minimum WebXR Input Profiles Loader version 0.3.6.
 
 ## [0.9.0] - 2021-04-16
 ### Changed

Packages/webxr-interactions/Runtime/Prefabs/WebXRCameraSet.prefab

@@ -283,6 +283,7 @@ Transform:
   m_Children:
   - {fileID: 4008237015318879989}
   - {fileID: 1218315907877956796}
+  - {fileID: 2202373014578844308}
   m_Father: {fileID: 4545079059221816}
   m_RootOrder: 0
   m_LocalEulerAnglesHint: {x: 0, y: 0, z: 0}
@@ -351,6 +352,7 @@ MonoBehaviour:
   useInputProfile: 1
   inputProfileObject: {fileID: 1611361787474004}
   inputProfileModelParent: {fileID: 1469228564561163144}
+  inputProfileHandModelParent: {fileID: 3331348236738357118}
 --- !u!114 &7185579886917944061
 MonoBehaviour:
   m_ObjectHideFlags: 0
@@ -496,6 +498,7 @@ Transform:
   m_Children:
   - {fileID: 3110396931964762061}
   - {fileID: 3819867499605581648}
+  - {fileID: 1956285881968495143}
   m_Father: {fileID: 4545079059221816}
   m_RootOrder: 1
   m_LocalEulerAnglesHint: {x: 0, y: 0, z: 0}
@@ -564,6 +567,7 @@ MonoBehaviour:
   useInputProfile: 1
   inputProfileObject: {fileID: 1611361787474004}
   inputProfileModelParent: {fileID: 599836867309221058}
+  inputProfileHandModelParent: {fileID: 8661450511316122934}
 --- !u!114 &1966769163579045322
 MonoBehaviour:
   m_ObjectHideFlags: 0
@@ -837,6 +841,36 @@ Camera:
   m_OcclusionCulling: 1
   m_StereoConvergence: 10
   m_StereoSeparation: 0.022
+--- !u!1 &3331348236738357118
+GameObject:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  serializedVersion: 6
+  m_Component:
+  - component: {fileID: 2202373014578844308}
+  m_Layer: 0
+  m_Name: HandInputModel
+  m_TagString: Untagged
+  m_Icon: {fileID: 0}
+  m_NavMeshLayer: 0
+  m_StaticEditorFlags: 0
+  m_IsActive: 1
+--- !u!4 &2202373014578844308
+Transform:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 3331348236738357118}
+  m_LocalRotation: {x: -0, y: -0, z: -0, w: 1}
+  m_LocalPosition: {x: 0, y: 0, z: 0}
+  m_LocalScale: {x: 1, y: 1, z: 1}
+  m_Children: []
+  m_Father: {fileID: 4427160273819458}
+  m_RootOrder: 2
+  m_LocalEulerAnglesHint: {x: 0, y: 0, z: 0}
 --- !u!1 &3858442981242374931
 GameObject:
   m_ObjectHideFlags: 0
@@ -1043,3 +1077,33 @@ Camera:
   m_OcclusionCulling: 1
   m_StereoConvergence: 10
   m_StereoSeparation: 0.022
+--- !u!1 &8661450511316122934
+GameObject:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  serializedVersion: 6
+  m_Component:
+  - component: {fileID: 1956285881968495143}
+  m_Layer: 0
+  m_Name: HandInputModel
+  m_TagString: Untagged
+  m_Icon: {fileID: 0}
+  m_NavMeshLayer: 0
+  m_StaticEditorFlags: 0
+  m_IsActive: 1
+--- !u!4 &1956285881968495143
+Transform:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 8661450511316122934}
+  m_LocalRotation: {x: 0, y: 0, z: 0, w: 1}
+  m_LocalPosition: {x: 0, y: 0, z: 0}
+  m_LocalScale: {x: 1, y: 1, z: 1}
+  m_Children: []
+  m_Father: {fileID: 4446684710817404}
+  m_RootOrder: 2
+  m_LocalEulerAnglesHint: {x: 0, y: 0, z: 0}

Packages/webxr-interactions/Runtime/Scripts/ControllerInteraction.cs

@@ -30,13 +30,19 @@ public class ControllerInteraction : MonoBehaviour
 
     private GameObject[] handJointsVisuals = new GameObject[25];
     private Dictionary<int, Transform> handJoints = new Dictionary<int, Transform>();
+    public GameObject inputProfileHandModelParent;
 
 #if WEBXR_INPUT_PROFILES
     private InputProfileLoader inputProfileLoader;
     private InputProfileModel inputProfileModel;
     private bool hasProfileList = false;
     private bool loadedModel = false;
     private string loadedProfile = null;
+
+    private InputProfileModel inputProfileHandModel;
+    private bool loadedHandModel = false;
+    private string loadedHandProfile = null;
+    private Dictionary<int, Transform> handModelJoints = new Dictionary<int, Transform>();
 #endif
 
     private void Awake()
@@ -206,6 +212,27 @@ private void SetHandJointsVisible(bool visible)
     {
       handJointsVisible = visible;
       Drop();
+#if WEBXR_INPUT_PROFILES
+      // We want to use WebXR Input Profiles
+      if (visible && useInputProfile)
+      {
+        if (inputProfileHandModel != null && loadedHandModel)
+        {
+          // There's a loaded Input Profile Model
+          inputProfileHandModelParent.SetActive(true);
+          return;
+        }
+        else if (inputProfileHandModel == null)
+        {
+          // There's no loaded Input Profile Model and it's not in loading process
+          LoadHandInputProfile();
+        }
+      }
+      else
+      {
+        inputProfileHandModelParent.SetActive(false);
+      }
+#endif
       foreach (var visual in handJointsVisuals)
       {
         visual?.SetActive(visible);
@@ -224,7 +251,25 @@ private void OnHandUpdate(WebXRHandData handData)
       }
       Quaternion rotationOffset = Quaternion.Inverse(handData.joints[0].rotation);
 
-      for (int i = 0; i <= WebXRHandData.LITTLE_PHALANX_TIP; i++)
+#if WEBXR_INPUT_PROFILES
+      if (useInputProfile && loadedHandModel)
+      {
+        for (int i = 0; i <= (int)WebXRHandJoint.pinky_finger_tip; i++)
+        {
+          if (handData.joints[i].enabled)
+          {
+            if (handModelJoints.ContainsKey(i))
+            {
+              handModelJoints[i].localPosition = rotationOffset * (handData.joints[i].position - handData.joints[0].position);
+              handModelJoints[i].localRotation = rotationOffset * handData.joints[i].rotation;
+            }
+          }
+        }
+        return;
+      }
+#endif
+
+      for (int i = 0; i <= (int)WebXRHandJoint.pinky_finger_tip; i++)
       {
         if (handData.joints[i].enabled)
         {
@@ -284,6 +329,13 @@ private void LoadInputProfile()
       }
     }
 
+    private void LoadHandInputProfile()
+    {
+      // Start loading the generic hand profile
+      loadedHandProfile = "generic-hand";
+      inputProfileLoader.LoadProfile(new string[] {loadedHandProfile}, OnHandProfileLoaded);
+    }
+
     private void OnProfileLoaded(bool success)
     {
       if (success)
@@ -293,6 +345,15 @@ private void OnProfileLoaded(bool success)
       // Nothing to do if profile didn't load
     }
 
+    private void OnHandProfileLoaded(bool success)
+    {
+      if (success)
+      {
+        LoadHandInputModel();
+      }
+      // Nothing to do if profile didn't load
+    }
+
     private void LoadInputModel()
     {
       inputProfileModel = inputProfileLoader.LoadModelForHand(
@@ -306,6 +367,14 @@ private void LoadInputModel()
       }
     }
 
+    private void LoadHandInputModel()
+    {
+      inputProfileHandModel = inputProfileLoader.LoadModelForHand(
+                              loadedHandProfile,
+                              (InputProfileLoader.Handedness)controller.hand,
+                              HandleHandModelLoaded);
+    }
+
     private void HandleModelLoaded(bool success)
     {
       loadedModel = success;
@@ -333,6 +402,44 @@ private void HandleModelLoaded(bool success)
       }
     }
 
+    private void HandleHandModelLoaded(bool success)
+    {
+      loadedHandModel = success;
+      if (loadedHandModel)
+      {
+        // Set parent only after successful loading, to not interupt loading in case of disabled object
+        var inputProfileModelTransform = inputProfileHandModel.transform;
+        inputProfileModelTransform.SetParent(inputProfileHandModelParent.transform);
+        inputProfileModelTransform.localPosition = Vector3.zero;
+        inputProfileModelTransform.localRotation = Quaternion.identity;
+        inputProfileModelTransform.localScale = Vector3.one;
+        for (int i = 0; i <= (int)WebXRHandJoint.pinky_finger_tip; i++)
+        {
+          handModelJoints.Add(i, inputProfileHandModel.GetChildTransform(((WebXRHandJoint)i).ToString().Replace('_','-')));
+          // It took at least one frame with hand data, there should be hand joint transform
+          if (handJoints.ContainsKey(i))
+          {
+            handModelJoints[i].SetPositionAndRotation(handJoints[i].position, handJoints[i].rotation);
+            var collider = handModelJoints[i].gameObject.AddComponent<SphereCollider>();
+            collider.radius = handJoints[i].localScale.x;
+            collider.isTrigger = true;
+          }
+        }
+        if (handJointsVisible)
+        {
+          inputProfileHandModelParent.SetActive(true);
+          foreach (var visual in handJointsVisuals)
+          {
+            visual?.SetActive(false);
+          }
+        }
+      }
+      else
+      {
+        Destroy(inputProfileHandModel.gameObject);
+      }
+    }
+
     private void UpdateModelInput()
     {
       for (int i = 0; i < 6; i++)

Packages/webxr-interactions/Runtime/Scripts/WebXR.Interactions.asmdef

@@ -14,7 +14,7 @@
     "versionDefines": [
         {
             "name": "com.de-panther.webxr-input-profiles-loader",
-            "expression": "0.3.5",
+            "expression": "0.3.6",
             "define": "WEBXR_INPUT_PROFILES"
         }
     ],