using System;
using Chernobyl.Input.Controls.Axis;
using Chernobyl.Mathematics.Mechanics;

namespace Chernobyl.Input.Controls
{
    /// <summary>
    /// An interface for handling game controller devices.
    /// </summary>
    public interface IGamepad : IControl
    {
        /// <summary>
        /// The first button on the <see cref="IGamepad"/> or null if it does 
        /// not exist.
        /// </summary>
        /// <exception cref="DisconnectedException">Thrown if this 
        /// <see cref="IGamepad"/> has been disconnected.</exception>
        IButtonControl A { get; }

        /// <summary>
        /// The second button on the <see cref="IGamepad"/> or null if it does 
        /// not exist.
        /// </summary>
        /// <exception cref="DisconnectedException">Thrown if this 
        /// <see cref="IGamepad"/> has been disconnected.</exception>
        IButtonControl B { get; }

        /// <summary>
        /// The third button on the <see cref="IGamepad"/> or null if it does 
        /// not exist.
        /// </summary>
        /// <exception cref="DisconnectedException">Thrown if this 
        /// <see cref="IGamepad"/> has been disconnected.</exception>
        IButtonControl C { get; }

        /// <summary>
        /// The fourth button on the <see cref="IGamepad"/> or null if it does 
        /// not exist.
        /// </summary>
        /// <exception cref="DisconnectedException">Thrown if this 
        /// <see cref="IGamepad"/> has been disconnected.</exception>
        IButtonControl D { get; }

        /// <summary>
        /// The first left shoulder button on the <see cref="IGamepad"/> or 
        /// null if it does not exist.
        /// </summary>
        /// <exception cref="DisconnectedException">Thrown if this 
        /// <see cref="IGamepad"/> has been disconnected.</exception>
        IButtonControl LeftShoulder1 { get; }

        /// <summary>
        /// The first right button on the <see cref="IGamepad"/> or null if it 
        /// does not exist.
        /// </summary>
        /// <exception cref="DisconnectedException">Thrown if this 
        /// <see cref="IGamepad"/> has been disconnected.</exception>
        IButtonControl RightShoulder1 { get; }

        /// <summary>
        /// The left thumb stick on the <see cref="IGamepad"/> or null if it
        /// does not exist.
        /// </summary>
        /// <exception cref="DisconnectedException">Thrown if this 
        /// <see cref="IGamepad"/> has been disconnected.</exception>
        IThumbstick LeftStick { get; }

        /// <summary>
        /// The right thumb stick on the <see cref="IGamepad"/> or null if it
        /// does not exist.
        /// </summary>
        IThumbstick RightStick { get; }

        /// <summary>
        /// The select button on the <see cref="IGamepad"/> or null if it does 
        /// not exist.
        /// </summary>
        /// <exception cref="DisconnectedException">Thrown if this 
        /// <see cref="IGamepad"/> has been disconnected.</exception>
        IButtonControl Select { get; }

        /// <summary>
        /// The start button on the <see cref="IGamepad"/> or null if it does 
        /// not exist.
        /// </summary>
        /// <exception cref="DisconnectedException">Thrown if this 
        /// <see cref="IGamepad"/> has been disconnected.</exception>
        IButtonControl Start { get; }

        /// <summary>
        /// The main or central button on the <see cref="IGamepad"/> or null if
        /// it does not exist.
        /// </summary>
        /// <exception cref="DisconnectedException">Thrown if this 
        /// <see cref="IGamepad"/> has been disconnected.</exception>
        IButtonControl Main { get; }

        /// <summary>
        /// The primary directional pad on the <see cref="IGamepad"/> or null if
        /// it does not exist.
        /// </summary>
        /// <exception cref="DisconnectedException">Thrown if this 
        /// <see cref="IGamepad"/> has been disconnected.</exception>
        IDpad Dpad { get; }

        /// <summary>
        /// The left trigger on the <see cref="IGamepad"/> or null if it does
        /// not exist. The left trigger has a maximum value of 1 and a minimum
        /// value of 0.
        /// </summary>
        /// <exception cref="DisconnectedException">Thrown if this 
        /// <see cref="IGamepad"/> has been disconnected.</exception>
        IAxisControl LeftTrigger { get; }

        /// <summary>
        /// The left trigger on the <see cref="IGamepad"/> or null if it does
        /// not exist. The left trigger has a maximum value of 1 and a minimum
        /// value of 0.
        /// </summary>
        /// <exception cref="DisconnectedException">Thrown if this 
        /// <see cref="IGamepad"/> has been disconnected.</exception>
        IAxisControl RightTrigger { get; }

        /// <summary>
        /// The amount of vibration, between 0 and 1, in the left motor. 0 means
        /// no vibration, 1 means maximum vibration.
        /// </summary>
        /// <exception cref="ArgumentOutOfRangeException">Thrown when the value
        /// set on this property is less than 0 or greater than 1.</exception>
        /// <exception cref="DisconnectedException">Thrown if this 
        /// <see cref="IGamepad"/> has been disconnected.</exception>
        float LeftVibration { get; set; }

        /// <summary>
        /// The amount of vibration, between 0 and 1, in the right motor. 0 means
        /// no vibration, 1 means maximum vibration.
        /// </summary>
        /// <exception cref="ArgumentOutOfRangeException">Thrown when the value
        /// set on this property is less than 0 or greater than 1.</exception>
        /// <exception cref="DisconnectedException">Thrown if this 
        /// <see cref="IGamepad"/> has been disconnected.</exception>
        float RightVibration { get; set; }
    }

    /// <summary>
    /// An interface for working with analog sticks on a gamepad or other device.
    /// Analog sticks give a two dimensional position of a protrusion relative
    /// to a default center position. The <see cref="IAxis2D.Xy"/> value
    /// will be (0, 0) when the <see cref="IThumbstick"/> is centered. The
    /// maximum for the X and Y axes of the <see cref="IThumbstick"/> are 1.
    /// The minimum for both axes is -1. This interface also gives indication of
    /// the up or down button state of the analog stick.
    /// </summary>
    public interface IThumbstick : IAxis2DControl, IButtonControl
    {}

    /// <summary>
    /// An interface for working with flat four button control usually found
    /// on gamepads. D-pad is short for directional pad.
    /// </summary>
    public interface IDpad : IControl
    {
        /// <summary>
        /// The top button on the <see cref="IDpad"/> or null if it does not
        /// exist.
        /// </summary>
        IButtonControl Up { get; }

        /// <summary>
        /// The right button on the <see cref="IDpad"/> or null if it does not
        /// exist.
        /// </summary>
        IButtonControl Right { get; }

        /// <summary>
        /// The bottom button on the <see cref="IDpad"/> or null if it does not
        /// exist.
        /// </summary>
        IButtonControl Down { get; }

        /// <summary>
        /// The left button on the <see cref="IDpad"/> or null if it does not
        /// exist.
        /// </summary>
        IButtonControl Left { get; }
    }
}