Change how the ClientKit object works: use properties.

Author: rpavlik

OSVR-Unity/Assets/OSVRUnity/src/ClientKit.cs

@@ -18,56 +18,75 @@ public class ClientKit : MonoBehaviour
             [Tooltip("A string uniquely identifying your application, in reverse domain-name format.")]
             public string AppID;
 
-            private OSVR.ClientKit.ClientContext context;
+            private OSVR.ClientKit.ClientContext contextObject;
 
             /// <summary>
-            /// Use to find the single instance of this object/script in your game.
+            /// Use to access the single instance of this object/script in your game.
             /// </summary>
             /// <returns>The instance, or null in case of error</returns>
-            public static ClientKit Get()
+            public static ClientKit instance
             {
-                ClientKit candidate = GameObject.FindObjectOfType<ClientKit>();
-                if (null == candidate)
+                get
                 {
-                    Debug.LogError("You need the ClientKit prefab!");
+                    ClientKit candidate = GameObject.FindObjectOfType<ClientKit>();
+                    if (null == candidate)
+                    {
+                        Debug.LogError("OSVR Error: You need the ClientKit prefab in your game!!");
+                    }
+                    return candidate;
+
+                }
+            }
+
+            /// <summary>
+            /// Access the underlying Managed-OSVR client context object.
+            /// </summary>
+            public OSVR.ClientKit.ClientContext context
+            {
+                get
+                {
+                    EnsureStarted();
+                    return contextObject;
                 }
-                return candidate;
             }
 
-            public OSVR.ClientKit.ClientContext GetContext()
+            private void EnsureStarted()
             {
-                if (context == null)
+                if (contextObject == null)
                 {
                     if (0 == AppID.Length)
                     {
                         Debug.LogError("OSVR ClientKit instance needs AppID set to a reverse-order DNS name! Using dummy name...");
                         AppID = "org.opengoggles.osvr-unity.dummy";
                     }
                     Debug.Log("Starting OSVR with app ID: " + AppID);
-                    context = new OSVR.ClientKit.ClientContext(AppID, 0);
+                    contextObject = new OSVR.ClientKit.ClientContext(AppID, 0);
                 }
-                return context;
             }
 
+            /// <summary>
+            /// Static constructor that enhances the DLL search path to ensure dependent native dlls are found.
+            /// </summary>
             static ClientKit()
             {
                 DLLSearchPathFixer.fix();
             }
 
             void Start()
             {
-                GetContext();
+                EnsureStarted();
             }
 
             void FixedUpdate()
             {
-                context.update();
+                contextObject.update();
             }
 
             void OnDestroy()
             {
-                Debug.Log("Disconnecting from OSVR server.");
-                context = null;
+                Debug.Log("Shutting down OSVR.");
+				contextObject.Dispose ();
+                contextObject = null;
             }
         }
     }

OSVR-Unity/Assets/OSVRUnity/src/OrientationInterface.cs

@@ -26,11 +26,6 @@ public class OrientationInterface : MonoBehaviour
             /// </summary>
             public string path;
 
-            /// <summary>
-            /// This should be a reference to the single ClientKit instance in your project.
-            /// </summary>
-            private ClientKit clientKit;
-
             private OSVR.ClientKit.Interface iface;
             private OSVR.ClientKit.OrientationCallback cb;
 
@@ -43,12 +38,7 @@ void Start()
                     return;
                 }
 
-                if (null == clientKit)
-                {
-                    clientKit = OSVR.Unity.ClientKit.Get();
-                }
-
-                iface = clientKit.GetContext().getInterface(path);
+                iface = OSVR.Unity.ClientKit.instance.context.getInterface(path);
                 cb = new OSVR.ClientKit.OrientationCallback(callback);
                 iface.registerCallback(cb, IntPtr.Zero);
             }

OSVR-Unity/Assets/OSVRUnity/src/PoseInterface.cs

@@ -26,11 +26,6 @@ public class PoseInterface : MonoBehaviour
             /// </summary>
             public string path;
 
-            /// <summary>
-            /// This should be a reference to the single ClientKit instance in your project.
-            /// </summary>
-            private ClientKit clientKit;
-
             private OSVR.ClientKit.Interface iface;
             private OSVR.ClientKit.PoseCallback cb;
 
@@ -42,12 +37,7 @@ void Start()
                     return;
                 }
 
-                if (null == clientKit)
-                {
-                    clientKit = OSVR.Unity.ClientKit.Get();
-                }
-
-                iface = clientKit.GetContext().getInterface(path);
+                iface = OSVR.Unity.ClientKit.instance.context.getInterface(path);
                 cb = new OSVR.ClientKit.PoseCallback(callback);
                 iface.registerCallback(cb, IntPtr.Zero);
             }

OSVR-Unity/Assets/OSVRUnity/src/PositionInterface.cs

@@ -26,11 +26,6 @@ public class PositionInterface : MonoBehaviour
             /// </summary>
             public string path;
 
-            /// <summary>
-            /// This should be a reference to the single ClientKit instance in your project.
-            /// </summary>
-            private ClientKit clientKit;
-
             private OSVR.ClientKit.Interface iface;
             private OSVR.ClientKit.PositionCallback cb;
 
@@ -43,11 +38,7 @@ void Start()
                     return;
                 }
 
-                if (null == clientKit)
-                {
-                    clientKit = OSVR.Unity.ClientKit.Get();
-                }
-                iface = clientKit.GetContext().getInterface(path);
+                iface = OSVR.Unity.ClientKit.instance.context.getInterface(path);
                 cb = new OSVR.ClientKit.PositionCallback(callback);
                 iface.registerCallback(cb, IntPtr.Zero);
             }