IInteractionModeDetector.cs

// Copyright (c) Mixed Reality Toolkit Contributors
// Licensed under the BSD 3-Clause

using System;
using System.Collections.Generic;
using UnityEngine;

namespace MixedReality.Toolkit.Input
{
    /// <summary>
    /// Defines some base properties that a MRTK Interactor has
    /// </summary>
    public interface IInteractionModeDetector
    {
        /// <summary>
        /// The interaction mode to be toggled if when the detector detects the appropriate game state
        /// </summary>
        InteractionMode ModeOnDetection { get; }

        /// <summary>
        /// Determine whether the detector has detected the appropriate conditions.
        /// </summary>
        /// <remarks>
        /// One possible usage can be when a teleport gesture occurs, am <see cref="IInteractionModeDetector"/> can change the controller's interaction mode to a <see cref="InteractionMode"/> representing teleportation.
        /// </remarks>
        /// <returns>Returns whether the appropriate conditions detected.</returns>
        bool IsModeDetected();

        /// <summary>
        /// Get a list of the <see cref="GameObject"/> instances which represent the controllers that this interaction mode detector has jurisdiction over.
        /// </summary>
        /// <returns>The list of the <see cref="GameObject"/> instances which represent the controllers that this interaction mode detector has jurisdiction over.</returns>
        [Obsolete("This function has been deprecated in version 4.0.0 and will be removed in a future version. Please use GetInteractorGroups instead.")]
        List<GameObject> GetControllers();

        /// <summary>
        /// Get a list of the <see cref="GameObject"/> instances which represent the interactor groups that this interaction mode detector has jurisdiction over.
        /// </summary>
        /// <returns>The list of the <see cref="GameObject"/> instances which represent the interactor groups that this interaction mode detector has jurisdiction over.</returns>
        List<GameObject> GetInteractorGroups();
    }
}