Update AccessibilitySubsystemDescriptor to use built-in MRTK base classes

Author: keveleigh

org.mixedrealitytoolkit.accessibility/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
+## Unreleased
+
+### Changed
+
+* Updated `AccessibilitySubsystemDescriptor` to use built-in MRTK base classes. [PR #1109](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity/pull/1109)
+
 ## [1.0.3-development.pre.20] - 2024-04-17
 
 ### Fixed

org.mixedrealitytoolkit.accessibility/Subsystems/AccessibilitySubsystemDescriptor.cs

@@ -3,155 +3,26 @@
 
 using MixedReality.Toolkit.Subsystems;
 using System;
-using UnityEngine;
-using UnityEngine.SubsystemsImplementation;
 
 namespace MixedReality.Toolkit.Accessibility
 {
     /// <summary>
     /// Encapsulates the parameters for creating a new <see cref="AccessibilitySubsystemDescriptor"/>.
     /// </summary>
-    public struct AccessibilitySubsystemCinfo :
-        IEquatable<AccessibilitySubsystemCinfo>, IMRTKSubsystemDescriptor
-    {
-        #region IMRTKDescriptor implementation
-
-        ///<inheritdoc/>
-        public string Name { get; set; }
-
-        ///<inheritdoc/>
-        public string DisplayName { get; set; }
-
-        ///<inheritdoc/>
-        public string Author { get; set; }
-
-        ///<inheritdoc/>
-        public Type ConfigType { get; set; }
-
-        ///<inheritdoc/>
-        public Type ProviderType { get; set; }
-
-        ///<inheritdoc/>
-        public Type SubsystemTypeOverride { get; set; }
-
-        #endregion IMRTKDescriptor implementation
-
-        /// <summary>
-        /// Tests for equality.
-        /// </summary>
-        /// <param name="other">The other <see cref="AccessibilitySubsystemCinfo"/> to compare against.</param>
-        /// <returns>
-        /// <see langword="true"/> if every field in <paramref name="other"/> is equal to this 
-        /// <see cref="AccessibilitySubsystemCinfo"/>, otherwise <see langword="false"/>.
-        /// </returns>
-        public bool Equals(AccessibilitySubsystemCinfo other)
-        {
-            return
-                ReferenceEquals(Name, other.Name)
-                && ReferenceEquals(ProviderType, other.ProviderType)
-                && ReferenceEquals(SubsystemTypeOverride, other.SubsystemTypeOverride);
-        }
-
-        /// <summary>
-        /// Tests for equality.
-        /// </summary>
-        /// <param name="obj">The `object` to compare against.</param>
-        /// <returns>
-        /// <see langword="true"/> if <paramref name="obj"/> is of type <see cref="AccessibilitySubsystemCinfo" /> and
-        /// <see cref="Equals(AccessibilitySubsystemCinfo)"/> also returns <see langword="true"/>,
-        /// otherwise <see langword="false"/>.
-        /// </returns>
-        public override bool Equals(System.Object obj)
-        {
-            return (obj is AccessibilitySubsystemCinfo cinfo) && Equals(cinfo);
-        }
-
-        /// <summary>
-        /// Tests for equality. 
-        /// </summary>
-        /// <remarks>
-        /// This is a same as <see cref="Equals(AccessibilitySubsystemCinfo)"/>.
-        /// </remarks>
-        /// <param name="lhs">The left-hand side of the comparison.</param>
-        /// <param name="rhs">The right-hand side of the comparison.</param>
-        /// <returns>
-        /// <see langword="true"/> if <paramref name="lhs"/> is equal to <paramref name="rhs"/>, 
-        /// otherwise <see langword="false"/>.
-        /// </returns>
-        public static bool operator==(AccessibilitySubsystemCinfo lhs, AccessibilitySubsystemCinfo rhs)
-        {
-            return lhs.Equals(rhs);
-        }
-
-        /// <summary>
-        /// Tests for inequality. Same as `!`<see cref="Equals(AccessibilitySubsystemCinfo)"/>.
-        /// </summary>
-        /// <param name="lhs">The left-hand side of the comparison.</param>
-        /// <param name="rhs">The right-hand side of the comparison.</param>
-        /// <returns><see langword="true"/> if <paramref name="lhs"/> is not equal to <paramref name="rhs"/>, otherwise <see langword="false"/>.</returns>
-        public static bool operator !=(AccessibilitySubsystemCinfo lhs, AccessibilitySubsystemCinfo rhs)
-        {
-            return !(lhs == rhs);
-        }
-
-        /// <summary>
-        /// This <see cref="GetHashCode"/> override is meant to disable hash lookups of 
-        /// <see cref="AccessibilitySubsystemCinfo"/> objects.
-        /// </summary>
-        /// <remarks>
-        /// This will throw a <see cref="ApplicationException"/> if called.
-        /// </remarks>
-        /// <exception cref="ApplicationException">
-        /// Thrown if this function is called.
-        /// </exception>
-        public override int GetHashCode()
-        {
-            throw new ApplicationException("Do not hash subsystem descriptors as keys.");
-        }
-    }
+    public class AccessibilitySubsystemCinfo : MRTKSubsystemCinfo { }
 
     /// <summary>
     /// Specifies a functionality description that may be registered for each implementation that provides the
     /// <see cref="AccessibilitySubsystem"/> interface.
     /// </summary>
     public class AccessibilitySubsystemDescriptor :
-        SubsystemDescriptorWithProvider<AccessibilitySubsystem, AccessibilitySubsystem.Provider>,
-        IMRTKSubsystemDescriptor
+        MRTKSubsystemDescriptor<AccessibilitySubsystem, AccessibilitySubsystem.Provider>
     {
         /// <summary>
         /// Initializes a new instance of the <see cref="AccessibilitySubsystemDescriptor"/> class.
         /// </summary>
-        /// <param name='accessibilitySubsystemCinfo'>The parameters required to initialize the descriptor.</param>
-        AccessibilitySubsystemDescriptor(AccessibilitySubsystemCinfo accessibilitySubsystemCinfo)
-        {
-            Name = accessibilitySubsystemCinfo.Name;
-            DisplayName = accessibilitySubsystemCinfo.DisplayName;
-            Author = accessibilitySubsystemCinfo.Author;
-            ProviderType = accessibilitySubsystemCinfo.ProviderType;
-            SubsystemTypeOverride = accessibilitySubsystemCinfo.SubsystemTypeOverride;
-        }
-
-        #region IMRTKDescriptor implementation
-
-        ///<inheritdoc/>
-        public string Name { get => id; set => id = value; }
-
-        ///<inheritdoc/>
-        public string DisplayName { get; set; }
-
-        ///<inheritdoc/>
-        public string Author { get; set; }
-
-        ///<inheritdoc/>
-        public Type ConfigType { get; set; }
-
-        ///<inheritdoc/>
-        public Type ProviderType { get => providerType; set => providerType = value; }
-
-        ///<inheritdoc/>
-        public Type SubsystemTypeOverride { get => subsystemTypeOverride; set => subsystemTypeOverride = value; }
-
-        #endregion IMRTKDescriptor implementation
+        /// <param name="cinfo">The parameters required to initialize the descriptor.</param>
+        AccessibilitySubsystemDescriptor(AccessibilitySubsystemCinfo cinfo) : base(cinfo) { }
 
         /// <summary>
         /// Creates a <see cref="AccessibilitySubsystemDescriptor"/> based on the given parameters.
@@ -167,8 +38,8 @@ internal static AccessibilitySubsystemDescriptor Create(AccessibilitySubsystemCi
         {
             // Validates cinfo.
             if (!XRSubsystemHelpers.CheckTypes<AccessibilitySubsystem, AccessibilitySubsystem.Provider>(cinfo.Name,
-                                                                                              cinfo.SubsystemTypeOverride,
-                                                                                              cinfo.ProviderType))
+                                                                                                        cinfo.SubsystemTypeOverride,
+                                                                                                        cinfo.ProviderType))
             {
                 throw new ArgumentException("Could not create AccessibilitySubsystemDescriptor.");
             }

org.mixedrealitytoolkit.accessibility/package.json

@@ -1,6 +1,6 @@
 {
   "name": "org.mixedrealitytoolkit.accessibility",
-  "version": "1.0.3-development.pre.20",
+  "version": "1.0.4-development.pre.20",
   "description": "Features and subsystem to enable accessibility in MR experiences.\n\nThis is in early preview and may undergo significant, breaking changes before release.",
   "displayName": "MRTK Accessibility Early Preview",
   "msftFeatureCategory": "MRTK3",