Added integration with the Unity XR Interaction Toolkit interaction system.

Author: petethor

CHANGELOG.md

@@ -2,6 +2,14 @@
 
 All notable changes will be documented in this file.
 
+## [2.0.3-alpha] - 2023-10-13
+
+- Adjusting samples to be compatible with the Unity OpenXR package and Unity XR Interaction Toolkit interaction system.
+- Added an OmnideckContinousMoveProvider class, which extends the ContinousMoveProviderBase class. Overrides the ReadInput() method to pipe the movement vector coming from the OmnitrackInterface (from Omnitrack) into the XR Interaction toolkit interaction system.
+- Requires XR Interaction Toolkit v2.5.2.
+- Tested with Unity 2022.3.4 and 2022.3.8.
+- Tested with Omnitrack v2.6.6.
+
 ## [2.0.2-alpha] - 2023-07-08
 
 - Changed OnApplicationQuit() to OnDestroy(). Fixes bug where network connection was not closed due to working with Prefabs and the Editor. 

README.md

@@ -13,11 +13,10 @@ Navigate to the <i>Window > Package Manager</i>. Search for the <i>XR Interactio
 More details will follow...
 
 ## Samples
-<b>The functionality of the samples below are incomplete and do not work fully with the XR rig as of 2023-07-07. </b>
-
-The package contains two simple samples that integrate the Omnideck API with a unity Gameobject.
-- Example 1: The Omnideck Platform uses Unity Character Controller that can collide with the surrounding objects. It has an XR Rig attached to it.
-- Example 2: The Omnideck Platform uses a Vector3 script, without any object collision. It has an XR Rig attached to it.
+The package contains three samples on how to integrate the Omnideck API with your VR application.
+- Example 1: Integration with the Unity XR Interaction toolkit interaction system (v2.5.2+) by adding a OmnideckContinousMoveProvider that extends the ContinousMoveProviderBase from XRI. Remember to import the XRI Starter Asset samples. Uses a Unity Character Controller that can collide with the surrounding objects. Supports hand controllers and basic interaction.
+- Example 2: Integration using a Unity Character Controller that can collide with the surrounding objects. It has an XR Rig attached to it.
+- Example 3: Integration using a Vector3 script, without any object collision. It has an XR Rig attached to it.
 
 ## Changelog
 Please see https://github.com/Omnifinity/Unity-Omnideck-API/blob/main/CHANGELOG.md

Runtime/Plugins/OmnitrackAPI.dll.meta

@@ -37,8 +37,9 @@ public enum LogLevel { None, Terse, Verbose }
 			// The XR camera
 			public GameObject xrCamera = null;
 
-			// The interface to Omnideck
-			OmnideckInterface _omnideckInterface;
+            // The interface to Omnideck
+            [SerializeField]
+            OmnideckInterface _omnideckInterface;
 
 			// Camera eye transform for positioning of head collider
 			Transform _cameraTransform = null;
@@ -51,7 +52,6 @@ public enum LogLevel { None, Terse, Verbose }
 			void Start()
 			{
 				// get hold of the Omnideck interface component
-				_omnideckInterface = GetComponent<OmnideckInterface>();
 				if (_omnideckInterface)
 				{
 					if (debugLevel != LogLevel.None)
@@ -120,6 +120,9 @@ void Update()
 				// so that the user cannot move through walls
 				if (_cameraTransform != null)
 					_characterController.center = new Vector3(_cameraTransform.localPosition.x, 0, _cameraTransform.localPosition.z);
+
+				// ... and thirdly make scale the height of the character collider to match head position
+				// TBD. Please check how this is done in the XR Interaction toolkit for inspiration on your own.
 			}
 			#endregion MonoBehaviorMethods
 		}

Runtime/Scripts/OmnideckCharacterController.cs

@@ -0,0 +1,37 @@
+using UnityEngine;
+using UnityEngine.XR.Interaction.Toolkit;
+
+namespace Omnifinity.Omnideck
+{
+    public class OmnideckContinousMoveProvider : ContinuousMoveProviderBase
+    {
+        /// <summary>
+        /// The Omnideck API
+        /// </summary>
+        [SerializeField]
+        private OmnideckInterface m_omnideckInterface;
+
+        /// <summary>
+        /// Tie into the LocomotionSystem
+        /// </summary>
+        protected override void Awake()
+        {
+            base.Awake();
+        }
+
+        /// <summary>
+        /// Reads the value of the move input (coming from Omnideck interface).
+        /// Will drive the Charactercontroller via the ContinousMoveProviderBase class.
+        /// </summary>
+        /// <returns>Returns the input vector, for the Omnideck character.</returns>
+        protected override Vector2 ReadInput()
+        {
+            if (m_omnideckInterface == null)
+                return Vector2.zero;
+
+            Vector3 movementVector = m_omnideckInterface.GetCurrentOmnideckCharacterMovementVector();
+
+            return new Vector2(movementVector.x, movementVector.z);
+        }
+    }
+}

Runtime/Scripts/OmnideckContinousMoveProvider.cs

@@ -31,6 +31,7 @@ public enum LogLevel { None, Terse, Verbose }
 			public LogLevel debugLevel = LogLevel.Verbose;
 
 			// our interface of interest
+			[SerializeField]
 			OmnideckInterface _omnideckInterface;
 
 			// Camera eye transform for positioning of head collider
@@ -41,7 +42,6 @@ public enum LogLevel { None, Terse, Verbose }
 			void Start()
 			{
 				// get hold of the Omnideck interface component
-				_omnideckInterface = GetComponent<OmnideckInterface>();
 				if (_omnideckInterface)
 				{
 					if (debugLevel != LogLevel.None)

Runtime/Scripts/OmnideckContinousMoveProvider.cs.meta

@@ -1,7 +1,9 @@
 {
     "name": "omnifinity.omnideck",
     "rootNamespace": "",
-    "references": [],
+    "references": [
+        "GUID:fe685ec1767f73d42b749ea8045bfe43"
+    ],
     "includePlatforms": [],
     "excludePlatforms": [],
     "allowUnsafeCode": false,

Runtime/Scripts/OmnideckVector3.cs

@@ -0,0 +1,83 @@
+%YAML 1.1
+%TAG !u! tag:unity3d.com,2011:
+--- !u!21 &2100000
+Material:
+  serializedVersion: 8
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_Name: Ground plane
+  m_Shader: {fileID: 46, guid: 0000000000000000f000000000000000, type: 0}
+  m_Parent: {fileID: 0}
+  m_ModifiedSerializedProperties: 0
+  m_ValidKeywords: []
+  m_InvalidKeywords: []
+  m_LightmapFlags: 4
+  m_EnableInstancingVariants: 0
+  m_DoubleSidedGI: 0
+  m_CustomRenderQueue: -1
+  stringTagMap: {}
+  disabledShaderPasses: []
+  m_LockedProperties: 
+  m_SavedProperties:
+    serializedVersion: 3
+    m_TexEnvs:
+    - _BumpMap:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    - _DetailAlbedoMap:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    - _DetailMask:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    - _DetailNormalMap:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    - _EmissionMap:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    - _MainTex:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    - _MetallicGlossMap:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    - _OcclusionMap:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    - _ParallaxMap:
+        m_Texture: {fileID: 0}
+        m_Scale: {x: 1, y: 1}
+        m_Offset: {x: 0, y: 0}
+    m_Ints: []
+    m_Floats:
+    - _BumpScale: 1
+    - _Cutoff: 0.5
+    - _DetailNormalMapScale: 1
+    - _DstBlend: 0
+    - _GlossMapScale: 1
+    - _Glossiness: 0.5
+    - _GlossyReflections: 1
+    - _Metallic: 0
+    - _Mode: 0
+    - _OcclusionStrength: 1
+    - _Parallax: 0.02
+    - _SmoothnessTextureChannel: 0
+    - _SpecularHighlights: 1
+    - _SrcBlend: 1
+    - _UVSec: 0
+    - _ZWrite: 1
+    m_Colors:
+    - _Color: {r: 0.49056602, g: 0.4183695, b: 0.4183695, a: 1}
+    - _EmissionColor: {r: 0, g: 0, b: 0, a: 1}
+  m_BuildTextureStacks: []