Merge pull request #513 from StephenHodgson/HTK-Sharing

HTK - Sharing Updates

Author: StephenHodgson

Assets/HoloToolkit/Sharing/Prefabs/Sharing.prefab

@@ -59,6 +59,7 @@ MonoBehaviour:
   AutoDiscoverServer: 0
   PingIntervalSec: 2
   IsAudioEndpoint: 1
+  ShowDetailedLogs: 0
 --- !u!114 &114000013602799446
 MonoBehaviour:
   m_ObjectHideFlags: 1

Assets/HoloToolkit/Sharing/README.md

@@ -9,6 +9,7 @@ Users can also collaborate with other users (who are also using multiple devices
 
 - [Features](#features)
 - [Configuration](#configuration)
+- [Troubleshooting](#troubleshooting)
 - [Plugins](#plugins)
 - [Prefabs](#prefabs)
 - [Scripts](#scripts)
@@ -105,6 +106,25 @@ Ensure you have the following capabilities set in Player Settings -> Windows Sto
 
 Install or run the server instance.
 
+### Troubleshooting
+---
+- Double check the Server Address on your sharing stage component in your scene matches the address shown in the sharing service console.
+- Make sure all devices are connected to the same Wireless Local Area Network.
+- Ensure all firewall settings are correct.  Windows firewall gives you options to enable/disable by network type (private, public, home), make sure you're enabling the firewall for your connection's type.
+
+####Invalid Schema Version
+
+```
+SharingService [..\..\Source\Common\Private\SessionListHandshakeLogic.cpp (67)]: 
+***************************************************************
+List Server Handshake Failed: Invalid schema version. 
+Expected: 17, got 15 
+Please sync to latest XTools
+***************************************************************
+```
+
+- Ensure you're using the latest binaries of the sharing service found at `HoloToolkit-Unity\External\HoloToolkit\Sharing\Server`.
+
 ### [Plugins](Plugins)
 ---
 Contains compiled architecture specific binaries for SharingClient.dll which are required by the Unity application for accessing sharing APIs.
@@ -299,8 +319,14 @@ Broadcasts the head transform of the local user to other users in the session, a
 #### RoomTest.cs
 Test class for demonstrating creating rooms and anchors.
 
-#### SpawnTestKeyboardSpawning.cs
-Class that handles spawning sync objects on keyboard presses, for the `SpawningTest.scene`.
+#### SyncObjectSpawner.cs
+Class that handles spawning and deleteing sync objects for the `SpawningTest.scene`.  Uses the `KeywordManager` to spawn objects using voice and keyboard input.
+
+|Voice Command|Key Command|Description|
+|---|---|---|
+| Spawn Basic | Key `I`| Spawns a cube with a `SyncSpawnedObject` basic sync model.|
+| Spawn Custom | Key `O`| Spawns a sphere with a `SyncSpawnTestSphere` custom sync model.|
+| Delete Object | Key `M`| Deletes both sync model types.|
 
 #### SyncSpawnTestSphere.cs
 Class that demonstrates a custom class using sync model attributes.
@@ -310,13 +336,14 @@ Used to demonstrate how to get notifications when users leave and enter room.
 
 ### [Tests](Tests/Scenes)
 ---
-Tests related to the sharing features. To use the scene:
+Tests related to the sharing features. To use the each scene:
 
 1. Navigate to the Tests folder.
 2. Double click on the test scene you wish to explore.
 3. Either click "Play" in the unity editor or File -> Build Settings.
 4. Add Open Scenes, Platform -> Windows Store, SDK -> Universal 10, Build Type -> D3D, Check 'Unity C# Projects'.
-5. Click 'Build' and create an App folder. When compile is done, open the solution and deploy to device.
+5. Enable all required [capabilities](configuration).
+6. Click 'Build' and create an App folder. When compile is done, open the solution and deploy to device.
 
 #### SharingTest.unity 
 This test demonstrates how to use the Sharing prefabs for networking and sharing custom messages with clients. 
@@ -337,12 +364,12 @@ It also demonstrates how to upload and download new anchors.
 3. **RoomTest.cs** shows how to create, join, and leave rooms; also shows how to create and download anchors.
 
 #### SharingSpawnTest.unity
-This test demonstrates how to spawn sync objects in your scene and across your networked clients.
+This test demonstrates how to spawn and delete sync objects in your scene and across your networked clients.
 
 1. Ensure to launch the sharing service using: HoloToolkit -> Launch Sharing service
 2. Enter the IP address displayed in the console window into the Server Address of the Sharing object.
 3. **PrefabSpawnManager.cs** enables you to store prefab references to use when spawning.
-4. **SpawnTestKeyboardSpawning** demonstrates how to spawn sync objects, as well as custom class types.
+4. **SyncObjectSpawner.cs** demonstrates how to spawn and delete sync objects, as well as custom class types.
 
 ---
 ##### [Go back up to the table of contents](#table-of-contents)

Assets/HoloToolkit/Sharing/Scripts/SharingStage.cs

@@ -22,7 +22,7 @@ public class SharingStage : Singleton<SharingStage>
         /// Default username to use when joining a session.
         /// </summary>
         /// <remarks>User code should set the user name by setting the UserName property.</remarks>
-        private const string DefaultUserName = "User0";
+        private const string DefaultUserName = "User ";
 
         /// <summary>
         /// Set whether this app should be a Primary or Secondary client.
@@ -108,7 +108,14 @@ public class SharingStage : Singleton<SharingStage>
         /// </summary> 
         private DiscoveryClientAdapter discoveryClientAdapter;
 
+        /// <summary>
+        /// The current ping interval during AutoDiscovery updates.
+        /// </summary>
         private float pingIntervalCurrent;
+
+        /// <summary>
+        /// True when AutoDiscovery is actively searching, otherwise false.
+        /// </summary>
         private bool isTryingToFindServer;
 
         [Tooltip("Show Detailed Information for server connections")]
@@ -128,7 +135,7 @@ public string UserName
             }
             set
             {
-                using (XString userName = new XString(value))
+                using (var userName = new XString(value))
                 {
                     Manager.SetUserName(userName);
                 }
@@ -143,14 +150,30 @@ public NetworkConnection Connection
         {
             get
             {
-                if (networkConnection == null)
+                if (networkConnection == null && Manager != null)
                 {
                     networkConnection = Manager.GetServerConnection();
                 }
                 return networkConnection;
             }
         }
 
+        /// <summary>
+        /// Returns true if connected to a Sharing Service server.
+        /// </summary>
+        public bool IsConnected
+        {
+            get
+            {
+                if (Manager != null && Connection != null)
+                {
+                    return Connection.IsConnected();
+                }
+
+                return false;
+            }
+        }
+
         protected override void Awake()
         {
             base.Awake();
@@ -171,8 +194,6 @@ protected override void Awake()
 
         protected override void OnDestroy()
         {
-            base.OnDestroy();
-
             if (discoveryClient != null)
             {
                 discoveryClient.RemoveListener(discoveryClientAdapter);
@@ -227,6 +248,8 @@ protected override void OnDestroy()
 
             // Forces a garbage collection to try to clean up any additional reference to SWIG-wrapped objects
             GC.Collect();
+
+            base.OnDestroy();
         }
 
         private void LateUpdate()
@@ -245,7 +268,7 @@ private void LateUpdate()
 
         private void Connect()
         {
-            ClientConfig config = new ClientConfig(ClientRole);
+            var config = new ClientConfig(ClientRole);
             config.SetIsAudioEndpoint(IsAudioEndpoint);
             config.SetLogWriter(logWriter);
 
@@ -272,9 +295,21 @@ private void Connect()
             SessionsTracker = new ServerSessionsTracker(Manager.GetSessionManager());
             SessionUsersTracker = new SessionUsersTracker(SessionsTracker);
 
-            using (XString userName = new XString(DefaultUserName))
+            using (var userName = new XString(DefaultUserName))
             {
-                Manager.SetUserName(userName);
+#if UNITY_WSA && !UNITY_EDITOR
+                Manager.SetUserName(SystemInfo.deviceName);
+#else
+                if (!string.IsNullOrEmpty(Environment.UserName))
+                {
+                    Manager.SetUserName(Environment.UserName);
+                }
+                else
+                {
+                    User localUser = Manager.GetLocalUser();
+                    Manager.SetUserName(userName + localUser.GetID().ToString());
+                }
+#endif
             }
         }
 

Assets/HoloToolkit/Sharing/Scripts/Spawning/PrefabSpawnManager.cs

@@ -32,7 +32,7 @@ public class PrefabSpawnManager : SpawnManager<SyncSpawnedObject>
         /// </summary>
         /// <remarks>It is assumed that this list is the same on all connected applications.</remarks>
         [SerializeField]
-        private List<PrefabToDataModel> spawnablePrefabs;
+        private List<PrefabToDataModel> spawnablePrefabs = null;
 
         private Dictionary<string, GameObject> typeToPrefab;
 

Assets/HoloToolkit/Sharing/Scripts/Spawning/SpawnManager.cs

@@ -3,6 +3,7 @@
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 //
 
+using System;
 using UnityEngine;
 using HoloToolkit.Sharing.SyncModel;
 
@@ -22,7 +23,22 @@ namespace HoloToolkit.Sharing.Spawning
 
         protected virtual void Start()
         {
+            // SharingStage should be valid at this point, but we may not be connected.
             NetworkManager = SharingStage.Instance;
+            if (NetworkManager.IsConnected)
+            {
+                Connected();
+            }
+            else
+            {
+                NetworkManager.SharingManagerConnected += Connected;
+            }
+        }
+
+        protected virtual void Connected(object sender = null, EventArgs e = null)
+        {
+            NetworkManager.SharingManagerConnected -= Connected;
+
             SetDataModelSource();
             RegisterToDataModel();
         }

Assets/HoloToolkit/Sharing/Scripts/Utilities/AutoJoinSession.cs

@@ -54,8 +54,8 @@ private void Update()
                 {
                     if (SharingStage.Instance.ShowDetailedLogs)
                     {
-                        Debug.LogFormat("Session conn {0} Sessions: {1}.", sessionsTracker.IsServerConnected.ToString(), sessionsTracker.Sessions.Count.ToString());
-                        Debug.Log("Looking for " + SessionName);
+                        Debug.LogFormat("AutoJoinSession: Session connected is {0} with {1} Sessions.", sessionsTracker.IsServerConnected.ToString(), sessionsTracker.Sessions.Count.ToString());
+                        Debug.Log("AutoJoinSession: Looking for " + SessionName);
                     }
                     bool sessionFound = false;
 

Assets/HoloToolkit/Sharing/Tests/Prefabs/AnchorText.prefab

@@ -0,0 +1,108 @@
+%YAML 1.1
+%TAG !u! tag:unity3d.com,2011:
+--- !u!1001 &100100000
+Prefab:
+  m_ObjectHideFlags: 1
+  serializedVersion: 2
+  m_Modification:
+    m_TransformParent: {fileID: 0}
+    m_Modifications: []
+    m_RemovedComponents: []
+  m_ParentPrefab: {fileID: 0}
+  m_RootGameObject: {fileID: 1460649626274452}
+  m_IsPrefabParent: 1
+--- !u!1 &1460649626274452
+GameObject:
+  m_ObjectHideFlags: 0
+  m_PrefabParentObject: {fileID: 0}
+  m_PrefabInternal: {fileID: 100100000}
+  serializedVersion: 5
+  m_Component:
+  - component: {fileID: 4631490928263856}
+  - component: {fileID: 23725207649169752}
+  - component: {fileID: 102214044351826462}
+  - component: {fileID: 114413180992801294}
+  m_Layer: 0
+  m_Name: AnchorText
+  m_TagString: Untagged
+  m_Icon: {fileID: 0}
+  m_NavMeshLayer: 0
+  m_StaticEditorFlags: 0
+  m_IsActive: 1
+--- !u!4 &4631490928263856
+Transform:
+  m_ObjectHideFlags: 1
+  m_PrefabParentObject: {fileID: 0}
+  m_PrefabInternal: {fileID: 100100000}
+  m_GameObject: {fileID: 1460649626274452}
+  m_LocalRotation: {x: -0, y: -0, z: -0, w: 1}
+  m_LocalPosition: {x: 0, y: 0.17, z: 0}
+  m_LocalScale: {x: 0.005, y: 0.005, z: 0.005}
+  m_Children: []
+  m_Father: {fileID: 0}
+  m_RootOrder: 0
+  m_LocalEulerAnglesHint: {x: 0, y: 0, z: 0}
+--- !u!23 &23725207649169752
+MeshRenderer:
+  m_ObjectHideFlags: 1
+  m_PrefabParentObject: {fileID: 0}
+  m_PrefabInternal: {fileID: 100100000}
+  m_GameObject: {fileID: 1460649626274452}
+  m_Enabled: 1
+  m_CastShadows: 1
+  m_ReceiveShadows: 1
+  m_MotionVectors: 1
+  m_LightProbeUsage: 1
+  m_ReflectionProbeUsage: 1
+  m_Materials:
+  - {fileID: 10100, guid: 0000000000000000e000000000000000, type: 0}
+  m_StaticBatchInfo:
+    firstSubMesh: 0
+    subMeshCount: 0
+  m_StaticBatchRoot: {fileID: 0}
+  m_ProbeAnchor: {fileID: 0}
+  m_LightProbeVolumeOverride: {fileID: 0}
+  m_ScaleInLightmap: 1
+  m_PreserveUVs: 0
+  m_IgnoreNormalsForChartDetection: 0
+  m_ImportantGI: 0
+  m_SelectedEditorRenderState: 3
+  m_MinimumChartSize: 4
+  m_AutoUVMaxDistance: 0.5
+  m_AutoUVMaxAngle: 89
+  m_LightmapParameters: {fileID: 0}
+  m_SortingLayerID: 0
+  m_SortingOrder: 0
+--- !u!102 &102214044351826462
+TextMesh:
+  serializedVersion: 3
+  m_ObjectHideFlags: 1
+  m_PrefabParentObject: {fileID: 0}
+  m_PrefabInternal: {fileID: 100100000}
+  m_GameObject: {fileID: 1460649626274452}
+  m_Text: No Server Connection
+  m_OffsetZ: 0
+  m_CharacterSize: 1
+  m_LineSpacing: 1
+  m_Anchor: 4
+  m_Alignment: 1
+  m_TabSize: 4
+  m_FontSize: 48
+  m_FontStyle: 0
+  m_RichText: 1
+  m_Font: {fileID: 10102, guid: 0000000000000000e000000000000000, type: 0}
+  m_Color:
+    serializedVersion: 2
+    rgba: 4294967295
+--- !u!114 &114413180992801294
+MonoBehaviour:
+  m_ObjectHideFlags: 1
+  m_PrefabParentObject: {fileID: 0}
+  m_PrefabInternal: {fileID: 100100000}
+  m_GameObject: {fileID: 1460649626274452}
+  m_Enabled: 1
+  m_EditorHideFlags: 0
+  m_Script: {fileID: 11500000, guid: ac8d5b128a1d8204fb76c86f47b75912, type: 3}
+  m_Name: 
+  m_EditorClassIdentifier: 
+  PivotAxis: 0

Assets/HoloToolkit/Sharing/Tests/Prefabs/AnchorText.prefab.meta

@@ -50,13 +50,13 @@ MeshRenderer:
   m_PrefabInternal: {fileID: 100100000}
   m_GameObject: {fileID: 1000011931115288}
   m_Enabled: 1
-  m_CastShadows: 1
-  m_ReceiveShadows: 1
+  m_CastShadows: 0
+  m_ReceiveShadows: 0
   m_MotionVectors: 1
-  m_LightProbeUsage: 1
-  m_ReflectionProbeUsage: 1
+  m_LightProbeUsage: 0
+  m_ReflectionProbeUsage: 0
   m_Materials:
-  - {fileID: 10303, guid: 0000000000000000f000000000000000, type: 0}
+  - {fileID: 2100000, guid: c9eb9258e335f144fae9e9e50e1fe664, type: 2}
   m_StaticBatchInfo:
     firstSubMesh: 0
     subMeshCount: 0