fix(Runtime): Allow controlling blendshape example's constraints via skeletal state

Summary:
The blendshape mapping character has constraints that constantly add an offset to the head and neck bones per frame to make the character look better. During each frame:

1. OVRSkeleton updates the bone positions.
2. Two constraints move the head up and neck down so that the character does not look so compressed. This is done using a per-frame offset.

The problem is that if the user takes the headset off, #1 does not run, but the constraints from #2 will continue to affect the bones. They will continue to add offsets to the head and neck bones for each new frame, causing a strange stretch. Their existence depends on the skeleton updating the bone position *first* so that they can tweak it via an offset.

The constraints should not run if the skeletal data is not valid or not initialized. This will prevent the constraints from running when the user's positions are not being set.

Reviewed By: andkim-meta

Differential Revision: D49867991

fbshipit-source-id: 59562b742253a1a694b270f99433b7e37f9c5969

Author: sohailshafiiWk

Runtime/Scripts/Tooltips.cs

@@ -1634,4 +1634,13 @@ public static class OVRBodyTrackingStateListenerTooltips
         public const string MaxWaitTimeForBodyTracking =
             "How many seconds before body tracking times out and is considered disconnected";
     }
+
+    public static class ToggleConstraintsSkeletonStateTooltips
+    {
+        public const string Constraints =
+            "Constraints to control the weight of.";
+
+        public const string Skeleton =
+            "The skeleton object that needs to be tracked.";
+    }
 }

Runtime/Scripts/Utils/ToggleConstraintsSkeletonState.cs

@@ -0,0 +1,59 @@
+// Copyright (c) Meta Platforms, Inc. and affiliates.
+
+using Oculus.Interaction;
+using UnityEngine;
+using UnityEngine.Animations.Rigging;
+using UnityEngine.Assertions;
+
+namespace Oculus.Movement.Utils
+{
+    /// <summary>
+    /// If the bones are not valid then turn off constraints specified.
+    /// This is useful if a constraint depends on the skeleton code to set the
+    /// value of a bone every frame. Like a multi-position constraint that applies
+    /// an offset.
+    /// </summary>
+    public class ToggleConstraintsSkeletonState : MonoBehaviour
+    {
+        /// <summary>
+        /// Constraints to control the weight of.
+        /// </summary>
+        [SerializeField, Interface(typeof(IRigConstraint))]
+        [Tooltip(ToggleConstraintsSkeletonStateTooltips.Constraints)]
+        private MonoBehaviour[] _constraints;
+
+        /// <summary>
+        /// The skeleton object that needs to be tracked.
+        /// </summary>
+        [SerializeField]
+        [Tooltip(ToggleConstraintsSkeletonStateTooltips.Skeleton)]
+        private OVRSkeleton _skeleton;
+
+        private IRigConstraint[] _iRigConstraints;
+        private float[] _originalConstraintWeights;
+
+        private void Awake()
+        {
+            Assert.IsTrue(_constraints != null && _constraints.Length > 0);
+            Assert.IsNotNull(_skeleton);
+
+            _iRigConstraints = new IRigConstraint[_constraints.Length];
+            _originalConstraintWeights = new float[_constraints.Length];
+            for (int i = 0; i < _constraints.Length; i++)
+            {
+                _iRigConstraints[i] = _constraints[i] as IRigConstraint;
+                _originalConstraintWeights[i] = _iRigConstraints[i].weight;
+                Assert.IsNotNull(_iRigConstraints[i]);
+            }
+        }
+
+        private void Update()
+        {
+            bool skeletonValid = _skeleton.IsInitialized && _skeleton.IsDataValid;
+            for (int i = 0; i < _iRigConstraints.Length; i++)
+            {
+                _iRigConstraints[i].weight = skeletonValid ? _originalConstraintWeights[i] : 0.0f;
+            }
+        }
+    }
+}

Runtime/Scripts/Utils/ToggleConstraintsSkeletonState.cs.meta

@@ -825,6 +825,22 @@ MonoBehaviour:
   _rigToggleOnFocus: 1
   _retargetingLayer: {fileID: 0}
   _checkSkeletalUpdatesByProxy: 0
+--- !u!114 &5895253470718524380
+MonoBehaviour:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 607326578965322257}
+  m_Enabled: 1
+  m_EditorHideFlags: 0
+  m_Script: {fileID: 11500000, guid: a87c462fa9931da4b872f37c96a3102a, type: 3}
+  m_Name: 
+  m_EditorClassIdentifier: 
+  _constraints:
+  - {fileID: 1123534316221971162}
+  - {fileID: 4031897247645224307}
+  _skeleton: {fileID: 3946535142790877676}
 --- !u!4 &1122422457210726926 stripped
 Transform:
   m_CorrespondingSourceObject: {fileID: 4131856439344247223, guid: acf265753b6022246b6834742c70714f, type: 3}

Samples/Prefabs/BlendshapeMappingExample/BlendshapeMappingExampleARKITFirstPerson.prefab

@@ -123,6 +123,38 @@ NavMeshSettings:
     debug:
       m_Flags: 0
   m_NavMeshData: {fileID: 0}
+--- !u!1 &11866984
+GameObject:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  serializedVersion: 6
+  m_Component:
+  - component: {fileID: 11866985}
+  m_Layer: 0
+  m_Name: RightControllerInHandAnchor
+  m_TagString: Untagged
+  m_Icon: {fileID: 0}
+  m_NavMeshLayer: 0
+  m_StaticEditorFlags: 0
+  m_IsActive: 1
+--- !u!4 &11866985
+Transform:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 11866984}
+  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_ConstrainProportionsScale: 0
+  m_Children:
+  - {fileID: 2123792917}
+  m_Father: {fileID: 2097346132}
+  m_RootOrder: 2
+  m_LocalEulerAnglesHint: {x: 0, y: 0, z: 0}
 --- !u!1 &23275527
 GameObject:
   m_ObjectHideFlags: 0
@@ -797,6 +829,37 @@ Transform:
   m_CorrespondingSourceObject: {fileID: 2747730224568278618, guid: 70c1ec55e63be294f92b377695e53302, type: 3}
   m_PrefabInstance: {fileID: 1844149371}
   m_PrefabAsset: {fileID: 0}
+--- !u!1 &893696617
+GameObject:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  serializedVersion: 6
+  m_Component:
+  - component: {fileID: 893696618}
+  m_Layer: 0
+  m_Name: RightHandAnchorDetached
+  m_TagString: Untagged
+  m_Icon: {fileID: 0}
+  m_NavMeshLayer: 0
+  m_StaticEditorFlags: 0
+  m_IsActive: 1
+--- !u!4 &893696618
+Transform:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 893696617}
+  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_ConstrainProportionsScale: 0
+  m_Children: []
+  m_Father: {fileID: 1328425359}
+  m_RootOrder: 7
+  m_LocalEulerAnglesHint: {x: 0, y: 0, z: 0}
 --- !u!4 &903951107 stripped
 Transform:
   m_CorrespondingSourceObject: {fileID: 2055742801895016221, guid: 4f6634390b1d87c488b90ffe9aa5d702, type: 3}
@@ -1093,6 +1156,11 @@ Transform:
   m_CorrespondingSourceObject: {fileID: 7449292010121941889, guid: 70c1ec55e63be294f92b377695e53302, type: 3}
   m_PrefabInstance: {fileID: 1844149371}
   m_PrefabAsset: {fileID: 0}
+--- !u!4 &1328425359 stripped
+Transform:
+  m_CorrespondingSourceObject: {fileID: 459718, guid: 126d619cf4daa52469682f85c1378b4a, type: 3}
+  m_PrefabInstance: {fileID: 2097346129}
+  m_PrefabAsset: {fileID: 0}
 --- !u!1001 &1404505943
 PrefabInstance:
   m_ObjectHideFlags: 0
@@ -1622,11 +1690,74 @@ Transform:
   m_CorrespondingSourceObject: {fileID: 8082333127555231696, guid: 4f6634390b1d87c488b90ffe9aa5d702, type: 3}
   m_PrefabInstance: {fileID: 1561311111}
   m_PrefabAsset: {fileID: 0}
+--- !u!1 &1762506789
+GameObject:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  serializedVersion: 6
+  m_Component:
+  - component: {fileID: 1762506790}
+  m_Layer: 0
+  m_Name: LeftHandOnControllerAnchor
+  m_TagString: Untagged
+  m_Icon: {fileID: 0}
+  m_NavMeshLayer: 0
+  m_StaticEditorFlags: 0
+  m_IsActive: 1
+--- !u!4 &1762506790
+Transform:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 1762506789}
+  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_ConstrainProportionsScale: 0
+  m_Children: []
+  m_Father: {fileID: 1779134144}
+  m_RootOrder: 0
+  m_LocalEulerAnglesHint: {x: 0, y: 0, z: 0}
 --- !u!4 &1776024879 stripped
 Transform:
   m_CorrespondingSourceObject: {fileID: 5244368838297366373, guid: 4f6634390b1d87c488b90ffe9aa5d702, type: 3}
   m_PrefabInstance: {fileID: 1561311111}
   m_PrefabAsset: {fileID: 0}
+--- !u!1 &1779134143
+GameObject:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  serializedVersion: 6
+  m_Component:
+  - component: {fileID: 1779134144}
+  m_Layer: 0
+  m_Name: LeftControllerInHandAnchor
+  m_TagString: Untagged
+  m_Icon: {fileID: 0}
+  m_NavMeshLayer: 0
+  m_StaticEditorFlags: 0
+  m_IsActive: 1
+--- !u!4 &1779134144
+Transform:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 1779134143}
+  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_ConstrainProportionsScale: 0
+  m_Children:
+  - {fileID: 1762506790}
+  m_Father: {fileID: 2097346131}
+  m_RootOrder: 2
+  m_LocalEulerAnglesHint: {x: 0, y: 0, z: 0}
 --- !u!4 &1785405832 stripped
 Transform:
   m_CorrespondingSourceObject: {fileID: 1990495893587582008, guid: 70c1ec55e63be294f92b377695e53302, type: 3}
@@ -2693,6 +2824,37 @@ Transform:
   m_CorrespondingSourceObject: {fileID: 1502899699220297356, guid: 70c1ec55e63be294f92b377695e53302, type: 3}
   m_PrefabInstance: {fileID: 1844149371}
   m_PrefabAsset: {fileID: 0}
+--- !u!1 &1954411104
+GameObject:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  serializedVersion: 6
+  m_Component:
+  - component: {fileID: 1954411105}
+  m_Layer: 0
+  m_Name: LeftHandAnchorDetached
+  m_TagString: Untagged
+  m_Icon: {fileID: 0}
+  m_NavMeshLayer: 0
+  m_StaticEditorFlags: 0
+  m_IsActive: 1
+--- !u!4 &1954411105
+Transform:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 1954411104}
+  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_ConstrainProportionsScale: 0
+  m_Children: []
+  m_Father: {fileID: 1328425359}
+  m_RootOrder: 6
+  m_LocalEulerAnglesHint: {x: 0, y: 0, z: 0}
 --- !u!4 &1964776331 stripped
 Transform:
   m_CorrespondingSourceObject: {fileID: 1292583167331237465, guid: 4f6634390b1d87c488b90ffe9aa5d702, type: 3}
@@ -3121,6 +3283,37 @@ MonoBehaviour:
   m_Script: {fileID: 11500000, guid: 13b3318f5d2f2d54393fdd91b1970751, type: 3}
   m_Name: 
   m_EditorClassIdentifier: 
+--- !u!1 &2123792916
+GameObject:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  serializedVersion: 6
+  m_Component:
+  - component: {fileID: 2123792917}
+  m_Layer: 0
+  m_Name: RightHandOnControllerAnchor
+  m_TagString: Untagged
+  m_Icon: {fileID: 0}
+  m_NavMeshLayer: 0
+  m_StaticEditorFlags: 0
+  m_IsActive: 1
+--- !u!4 &2123792917
+Transform:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 2123792916}
+  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_ConstrainProportionsScale: 0
+  m_Children: []
+  m_Father: {fileID: 11866985}
+  m_RootOrder: 0
+  m_LocalEulerAnglesHint: {x: 0, y: 0, z: 0}
 --- !u!4 &2132290614 stripped
 Transform:
   m_CorrespondingSourceObject: {fileID: 3684499879929461753, guid: 70c1ec55e63be294f92b377695e53302, type: 3}