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

namespace Chernobyl.Input.Controls
{
    /// <summary>
    /// An interface for handling mouse devices. This interface derives from 
    /// <see cref="IAxis3D"/> where the X axis is the X position, Y is the Y 
    /// position, and Z is the scroll wheel value of the <see cref="IMouse"/>.
    /// </summary>
    public interface IMouse : IAxis2DControl, IAxis3D
    {
        /// <summary>
        /// The left mouse button.
        /// </summary>
        IButtonControl LeftButton { get; }

        /// <summary>
        /// The middle mouse button.
        /// </summary>
        IButtonControl MiddleButton { get; }

        /// <summary>
        /// The right mouse button
        /// </summary>
        IButtonControl RightButton { get; }

        /// <summary>
        /// An extra button available on some mouse devices.
        /// </summary>
        IButtonControl ExtraButton1 { get; }

        /// <summary>
        /// An extra button available on some mouse devices.
        /// </summary>
        IButtonControl ExtraButton2 { get; }

        /// <summary>
        /// Gets the position of the scroll wheel. This is a cumulative 
        /// value since the application was started. Forward on the scroll
        /// wheel is a positive direction, backward is a negative direction.
        /// </summary>
        IAxisControl ScrollWheel { get; }
    }
}