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

namespace Chernobyl.Input.Controls
{
    /// <summary>
    /// An interface for working with joysticks or analog sticks on a gamepad or
    /// other device. These "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="IStick"/> is centered. The maximum for the X and Y axes of
    /// the <see cref="IStick"/> are 1. The minimum for both axes is -1.
    /// </summary>
    public interface IStick : IAxis2DControl
    {
        /// <summary>
        /// The region of movement which is not recognized by the device.
        /// <see cref="Vector2.X"/> refers to the region in the X axis of the
        /// <see cref="IAxis2D.X"/>. <see cref="Vector2.Y"/> refers to the
        /// region in the X axis of the <see cref="IAxis2D.X"/>.
        /// </summary>
        /// <exception cref="ArgumentOutOfRangeException">Thrown when the
        /// <see cref="Vector2.X"/> or <see cref="Vector2.Y"/> values of the
        /// <see cref="Vector2"/> instance set on the property are either less
        /// than 0 or greater than 1.</exception>
        Vector2 DeadZone { get; set; }
    }
}