Mouse.h

Go to the documentation of this file.

//Luke Lenhart, 2008
//See /docs/License.txt for details on how this code may be used.

#pragma once
#include "../base/Types.h"
#include "Unified.h"
#include <vector>

namespace INPUT
{
    namespace MOUSE
    {
        const uint8 LEFT_BUTTON=1; 
        const uint8 RIGHT_BUTTON=2; 
        const uint8 MIDDLE_BUTTON=3; 
        const uint8 EXTENDED_BUTTON0=4; 
        const uint8 EXTENDED_BUTTON1=5; 
        const uint8 EXTENDED_BUTTON2=6; 
        const uint8 EXTENDED_BUTTON3=7; 
        const uint8 EXTENDED_BUTTON4=8; 
        const uint8 EXTENDED_BUTTON5=9; 
        const uint8 EXTENDED_BUTTON6=10; 
        const uint8 EXTENDED_BUTTON7=11; 
        const uint8 EXTENDED_BUTTON8=12; 
        const uint8 EXTENDED_BUTTON9=13; 

        inline UnifiedButton GetUnifiedButton(uint8 button)
        {
            return UnifiedButton(MOUSE_DEVICE, button);
        }

        const std::string& GetFriendlyName(uint8 button);

        bool IsButtonDown(uint8 button);

        const std::vector<uint8>& GetCurrentlyPressedButtons();

        const std::vector<uint8>& GetNewlyPressedButtons();

        int GetWheelDirection();

        struct MousePixelPosition
        {
            sint16 X;
            sint16 Y;

            inline bool operator==(const MousePixelPosition &o) const 
                { return X==o.X && Y==o.Y; }
            inline bool operator!=(const MousePixelPosition &o) const 
                { return !(*this==o); }
        };

        struct MouseScaledPosition
        {
            float X;
            float Y;

            inline bool operator==(const MouseScaledPosition &o) const 
                { return X==o.X && Y==o.Y; }
            inline bool operator!=(const MouseScaledPosition &o) const 
                { return !(*this==o); }
        };

        MouseScaledPosition GetScaledPosition();

        const std::vector<MouseScaledPosition>& GetScaledTrail();

        MousePixelPosition GetPixelPosition();

        const std::vector<MousePixelPosition>& GetPixelTrail();

        //TODO: Mouse mode (os control in absolute mode, or we capture and provide relative mode data) (we are always absolute for now)
        //TODO: Cursor image control
    }
}