Adding Locomotion to an Avatar

• AnchorToFloor: the vertical position of the avatar is anchored to the floor. This is the default option when using OvrAvatarAnimationBehavior.
• AnchorToHeadset: the vertical position of the avatar is anchored to the user’s headset. This is useful when you need the first- and third-person representations of an avatar to align as much as possible in an MR context. However, this can lead to an avatar either floating above the floor, or clipping into it.
• AnchorToHeadsetDynamicCrouching: This features the same anchoring behavior as AnchorToHeadset, with the added ability to dynamically adjust the crouching state of the avatar, depending on its height above the floor. If the SDK detects that an avatar’s feet are in danger of clipping into the floor, it will automatically trigger crouching at the strength required to prevent clipping. This requires that your avatar have a critical joint defined for either the LeftFootBall joint or the RightFootBall joint in order to function. This can help prevent an avatar from clipping into the floor when using headset anchoring, but please note that it will not help mitigate cases where an avatar would float above the floor.

• Default, built-in animations
• Fully custom animations
• A hybrid mix, using the default animations with some custom animations

1. Open the Avatar Retargeting example scene.
2. Press play.
3. Notice that the avatar appears and is playing an animation.
4. Notice that a copy of Humanoid Avatar Rig Variant - Custom Animation Only is instantiated as a child under the LocalAvatar (which can be found under the Entites object) in the scene hierarchy.
5. Click the Humanoid Avatar Rig Variant - Custom Animation Only object to select the rig.
6. With the Unity Animator⁠ open, the custom animation graph will automatically be displayed.
7. Click the Jump state, and then the Motion parameter’s assigned value.
8. If you inspect the object to which this animation is attached, you will find that it is of a humanoid rig type.
9. Back in the scene, find and select LocalAvatar.
10. Find the attached script called OvrAvatarAnimationBehavior and see that Custom Animations Only is marked true. Checking this box indicates that the animation graph only contains custom animations with and does not contain transition to/from the default animations that’s shipped with the SDK.

1. Import your animation as you normally would⁠. Two important things to note:
   • Your animation must suit Unity’s definition of humanoid animation.
   • Ensure root transform position and rotation are baked into the pose when importing the animation clip into Unity. This can be done under the Animation tab of the animation clip asset.
2. In the import settings, under Rig:
   • Set Animation Type to Humanoid.
   • Leave the rest of the values at default.
3. Set any other import settings as suits your needs, such as loop time.
4. Locate the Humanoid Avatar Rig Variant in the project and create a prefab variant.
   • Important: ensure the new prefab variant is placed inside a Resources folder for it to be dynamically loaded at runtime.
5. Create a new Animator Controller for your motion states and set up the controller however you like.
6. At the root of this prefab, there is an Animator component. Set the controller to the one you just created.
7. Save the prefab and return to the scene.
8. In the Scene hierarchy, navigate to Entities > LocalAvatar.
9. Find the attached script called OvrAvatarAnimationBehavior.
10. Set Custom Animations Only to true.
11. Assign the newly created humanoid avatar rig variant to the Custom Rig Prefab field.
12. Save the scene and press play to view your custom animations!

1. Open the Legs Network Loopback example scene.
2. Press play.
3. Notice that a copy of RTR00003 Variant is instantiated as a child under the LocalAvatar in the scene hierarchy.
4. Click the RTR00003 Variant object to see the rig.
5. Do not change the controller parameter in the Animator on this object, but you can click to view it.
6. Notice that a copy of Humanoid Avatar Rig Variant - Custom Animation Only is also instantiated as a child under the LocalAvatar.
7. Click the Humanoid Avatar Rig Variant - Custom Animation Only object to see the rig.
8. With the Unity Animator⁠ open, click the controller variable on the Humanoid Avatar Rig’s Animator component to see the custom animation graph.
9. Click the Default Animation state.
10. Notice that there is a script called OvrAvatarDefaultStateListener attached.
11. Click the Jump state, and then the Motion parameter’s assigned value.
12. If you inspect the object to which this animation is attached, you will find that it is of a humanoid rig type.
13. Click the transitions. Notice that they allow for Unity’s native animation transitions.
14. With Unity’s Game view focused, Press the 0 key on your keyboard. Notice that the avatar transitions into the animation that was in the custom graph.
15. In the Scene hierarchy, navigate to Entities > LocalAvatar.
16. Notice that the Custom Rig Prefab is the same as the Humanoid Avatar Rig Variant - Custom Animation Only object which was instantiated.
17. Notice that there is a script called SampleCustomAnimationController attached. This is the script that prompts the transition between animations using the 0 key. In your own implementations, you would typically create a similar script instead of using this one.

1. Import your animation as you normally would⁠. Two important things to note:
   • Your animation must suit Unity’s definition of humanoid animation.
   • Ensure root transform position and rotation are baked into the pose when importing the animation clip into Unity. This can be done under the Animation tab of the animation clip asset.
2. In the import settings, under Rig:
   • Set Animation Type to Humanoid.
   • Leave the rest of the values at default.
3. Set any other import settings as suits your needs, such as loop time.
4. Create a new Animator Controller for your motion states.
5. On whichever state you would like to be the default state, assign the OvrAvatarDefaultStateListener script.
6. Do not assign an animation to the default state unless you need one to allow the transition.
7. Set up the controller however you normally would, including parameters to transition in and out of the default state.
8. Locate the Humanoid Avatar Rig Variant in the project and create a prefab variant.
   • Important: ensure the new prefab variant is placed inside a Resources folder for it to be dynamically loaded at runtime.
9. At the root of this prefab, there is an Animator component. Set the controller to the one you just created.
10. Save the prefab and return to the scene.
11. In the Scene hierarchy, navigate to Entities > LocalAvatar.
12. Find the attached script called OvrAvatarAnimationBehavior.
13. Assign the newly created humanoid avatar rig variant to the Custom Rig Prefab field.
14. Write code to trigger the transitions between various states in your animation graph as you normally would.
15. Save the scene and press play to view your custom animations!

1. Add and set up your custom animations as detailed in the Custom Animations Rig Setup section.
2. Find the FBX file for one of the animations that requires foot planting.
3. In the Inspector window corresponding to each individual animation, select the Animation tab.
4. Scroll down until you see a Curves dropdown. Open it.
5. Create two new curves by clicking the + icon.
6. Name these new curves LeftFootPlanted and RightFootPlanted, respectively.
   • Make sure that the names match exactly.
7. Set the curve to have a value of 0 when the foot is off the ground and 1 when it is planted.
   • These values are treated as booleans and as such the transitions from 0 to 1 and vice versa that are shown in the curve will not be represented by the motion of the avatar.
8. Repeat for all the animations that require foot planting.
9. In your custom animation controller, create matching parameters for LeftFootPlanted and RightFootPlanted of type float.
10. Test the animation. Adjust the values in the curves until they plant and lift cleanly.
    • You can watch the values of LeftFootPlanted and RightFootPlanted change in real time if you select the RT Rig Humanoid Variant after having pressed play and have the Unity Animator⁠ open.

• AvatarRetargeting.unity
• LegsNetworkLoopback.unity