using Chernobyl.Graphics;
using Chernobyl.Mathematics.Collision;
using Chernobyl.Mathematics.Geometry;
using Chernobyl.Mathematics.Mechanics;
using Chernobyl.Update;

namespace Chernobyl.Interface.Tool
{
    /// <summary>
    /// An interface for working with a cursor that is driven by some input 
    /// device like a mouse or gamepad. This cursor derives from 
    /// <see cref="IAxis3D"/> where the 
    /// </summary>
    public interface ICursor : IDrawableTransformCollidable2D, IUpdateable
    {
        /// <summary>
        /// The collision group whose collidables are checked for collisions.
        /// </summary>
        ICollidableCollection<IExtendedCollidable<Point2D>, Point2D> CollidableCollection { get; }

        /// <summary>
        /// The first button on the cursor. This button is used to click on objects, 
        /// select those objects, choose from lists, etc. This button is often 
        /// the left mouse button.
        /// </summary>
        IButton FirstButton { get; }

        /// <summary>
        /// The second button on the cursor. This button is used to open context 
        /// menus, select secondary actions, etc. This button is often the right 
        /// mouse button.
        /// </summary>
        IButton SecondButton { get; }

        /// <summary>
        /// The third button on the cursor. This button is often the middle mouse 
        /// button.
        /// </summary>
        IButton ThirdButton { get; }
    }
}