Saving and restoring frames from json strings.

Author: Jared Bienz

SpatialAlignment-Unity/Assembly-CSharp.csproj

@@ -831,8 +831,10 @@
     <Compile Include="Assets\SpatialAlignment\Persistence\ISpatialAlignmentStore.cs" />
     <Compile Include="Assets\SpatialAlignment\Persistence\Json\JsonStore.cs" />
     <Compile Include="Assets\SpatialAlignment\Persistence\Json\SpatialFrameConverter.cs" />
+    <Compile Include="Assets\SpatialAlignment\Persistence\Json\Vector3Converter.cs" />
     <Compile Include="Assets\SpatialAlignment\SpatialAlignmentManager.cs" />
     <Compile Include="Assets\SpatialAlignment\SpatialFrame.cs" />
+    <Compile Include="Assets\SpatialAlignment\SpatialFrameCollection.cs" />
     <Compile Include="Assets\SpatialAlignment\Strategies\AlignmentStrategy.cs" />
     <Compile Include="Assets\SpatialAlignment\Strategies\IAlignmentStrategy.cs" />
     <Compile Include="Assets\SpatialAlignment\Strategies\MultiParentAlignment.cs" />

SpatialAlignment-Unity/Assets/SpatialAlignment-Examples/Persistence/Scripts/PersistenceExampleManager.cs

@@ -35,17 +35,68 @@ namespace Microsoft.SpatialAlignment.Persistence
 {
     public class PersistenceExampleManager : MonoBehaviour
     {
+        #region Constants
+        private const string SampleData = @"
+		[
+		  {
+			""id"": ""Parent1"",
+			""AlignmentStrategy"": {
+			  ""$type"": ""Microsoft.SpatialAlignment.SimulatedAlignment, Assembly-CSharp"",
+			  ""currentAccuracy"": {
+				""x"": 0.0,
+				""y"": 0.0,
+				""z"": 0.0
+			  },
+			  ""currentState"": ""Resolved""
+			}
+		  },
+		  {
+			""id"": ""Parent2"",
+			""AlignmentStrategy"": {
+			  ""$type"": ""Microsoft.SpatialAlignment.SimulatedAlignment, Assembly-CSharp"",
+			  ""currentAccuracy"": {
+				""x"": 0.0,
+				""y"": 0.0,
+				""z"": 0.0
+			  },
+			  ""currentState"": ""Resolved""
+			}
+		},
+		  {
+			""id"": ""Parent3"",
+			""AlignmentStrategy"": {
+			  ""$type"": ""Microsoft.SpatialAlignment.SimulatedAlignment, Assembly-CSharp"",
+			  ""currentAccuracy"": {
+				""x"": 0.0,
+				""y"": 0.0,
+				""z"": 0.0
+			  },
+			  ""currentState"": ""Resolved""
+			}
+		  }
+		]";
+        #endregion // Constants
+
         #region Member Variables
         private JsonStore store;
         #endregion // Member Variables
 
         #region Unity Inspector Variables
+        [SerializeField]
         public List<SpatialFrame> Frames = new List<SpatialFrame>();
         #endregion // Unity Inspector Variables
 
         private async Task LoadAsync()
         {
+            using (StringReader sr = new StringReader(SampleData))
+            {
+                using (JsonTextReader jr = new JsonTextReader(sr))
+                {
+                    await store.LoadDocumentAsync(jr);
+                }
+            }
 
+            // Debug.Log($"Loaded {} frames.");
         }
 
         private async Task SaveAsync()
@@ -73,7 +124,8 @@ private async Task SaveAsync()
         void Start()
         {
             store = new JsonStore();
-            var t = SaveAsync();
+            // var t = SaveAsync();
+            var t = LoadAsync();
             t.Wait();
         }
     }

SpatialAlignment-Unity/Assets/SpatialAlignment/Persistence/Json/JsonStore.cs

@@ -24,6 +24,7 @@
 //
 
 using Newtonsoft.Json;
+using Newtonsoft.Json.Converters;
 using System;
 using System.Collections;
 using System.Collections.Generic;
@@ -39,7 +40,7 @@ namespace Microsoft.SpatialAlignment.Persistence.Json
     public class JsonStore : ISpatialAlignmentStore
     {
         #region Member Variables
-        private Dictionary<string, SpatialFrame> frames = new Dictionary<string, SpatialFrame>();
+        private SpatialFrameCollection frames = new SpatialFrameCollection();
         #endregion // Member Variables
 
         #region Internal Methods
@@ -51,8 +52,10 @@ private JsonSerializer CreateSerializer()
             // Make pretty
             settings.Formatting = Formatting.Indented;
 
-            // Add converter
+            // Add converters
             settings.Converters.Add(new SpatialFrameConverter());
+            settings.Converters.Add(new StringEnumConverter());
+            settings.Converters.Add(new Vector3Converter());
 
             // Enable automatic type name handling to allow extensions for alignment strategies
             // WARNING: Must implement ISerializationBinder to safely handle instantiation
@@ -81,7 +84,7 @@ public Task LoadDocumentAsync(JsonReader reader)
             // Unload all existing objects
             foreach (var frame in frames)
             {
-                GameObject.DestroyImmediate(frame.Value.gameObject);
+                GameObject.DestroyImmediate(frame.gameObject);
             }
             frames.Clear();
 
@@ -92,10 +95,7 @@ public Task LoadDocumentAsync(JsonReader reader)
             var loadedFrames = ser.Deserialize<List<SpatialFrame>>(reader);
 
             // Add each frame to the lookup table
-            foreach (var frame in loadedFrames)
-            {
-                frames[frame.ID] = frame;
-            }
+            frames.AddRange(loadedFrames);
 
             // No tasks to await yet. May move portions of this
             // method into a parallel task.
@@ -109,8 +109,8 @@ public Task<SpatialFrame> LoadFrameAsync(string id)
             if (string.IsNullOrEmpty(id)) throw new ArgumentException(nameof(id));
 
             // Try to get from lookup table
-            SpatialFrame frame;
-            frames.TryGetValue(id, out frame);
+            SpatialFrame frame = null;
+            if (frames.Contains(id)) { frame = frames[id]; }
 
             // Return as result
             return Task.FromResult(frame);
@@ -121,12 +121,9 @@ public async Task SaveDocumentAsync(JsonWriter writer)
             // Validate
             if (writer == null) throw new ArgumentNullException(nameof(writer));
 
-            // Get as list
-            List<SpatialFrame> saveFrames = frames.Values.ToList<SpatialFrame>();
-
             // If any of the alignment strategies uses native persistence,
             // save them first.
-            foreach (SpatialFrame frame in saveFrames)
+            foreach (SpatialFrame frame in frames)
             {
                 INativePersistence np = frame.AlignmentStrategy as INativePersistence;
                 if (np != null)
@@ -139,7 +136,7 @@ public async Task SaveDocumentAsync(JsonWriter writer)
             JsonSerializer ser = CreateSerializer();
 
             // Serialize the list of frames
-            ser.Serialize(writer, saveFrames);
+            ser.Serialize(writer, frames);
         }
 
         /// <inheritdoc />
@@ -148,14 +145,8 @@ public Task SaveFrameAsync(SpatialFrame frame)
             // Validate
             if (frame == null) throw new ArgumentNullException(nameof(frame));
 
-            // Make sure something else doesn't already have this ID
-            if ((frames.ContainsKey(frame.ID) && (frames[frame.ID] != frame)))
-            {
-                throw new InvalidOperationException($"A different frame already exists with ID '{frame.ID}'");
-            }
-
             // Add it into the lookup table
-            frames[frame.ID] = frame;
+            frames.Add(frame);
 
             // Done
             return Task.CompletedTask;

SpatialAlignment-Unity/Assets/SpatialAlignment/Persistence/Json/SpatialFrameConverter.cs

@@ -53,6 +53,9 @@ public override object ReadJson(JsonReader reader, Type objectType, object exist
             // Deserialize into the instance
             serializer.Populate(reader, frame);
 
+            // Update the game object name to match
+            go.name = frame.Id;
+
             // Return the frame
             return frame;
         }

SpatialAlignment-Unity/Assets/SpatialAlignment/Persistence/Json/Vector3Converter.cs

@@ -0,0 +1,72 @@
+//
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license.
+//
+// MIT License:
+// Permission is hereby granted, free of charge, to any person obtaining
+// a copy of this software and associated documentation files (the
+// "Software"), to deal in the Software without restriction, including
+// without limitation the rights to use, copy, modify, merge, publish,
+// distribute, sublicense, and/or sell copies of the Software, and to
+// permit persons to whom the Software is furnished to do so, subject to
+// the following conditions:
+//
+// The above copyright notice and this permission notice shall be
+// included in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED ""AS IS"", WITHOUT WARRANTY OF ANY KIND,
+// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+//
+
+using Newtonsoft.Json;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using UnityEngine;
+
+namespace Microsoft.SpatialAlignment.Persistence.Json
+{
+    public class Vector3Converter : JsonConverter
+    {
+        public override bool CanConvert(Type objectType)
+        {
+            return typeof(Vector3).IsAssignableFrom(objectType);
+        }
+
+        public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
+        {
+            // Deserialize from the reader into a token
+            var token = serializer.Deserialize(reader);
+
+            // Now deserialize the token into a Vector
+            return JsonConvert.DeserializeObject<Vector3>(token.ToString());
+        }
+
+        public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
+        {
+            // We know that value is a Vector3
+            Vector3 vector = (Vector3)value;
+
+            // Start the object
+            writer.WriteStartObject();
+
+            // Write x, y and Z fields
+            writer.WritePropertyName("x");
+            writer.WriteValue(vector.x);
+            writer.WritePropertyName("y");
+            writer.WriteValue(vector.y);
+            writer.WritePropertyName("z");
+            writer.WriteValue(vector.z);
+
+            // Finish the object
+            writer.WriteEndObject();
+        }
+    }
+}

SpatialAlignment-Unity/Assets/SpatialAlignment/Persistence/Json/Vector3Converter.cs.meta

@@ -54,13 +54,48 @@ public class SpatialFrame : MonoBehaviour
         private string id;
         #endregion // Unity Inspector Variables
 
+        #region Overridables / Event Triggers
+        /// <summary>
+        /// Occurs when the value of the <see cref="Id"/> property has changed.
+        /// </summary>
+        protected virtual void OnIdChanged()
+        {
+            this.IdChanged?.Invoke(this, EventArgs.Empty);
+        }
+        #endregion // Overridables / Event Triggers
+
         #region Public Properties
-        /// <inheritdoc />
+        /// <summary>
+        /// Gets the <see cref="IAlignmentStrategy"/> that is being used to align the frame.
+        /// </summary>
         [DataMember]
         public virtual IAlignmentStrategy AlignmentStrategy { get => GetComponent<IAlignmentStrategy>(); }
 
-        /// <inheritdoc />
-        public virtual string ID { get => id; set => id = value; }
+        /// <summary>
+        /// Gets or sets a unique ID for the frame.
+        /// </summary>
+        /// <remarks>
+        /// A unique ID for the frame.
+        /// </remarks>
+        public virtual string Id
+        {
+            get => id;
+            set
+            {
+                if (id != value)
+                {
+                    id = value;
+                    OnIdChanged();
+                }
+            }
+        }
         #endregion // Public Properties
+
+        #region Public Methods
+        /// <summary>
+        /// Raised when the value of the <see cref="Id"/> property has changed.
+        /// </summary>
+        public event EventHandler IdChanged;
+        #endregion // Public Methods
     }
 }