Merge pull request #2773 from Ecnassianer/body2Playspace

replacing "Body" with MixedRealityPlayspace

Author: Ecnassianer

Assets/MixedRealityToolkit-Examples/Demos/Boundary/Scripts/BoundaryVisualizationDemo.cs

@@ -42,7 +42,7 @@ private void Awake()
         {
             markerParent = new GameObject();
             markerParent.name = "Boundary Demo Markers";
-            markerParent.transform.parent = CameraCache.Main.transform.parent;
+            markerParent.transform.parent = MixedRealityManager.Instance.MixedRealityPlayspace;
         }
 
         private void Start()

Assets/MixedRealityToolkit-SDK/Features/Boundary/MixedRealityBoundaryManager.cs

@@ -189,7 +189,7 @@ public override void Destroy()
         private GameObject CreateBoundaryVisualizationParent()
         {
             GameObject visualizationParent = new GameObject("Boundary System Visualizations");
-            visualizationParent.transform.parent = CameraCache.Main.transform.parent;
+            visualizationParent.transform.parent = MixedRealityManager.Instance.MixedRealityPlayspace;
 
             return visualizationParent;
         }
@@ -456,7 +456,7 @@ public bool Contains(Vector3 location, Boundary.Type boundaryType = Boundary.Typ
             }
 
             // Handle the user teleporting (boundary moves with them).
-            location = CameraCache.Main.transform.parent.InverseTransformPoint(location);
+            location = MixedRealityManager.Instance.MixedRealityPlayspace.InverseTransformPoint(location);
 
             if (FloorHeight.Value > location.y ||
                 BoundaryHeight < location.y)
@@ -499,7 +499,7 @@ public bool TryGetRectangularBoundsParams(out Vector2 center, out float angle, o
             }
 
             // Handle the user teleporting (boundary moves with them).
-            Vector3 transformedCenter = CameraCache.Main.transform.parent.TransformPoint(
+            Vector3 transformedCenter = MixedRealityManager.Instance.MixedRealityPlayspace.TransformPoint(
                 new Vector3(rectangularBounds.Center.x, 0f, rectangularBounds.Center.y));
 
             center = new Vector2(transformedCenter.x, transformedCenter.z);
@@ -530,9 +530,9 @@ public GameObject GetFloorVisualization()
             currentFloorObject.name = "Boundary System Floor";
             currentFloorObject.transform.localScale = new Vector3(floorScale.x, boundaryObjectThickness, floorScale.y);
             currentFloorObject.transform.Translate(new Vector3(
-                CameraCache.Main.transform.parent.position.x, 
+                MixedRealityManager.Instance.MixedRealityPlayspace.position.x, 
                 FloorHeight.Value - (currentFloorObject.transform.localScale.y * 0.5f), 
-                CameraCache.Main.transform.parent.position.z));
+                MixedRealityManager.Instance.MixedRealityPlayspace.position.z));
             currentFloorObject.GetComponent<Renderer>().sharedMaterial = MixedRealityManager.Instance.ActiveProfile.BoundaryVisualizationProfile.FloorMaterial;
 
             return currentFloorObject;
@@ -606,9 +606,9 @@ public GameObject GetTrackedAreaVisualization()
             currentTrackedAreaObject.layer = ignoreRaycastLayerValue;
             currentTrackedAreaObject.AddComponent<LineRenderer>();
             currentTrackedAreaObject.transform.Translate(new Vector3(
-                CameraCache.Main.transform.parent.position.x,
+                MixedRealityManager.Instance.MixedRealityPlayspace.position.x,
                 boundaryObjectRenderOffset,
-                CameraCache.Main.transform.parent.position.z));
+                MixedRealityManager.Instance.MixedRealityPlayspace.position.z));
 
             // Configure the renderer properties.
             float lineWidth = 0.01f;

Assets/MixedRealityToolkit-SDK/Features/Input/MixedRealityInputManager.cs

@@ -91,12 +91,6 @@ public override void Initialize()
 
         private void InitializeInternal()
         {
-            if (CameraCache.Main.transform.parent == null)
-            {
-                var cameraParent = new GameObject("Body");
-                CameraCache.Main.transform.SetParent(cameraParent.transform);
-            }
-
             focusProvider = CameraCache.Main.gameObject.EnsureComponent<FocusProvider>();
             gazeProvider = CameraCache.Main.gameObject.EnsureComponent<GazeProvider>();
 

Assets/MixedRealityToolkit-SDK/Features/Teleportation/MixedRealityTeleportManager.cs

@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
 using Microsoft.MixedReality.Toolkit.Core.EventDatum.Teleport;
@@ -40,16 +40,6 @@ public override void Initialize()
 
         private void InitializeInternal()
         {
-            if (CameraCache.Main.transform.parent == null)
-            {
-                var cameraParent = new GameObject("Body");
-                CameraCache.Main.transform.SetParent(cameraParent.transform);
-            }
-
-            // Make sure the camera is at the scene origin.
-            CameraCache.Main.transform.parent.transform.position = Vector3.zero;
-            CameraCache.Main.transform.localPosition = Vector3.zero;
-
 #if UNITY_EDITOR
             if (!UnityEditor.EditorApplication.isPlaying)
             {
@@ -247,7 +237,7 @@ private void ProcessTeleportationRequest(TeleportEventData eventData)
         {
             isProcessingTeleportRequest = true;
 
-            var cameraParent = CameraCache.Main.transform.parent;
+            var cameraParent = MixedRealityManager.Instance.MixedRealityPlayspace;
 
             targetRotation = Vector3.zero;
             targetRotation.y = eventData.Pointer.PointerOrientation;

Assets/MixedRealityToolkit-SDK/Features/UX/Scripts/Pointers/TeleportPointer.cs

@@ -303,7 +303,7 @@ public override void OnPositionInputChanged(InputEventData<Vector2> eventData)
                             {
                                 canMove = false;
                                 // Rotate the camera by the rotation amount.  If our angle is positive then rotate in the positive direction, otherwise in the opposite direction.
-                                CameraCache.Main.transform.parent.RotateAround(CameraCache.Main.transform.position, Vector3.up, angle >= 0.0f ? rotationAmount : -rotationAmount);
+                                MixedRealityManager.Instance.MixedRealityPlayspace.RotateAround(CameraCache.Main.transform.position, Vector3.up, angle >= 0.0f ? rotationAmount : -rotationAmount);
                             }
                             else // We may be trying to strafe backwards.
                             {
@@ -317,10 +317,10 @@ public override void OnPositionInputChanged(InputEventData<Vector2> eventData)
                                 if (offsetStrafeAngle > 0 && offsetStrafeAngle < backStrafeActivationAngle)
                                 {
                                     canMove = false;
-                                    var height = CameraCache.Main.transform.parent.position.y;
-                                    var newPosition = -CameraCache.Main.transform.forward * strafeAmount + CameraCache.Main.transform.parent.position;
+                                    var height = MixedRealityManager.Instance.MixedRealityPlayspace.position.y;
+                                    var newPosition = -CameraCache.Main.transform.forward * strafeAmount + MixedRealityManager.Instance.MixedRealityPlayspace.position;
                                     newPosition.y = height;
-                                    CameraCache.Main.transform.parent.position = newPosition;
+                                    MixedRealityManager.Instance.MixedRealityPlayspace.position = newPosition;
                                 }
                             }
                         }

Assets/MixedRealityToolkit/_Core/Devices/BaseController.cs

@@ -185,7 +185,7 @@ private void TryRenderControllerModel(Type controllerType)
             // If we've got a controller model prefab, then place it in the scene.
             if (controllerModel != null)
             {
-                var controllerObject = UnityEngine.Object.Instantiate(controllerModel, CameraCache.Main.transform.parent);
+                var controllerObject = UnityEngine.Object.Instantiate(controllerModel, MixedRealityManager.Instance.MixedRealityPlayspace);
                 controllerObject.name = $"{ControllerHandedness}_{controllerObject.name}";
                 var poseSynchronizer = controllerObject.GetComponent<IMixedRealityControllerPoseSynchronizer>();
 

Assets/MixedRealityToolkit/_Core/Devices/BaseDeviceManager.cs

@@ -82,7 +82,7 @@ protected virtual IMixedRealityPointer[] RequestPointers(SystemType controllerTy
                     {
                         var pointerObject = Object.Instantiate(pointerProfile.PointerPrefab);
                         var pointer = pointerObject.GetComponent<IMixedRealityPointer>();
-                        pointerObject.transform.SetParent(CameraCache.Main.transform.parent);
+                        pointerObject.transform.SetParent(MixedRealityManager.Instance.MixedRealityPlayspace);
 
                         if (pointer != null)
                         {

Assets/MixedRealityToolkit/_Core/Devices/MixedReality/WindowsMixedRealityController.cs

@@ -243,10 +243,10 @@ private void UpdateGripData(InteractionSourceState interactionSourceState, Mixed
                         interactionSourceState.sourcePose.TryGetPosition(out currentGripPosition, InteractionSourceNode.Grip);
                         interactionSourceState.sourcePose.TryGetRotation(out currentGripRotation, InteractionSourceNode.Grip);
 
-                        if (CameraCache.Main.transform.parent != null)
+                        if (MixedRealityManager.Instance.MixedRealityPlayspace != null)
                         {
-                            currentGripPose.Position = CameraCache.Main.transform.parent.TransformPoint(currentGripPosition);
-                            currentGripPose.Rotation = Quaternion.Euler(CameraCache.Main.transform.parent.TransformDirection(currentGripRotation.eulerAngles));
+                            currentGripPose.Position = MixedRealityManager.Instance.MixedRealityPlayspace.TransformPoint(currentGripPosition);
+                            currentGripPose.Rotation = Quaternion.Euler(MixedRealityManager.Instance.MixedRealityPlayspace.TransformDirection(currentGripRotation.eulerAngles));
                         }
                         else
                         {

Assets/MixedRealityToolkit/_Core/Managers/MixedRealityManager.cs

@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
 using Microsoft.MixedReality.Toolkit.Core.Definitions;
@@ -147,6 +147,7 @@ private void Initialize()
                 }
             }
 #endif
+            EnsureMixedRealityRequirements();
 
             if (ActiveProfile.IsCameraProfileEnabled)
             {
@@ -256,6 +257,13 @@ private void Initialize()
             isMixedRealityManagerInitializing = false;
         }
 
+        private void EnsureMixedRealityRequirements()
+        {
+            // There's lots of documented cases that if the camera doesn't start at 0,0,0, things break with the WMR SDK specifically.
+            // We'll enforce that here, then tracking can update it to the appropriate position later.
+           CameraCache.Main.transform.position = Vector3.zero;
+        }
+
         #region MonoBehaviour Implementation
 
         private static MixedRealityManager instance;
@@ -368,6 +376,53 @@ private void InitializeInternal()
             }
         }
 
+        private Transform mixedRealityPlayspace;
+
+        /// <summary>
+        /// Returns the MixedRealityPlayspace for the local player
+        /// </summary>
+        public Transform MixedRealityPlayspace
+        {
+            get {
+                AssertIsInitialized();
+                if (mixedRealityPlayspace)
+                {
+                    return mixedRealityPlayspace;
+                }
+                else
+                {
+                    string MixedRealityPlayspaceName = "MixedRealityPlayspace";
+                    if (CameraCache.Main.transform.parent == null)
+                    {
+                        mixedRealityPlayspace = new GameObject(MixedRealityPlayspaceName).transform;
+                        CameraCache.Main.transform.SetParent(mixedRealityPlayspace);
+                    }
+                    else
+                    {
+                        if (CameraCache.Main.transform.parent.name != MixedRealityPlayspaceName)
+                        {
+                            // Since the scene is set up with a different camera parent, its likely
+                            // that there's an expectation that that parent is going to be used for
+                            // something else. We print a warning to call out the fact that we're 
+                            // co-opting this object for use with teleporting and such, since that
+                            // might cause conflicts with the parent's intended purpose.
+                            Debug.LogWarning("The Mixed Reality Manager expected the camera's parent to be named " + MixedRealityPlayspaceName + ". The existing parent will be renamed and used instead.");
+                            CameraCache.Main.transform.parent.name = MixedRealityPlayspaceName; // If we rename it, we make it clearer that why it's being teleported around at runtime.
+                        }
+                    }
+
+                    // It's very important that the MixedRealityPlayspace align with the tracked space,
+                    // otherwise reality-locked things like playspace boundaries won't be aligned properly.
+                    // For now, we'll just assume that when the playspace is first initialized, the
+                    // tracked space origin overlaps with the world space origin. If a platform ever does
+                    // something else (i.e, placing the lower left hand corner of the tracked space at world 
+                    // space 0,0,0), we should compensate for that here.
+
+                    return mixedRealityPlayspace;
+                }
+            }
+        }
+
         private void ApplicationOnQuitting()
         {
             DisableAllManagers();