Added IMixedRealityController.Name (#589)

Better logging when mapping profiles are empty
XRTK · May 17, 2020 · e7abe8a · e7abe8a
1 parent c7f1f88
commit e7abe8a
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 6 deletions.
diff --git a/Runtime/Interfaces/Providers/Controllers/IMixedRealityController.cs b/Runtime/Interfaces/Providers/Controllers/IMixedRealityController.cs
@@ -15,6 +15,11 @@ namespace XRTK.Interfaces.Providers.Controllers
     /// </summary>
     public interface IMixedRealityController
     {
+        /// <summary>
+        /// The name of the controller.
+        /// </summary>
+        string Name { get; }
+
         /// <summary>
         /// Is the controller enabled?
         /// </summary>

diff --git a/Runtime/Providers/Controllers/BaseController.cs b/Runtime/Providers/Controllers/BaseController.cs
@@ -39,11 +39,6 @@ protected BaseController() { }
         /// <param name="controllerMappingProfile"></param>
         protected BaseController(IMixedRealityControllerDataProvider controllerDataProvider, TrackingState trackingState, Handedness controllerHandedness, MixedRealityControllerMappingProfile controllerMappingProfile)
         {
-            if (controllerMappingProfile == null)
-            {
-                throw new Exception($"{nameof(controllerMappingProfile)} cannot be null");
-            }
-
             ControllerDataProvider = controllerDataProvider;
             TrackingState = trackingState;
             ControllerHandedness = controllerHandedness;
@@ -56,6 +51,13 @@ protected BaseController(IMixedRealityControllerDataProvider controllerDataProvi
                 handednessPrefix = $"{controllerHandedness} ";
             }
 
+            Name = $"{handednessPrefix}{GetType().Name}";
+
+            if (controllerMappingProfile == null)
+            {
+                throw new Exception($"{nameof(controllerMappingProfile)} cannot be null for {Name}");
+            }
+
             visualizationProfile = controllerMappingProfile.VisualizationProfile;
             var pointers = AssignControllerMappings(controllerMappingProfile.InteractionMappingProfiles);
 
@@ -65,7 +67,7 @@ protected BaseController(IMixedRealityControllerDataProvider controllerDataProvi
                 throw new Exception($"No Controller interaction mappings found for {controllerMappingProfile.name}!");
             }
 
-            InputSource = MixedRealityToolkit.InputSystem?.RequestNewGenericInputSource($"{handednessPrefix}{GetType().Name}", pointers);
+            InputSource = MixedRealityToolkit.InputSystem?.RequestNewGenericInputSource(Name, pointers);
 
             for (int i = 0; i < InputSource?.Pointers?.Length; i++)
             {
@@ -98,6 +100,9 @@ protected BaseController(IMixedRealityControllerDataProvider controllerDataProvi
 
         #region IMixedRealityController Implementation
 
+        /// <inheritdoc />
+        public string Name { get; }
+
         /// <inheritdoc />
         public bool Enabled { get; set; }
 

diff --git a/Runtime/Providers/Controllers/BaseControllerDataProvider.cs b/Runtime/Providers/Controllers/BaseControllerDataProvider.cs
@@ -27,6 +27,12 @@ protected BaseControllerDataProvider(string name, uint priority, BaseMixedRealit
             }
 
             controllerMappingProfiles = profile.ControllerMappingProfiles;
+
+            if (controllerMappingProfiles == null ||
+                controllerMappingProfiles.Length == 0)
+            {
+                throw new UnassignedReferenceException($"{nameof(controllerMappingProfiles)} has no defined controller mappings for {name}");
+            }
         }
 
         private readonly MixedRealityControllerMappingProfile[] controllerMappingProfiles;
@@ -62,6 +68,7 @@ public MixedRealityControllerMappingProfile GetControllerMappingProfile(Type con
                 }
             }
 
+            Debug.LogError($"Failed to find a controller mapping for {controllerType.Name} with with handedness: {handedness}");
             return null;
         }