Merge pull request #9 from jbienzms/feature/BetterRecording

Feature Better Recording

Author: jbienzms

External/ReadMeImages/Align-FramesAndStrategies.png

@@ -0,0 +1,42 @@
+# Spatial Alignment for Unity
+This reference architecture includes many helpful components for aligning and keeping virtual objects aligned with the physical world.
+
+### Release 1.0
+Release 1.0 contains the following capabilities:
+
+##### Spatial Frames
+*Spatial Frames* represent "islands" in the real world. They have a position and a rotation and are designed to hold objects. They also have unique IDs and can be available from the moment the application loads (even before they're found in the real world). This simplifies application logic because objects can be loaded up front and automatically aligned when the frame is found. 
+ 
+![](External/ReadMeImages/Align-FramesAndStrategies.png)
+
+##### Alignment Strategies
+Each *Spatial Frame* has an *Alignment Strategy*. The strategy is what moves the frame and keeps it aligned in the physical world. Alignment Strategies are "plugins", and developers can easily create their own strategies. Applications are free to mix and match various strategies in the same application.
+ 
+![](External/ReadMeImages/Align-MixStrategies.png)
+
+Alignment Strategies provide information about their state (e.g. whether they've been found) and their accuracy (maximum drift in meters). Applications can then use this information to make intelligent decisions about the best frames to use contain objects. In fact, one of the included strategies is a *Multi-Parent* strategy that allows objects to automatically "hop" parent frames based on their state and accuracy.   
+
+![](External/ReadMeImages/Align-ParentHopping.png)
+
+##### Refinement
+Two of the greatest challenges with spatial alignment are:
+
+1.  Initial placement (and rotation) of objects to match up with the physical world
+2.  Accounting for drift that accumulates over distance (a challenge that is present in all large-scale tracking systems)
+
+This reference architecture includes components to help address both. To help with accurate alignment, an extensible system of *Refinement Controllers* is provided. In version 1.0 there is one refinement controller included called **RayRefinement**. **RayRefinement** allows a virtual model and a physical space to be aligned by selecting the corresponding origin points and a direction.
+
+
+**TODO: RayRefinement Video**    
+
+
+
+
+##### Persistence
+
+
+##### Examples
+
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). 
+For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.

External/ReadMeImages/Align-MixStrategies.png

@@ -9,14 +9,14 @@ Material:
   m_PrefabAsset: {fileID: 0}
   m_Name: Room
   m_Shader: {fileID: 4800000, guid: d45c0efca53019e43891b0f610f8146e, type: 3}
-  m_ShaderKeywords: _BORDER_LIGHT_USES_HOVER_COLOR _HOVER_LIGHT _SMOOTHNESS_TEXTURE_ALBEDO_CHANNEL_A
+  m_ShaderKeywords: _ALPHATEST_ON _BORDER_LIGHT_USES_HOVER_COLOR _HOVER_LIGHT _SMOOTHNESS_TEXTURE_ALBEDO_CHANNEL_A
     _SPECULAR_HIGHLIGHTS
   m_LightmapFlags: 4
   m_EnableInstancingVariants: 0
   m_DoubleSidedGI: 0
-  m_CustomRenderQueue: 2000
+  m_CustomRenderQueue: 2450
   stringTagMap:
-    RenderType: Opaque
+    RenderType: TransparentCutout
   disabledShaderPasses: []
   m_SavedProperties:
     serializedVersion: 3
@@ -75,7 +75,7 @@ Material:
     - _ClippingPlaneBorderWidth: 0.025
     - _ColorWriteMask: 15
     - _CullMode: 2
-    - _CustomMode: 0
+    - _CustomMode: 1
     - _Cutoff: 0.5
     - _DetailNormalMapScale: 1
     - _DirectionalLight: 0
@@ -97,7 +97,7 @@ Material:
     - _HoverLightOpaque: 0
     - _InnerGlow: 0
     - _Metallic: 0
-    - _Mode: 0
+    - _Mode: 1
     - _NearPlaneFade: 0
     - _OcclusionStrength: 1
     - _Parallax: 0.02

External/ReadMeImages/Align-ParentHopping.png

@@ -112,6 +112,75 @@ NavMeshSettings:
     debug:
       m_Flags: 0
   m_NavMeshData: {fileID: 0}
+--- !u!1001 &90715524
+PrefabInstance:
+  m_ObjectHideFlags: 0
+  serializedVersion: 2
+  m_Modification:
+    m_TransformParent: {fileID: 1746543277}
+    m_Modifications:
+    - target: {fileID: 188249851610165992, guid: 5bb225293e05e5846823a417d4471bc6,
+        type: 3}
+      propertyPath: m_Name
+      value: SplitView
+      objectReference: {fileID: 0}
+    - target: {fileID: 188249851610165993, guid: 5bb225293e05e5846823a417d4471bc6,
+        type: 3}
+      propertyPath: m_LocalPosition.x
+      value: 0
+      objectReference: {fileID: 0}
+    - target: {fileID: 188249851610165993, guid: 5bb225293e05e5846823a417d4471bc6,
+        type: 3}
+      propertyPath: m_LocalPosition.y
+      value: 0
+      objectReference: {fileID: 0}
+    - target: {fileID: 188249851610165993, guid: 5bb225293e05e5846823a417d4471bc6,
+        type: 3}
+      propertyPath: m_LocalPosition.z
+      value: 0.86
+      objectReference: {fileID: 0}
+    - target: {fileID: 188249851610165993, guid: 5bb225293e05e5846823a417d4471bc6,
+        type: 3}
+      propertyPath: m_LocalRotation.x
+      value: -0
+      objectReference: {fileID: 0}
+    - target: {fileID: 188249851610165993, guid: 5bb225293e05e5846823a417d4471bc6,
+        type: 3}
+      propertyPath: m_LocalRotation.y
+      value: -0
+      objectReference: {fileID: 0}
+    - target: {fileID: 188249851610165993, guid: 5bb225293e05e5846823a417d4471bc6,
+        type: 3}
+      propertyPath: m_LocalRotation.z
+      value: -0
+      objectReference: {fileID: 0}
+    - target: {fileID: 188249851610165993, guid: 5bb225293e05e5846823a417d4471bc6,
+        type: 3}
+      propertyPath: m_LocalRotation.w
+      value: 1
+      objectReference: {fileID: 0}
+    - target: {fileID: 188249851610165993, guid: 5bb225293e05e5846823a417d4471bc6,
+        type: 3}
+      propertyPath: m_RootOrder
+      value: 2
+      objectReference: {fileID: 0}
+    - target: {fileID: 188249851610165993, guid: 5bb225293e05e5846823a417d4471bc6,
+        type: 3}
+      propertyPath: m_LocalEulerAnglesHint.x
+      value: 0
+      objectReference: {fileID: 0}
+    - target: {fileID: 188249851610165993, guid: 5bb225293e05e5846823a417d4471bc6,
+        type: 3}
+      propertyPath: m_LocalEulerAnglesHint.y
+      value: 0
+      objectReference: {fileID: 0}
+    - target: {fileID: 188249851610165993, guid: 5bb225293e05e5846823a417d4471bc6,
+        type: 3}
+      propertyPath: m_LocalEulerAnglesHint.z
+      value: 0
+      objectReference: {fileID: 0}
+    m_RemovedComponents: []
+  m_SourcePrefab: {fileID: 100100000, guid: 5bb225293e05e5846823a417d4471bc6, type: 3}
 --- !u!1 &97103547
 GameObject:
   m_ObjectHideFlags: 0
@@ -417,7 +486,7 @@ GameObject:
   m_Icon: {fileID: 0}
   m_NavMeshLayer: 0
   m_StaticEditorFlags: 0
-  m_IsActive: 1
+  m_IsActive: 0
 --- !u!4 &332004588
 Transform:
   m_ObjectHideFlags: 0
@@ -742,7 +811,7 @@ GameObject:
   m_Icon: {fileID: 0}
   m_NavMeshLayer: 0
   m_StaticEditorFlags: 0
-  m_IsActive: 1
+  m_IsActive: 0
 --- !u!4 &1478666015
 Transform:
   m_ObjectHideFlags: 0
@@ -966,7 +1035,7 @@ GameObject:
   m_Icon: {fileID: 0}
   m_NavMeshLayer: 0
   m_StaticEditorFlags: 0
-  m_IsActive: 1
+  m_IsActive: 0
 --- !u!4 &1891623027
 Transform:
   m_ObjectHideFlags: 0
@@ -1100,75 +1169,6 @@ MeshFilter:
   m_PrefabAsset: {fileID: 0}
   m_GameObject: {fileID: 2059821774}
   m_Mesh: {fileID: 10207, guid: 0000000000000000e000000000000000, type: 0}
---- !u!1001 &188249851934458066
-PrefabInstance:
-  m_ObjectHideFlags: 0
-  serializedVersion: 2
-  m_Modification:
-    m_TransformParent: {fileID: 1746543277}
-    m_Modifications:
-    - target: {fileID: 188249851610165992, guid: 5bb225293e05e5846823a417d4471bc6,
-        type: 3}
-      propertyPath: m_Name
-      value: SplitView
-      objectReference: {fileID: 0}
-    - target: {fileID: 188249851610165993, guid: 5bb225293e05e5846823a417d4471bc6,
-        type: 3}
-      propertyPath: m_LocalPosition.x
-      value: 0
-      objectReference: {fileID: 0}
-    - target: {fileID: 188249851610165993, guid: 5bb225293e05e5846823a417d4471bc6,
-        type: 3}
-      propertyPath: m_LocalPosition.y
-      value: 0
-      objectReference: {fileID: 0}
-    - target: {fileID: 188249851610165993, guid: 5bb225293e05e5846823a417d4471bc6,
-        type: 3}
-      propertyPath: m_LocalPosition.z
-      value: 0.31
-      objectReference: {fileID: 0}
-    - target: {fileID: 188249851610165993, guid: 5bb225293e05e5846823a417d4471bc6,
-        type: 3}
-      propertyPath: m_LocalRotation.x
-      value: -0
-      objectReference: {fileID: 0}
-    - target: {fileID: 188249851610165993, guid: 5bb225293e05e5846823a417d4471bc6,
-        type: 3}
-      propertyPath: m_LocalRotation.y
-      value: -0
-      objectReference: {fileID: 0}
-    - target: {fileID: 188249851610165993, guid: 5bb225293e05e5846823a417d4471bc6,
-        type: 3}
-      propertyPath: m_LocalRotation.z
-      value: -0
-      objectReference: {fileID: 0}
-    - target: {fileID: 188249851610165993, guid: 5bb225293e05e5846823a417d4471bc6,
-        type: 3}
-      propertyPath: m_LocalRotation.w
-      value: 1
-      objectReference: {fileID: 0}
-    - target: {fileID: 188249851610165993, guid: 5bb225293e05e5846823a417d4471bc6,
-        type: 3}
-      propertyPath: m_RootOrder
-      value: 2
-      objectReference: {fileID: 0}
-    - target: {fileID: 188249851610165993, guid: 5bb225293e05e5846823a417d4471bc6,
-        type: 3}
-      propertyPath: m_LocalEulerAnglesHint.x
-      value: 0
-      objectReference: {fileID: 0}
-    - target: {fileID: 188249851610165993, guid: 5bb225293e05e5846823a417d4471bc6,
-        type: 3}
-      propertyPath: m_LocalEulerAnglesHint.y
-      value: 0
-      objectReference: {fileID: 0}
-    - target: {fileID: 188249851610165993, guid: 5bb225293e05e5846823a417d4471bc6,
-        type: 3}
-      propertyPath: m_LocalEulerAnglesHint.z
-      value: 0
-      objectReference: {fileID: 0}
-    m_RemovedComponents: []
-  m_SourcePrefab: {fileID: 100100000, guid: 5bb225293e05e5846823a417d4471bc6, type: 3}
 --- !u!1001 &1633407210776251376
 PrefabInstance:
   m_ObjectHideFlags: 0

External/ReadMeImages/Align-Persistence.png

@@ -357,7 +357,16 @@ protected virtual void OnInputClicked(InputClickedEventData eventData)
         /// <inheritdoc />
         protected override void OnRefinementCanceled()
         {
+            // Re-show meshes?
+            if (autoHideMeshes)
+            {
+                this.gameObject.SetMeshesEnabled(enabled: true, inChildren: true);
+            }
+
+            // Cleanup resources
             StopAndCleanup();
+
+            // Pass to base to finish
             base.OnRefinementCanceled();
         }