AVR_Controller.cs

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

namespace AVR.Core {
    /// <summary>
    /// Represents a VR controller. Provides functionality for spacial tracking and haptic feedback.
    /// Can also be used to represent hardware trackers, game controllers or other references.
    /// </summary>
    [AVR.Core.Attributes.DocumentationUrl("class_a_v_r_1_1_core_1_1_a_v_r___controller.html")]
    public class AVR_Controller : AVR_GenericXRDevice
    {
        /// <summary>
        /// Returns the AVR_Controller that represents the left hand controller (if it exists). This value depends on the controllerNode value and is not updated if this one is changed during runtime.
        /// </summary>
        public static AVR_Controller leftHandController { get; private set; }

        /// <summary>
        /// Returns the AVR_Controller that represents the right hand controller (if it exists). This value depends on the controllerNode value and is not updated if this one is changed during runtime.
        /// </summary>
        public static AVR_Controller rightHandController { get; private set; }

        /// <summary>
        /// the AVR_ControllerInputManager assigned to this controller. Returns null if no inputmanager is assigned
        /// </summary>
        public AVR_ControllerInputManager inputManager {
            get {
                return _inputManager;
            }
        }
        private AVR_ControllerInputManager _inputManager=null;

        protected override void Awake() {
            base.Awake();
            _inputManager = GetComponentInChildren<AVR_ControllerInputManager>();

            if (controllerNode==XRNode.LeftHand && !leftHandController) leftHandController = this;
            if (controllerNode == XRNode.RightHand && !rightHandController) rightHandController = this;
        }

        /// <summary>
        /// Returns the haptic capabilites of this controller.
        /// </summary>
        public HapticCapabilities GetHapticCapabilities() {
            if(inputDevice.TryGetHapticCapabilities(out var capabilities)) {
                return capabilities;
            }
            else {
                AVR_DevConsole.cwarn("Could not retrieve haptic capavilites from controller.", this);
                return default(HapticCapabilities);
            }
        }

        /// <summary>
        /// Performs a haptic pulse on this controller (if available)
        /// <param name="amplitude"> Normalized amplitude of the pulse. Must be in [0, 1] </param>
        /// <param name="duration"> Duration of the pulse in seconds. </param>
        /// </summary>
        public void HapticPulse(float amplitude, float duration) {
            if (GetHapticCapabilities().supportsImpulse)
            {
                inputDevice.SendHapticImpulse(0u, amplitude, duration);
            }
        }
    }
}