#pragma region CPL License
/*
Nuclex Native Framework
Copyright (C) 2002-2013 Nuclex Development Labs

This library is free software; you can redistribute it and/or
modify it under the terms of the IBM Common Public License as
published by the IBM Corporation; either version 1.0 of the
License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
IBM Common Public License for more details.

You should have received a copy of the IBM Common Public
License along with this library
*/
#pragma endregion // CPL License

#ifndef NUCLEX_INPUT_DEVICES_WINRTMOUSE_H
#define NUCLEX_INPUT_DEVICES_WINRTMOUSE_H

#include "../Buffered/BufferedMouse.h"

namespace Nuclex { namespace Input { namespace Devices {

  // ------------------------------------------------------------------------------------------- //

  /// <summary>Mouse that captures input from a WinRT CoreWindow</summary>
  class WinRTMouse : public BufferedMouse {

    /// <summary>Initializes a new WinRT-based keyboard</summary>
    public: WinRTMouse() {}
    
    /// <summary>Destroys the mouse</summary>
    public: virtual ~WinRTMouse() {}

    /// <summary>Whether the input device is currently attached</summary>
    /// <returns>True if the input device is attached, otherwise false</returns>
    public: bool IsAttached() const { return true; }

    /// <summary>Retrieves the human-readable name of the input device</summary>
    /// <returns>The human-readable name of the input device</returns>
    public: const std::string &GetName() const {
      static std::string name("WinRT/Metro mouse translator");
      return name;
    }

    /// <summary>Locks the mouse cursor to the window for FPS control</summary>
    /// <param name="locked">Whether to lock the mouse cursor to the window</param>
    public: void SetLocked(bool locked = true);

    /// <summary>Whether the mouse cursor is currently locked to the window</summary>
    /// <returns>True if the mouse cursor is locked to the window, otherwise false</returns>
    public: bool IsLocked() const;

    /// <summary>Called when a mouse button is pressed down</summary>
    /// <param name="sender">Window that registered the mouse button press</param>
    /// <param name="arguments">Contains the pressed mouse button</param>
    public: void InjectButtonPress(
      Windows::UI::Core::CoreWindow ^sender, Windows::UI::Core::PointerEventArgs ^arguments
    );

    /// <summary>Called when a mouse button has been released</summary>
    /// <param name="sender">Window that registered the mouse button release</param>
    /// <param name="arguments">Contains the released mouse button</param>
    public: void InjectButtonRelease(
      Windows::UI::Core::CoreWindow ^sender, Windows::UI::Core::PointerEventArgs ^arguments
    );
    /// <summary>Called when the mouse cursor has been moved to a new location</summary>
    /// <param name="sender">Window that registered the mouse cursor movement</param>
    /// <param name="arguments">Contains the new mouse cursor location</param>
    public: void InjectCursorMovement(
      Windows::UI::Core::CoreWindow ^sender, Windows::UI::Core::PointerEventArgs ^arguments
    );

    /// <summary>Called when the mouse wheel has been rotated</summary>
    /// <param name="sender">Window that registered the mouse wheel rotation</param>
    /// <param name="arguments">Contains the amount of mouse wheel rotation</param>
    public: void InjectWheelRotation(
      Windows::UI::Core::CoreWindow ^sender, Windows::UI::Core::PointerEventArgs ^arguments
    );

    /// <summary>
    ///   Adds a cursor movement to the buffer mouse if the cursor's position differs from
    ///   the last position recorded
    /// </summary>
    /// <param name="arguments">Contains the current pointer position</param>
    private: void bufferCursorMovementIfPositionChanged(
      Windows::UI::Core::PointerEventArgs ^arguments
    );

    /// <summary>X coordinate of the mouse cursor</summary>
    private: int cursorX;
    /// <summary>Y coordinate of the mouse cursor</summary>
    private: int cursorY;
    /// <summary>Whether the left mouse button is currently pressed</summary>
    private: bool leftButtonPressed;
    /// <summary>Whether the middle mouse button is currently pressed</summary>
    private: bool middleButtonPressed;
    /// <summary>Whether the right mouse button is currently pressed</summary>
    private: bool rightButtonPressed;

  };

  // ------------------------------------------------------------------------------------------- //

}}} // namespace Nuclex::Input::Devices

#endif // NUCLEX_INPUT_DEVICES_WINRTMOUSE_H