mouse_event.h

Go to the documentation of this file.

/*!****************************************************************//*!*
 * \file   mouse_event.h
 * \brief  Mouse actions events (buttons click, move, wheel) events implementation module.
 * 
 * \author Sabitov Kirill
 * \date   25 June 2022
 *********************************************************************/
 
#pragma once
 
#include "utilities/event/event.h"
 
namespace scl
{
    enum class mouse_button
    {
#ifdef SCL_PLATFORM_WINDOWS
        NONE = 0,
        LEFT = 1,
        RIGHT = 2,
        MIDDLE = 16,
#else
        LEFT = 0,
        RIGHT = 1,
        MIDDLE = 2,
#endif
    };
 
    class mouse_button_event: public event
    {
        SCL_MAKE_EVENT(MouseButton);
 
    private: 
        bool Pressed;
        int X, Y;
        mouse_button KeyCode;
 
    public:
        /*!*
         * Mouse button click default constructor..
         * 
         * \param Pressed - is mouse key pressed or released flag.
         * \param DbClick - is button pressecd second time in a row flag.
         * \param X - mouse x position.
         * \param Y - mouse y possition.
         * \param KeyCode - mouse button code.
         */
        mouse_button_event(bool Pressed, int X, int Y, mouse_button KeyCode) :
            Pressed(Pressed), X(X), Y(Y), KeyCode(KeyCode) {}
 
        bool GetPressed() { return Pressed; }
        int GetX() { return X; }
        int GetY() { return Y; }
        mouse_button GetKeyCode() { return KeyCode; }
 
        /*!*
         * Convert event to string (for debug).
         *
         * \param None.
         * \return string representation of event.
         */
        inline std::string ToString() const override
        {
            std::stringstream ss;
            ss << GetName() << ": Pressed? - " << Pressed
               << ", (X, Y) - (" << X << ", " << Y << "), KeyCode - " << (int)KeyCode;
            return ss.str();
        }
    };
 
    class mouse_wheel_event: public event
    {
        SCL_MAKE_EVENT(MouseWheel);
 
    private :
        int WheelPosDelta;
 
    public:
        /*!*
         * Mouse wheel scroll event default constructor.
         * 
         * \param WheelPos - mouse wheel position delta.
         */
        mouse_wheel_event(int WheelPosDelta) :
            WheelPosDelta(WheelPosDelta) {}
 
        int GetWheelPos() { return WheelPosDelta; }
 
        /*!*
         * Convert event to string (for debug).
         *
         * \param None.
         * \return string representation of event.
         */
        inline std::string ToString() const override
        {
            std::stringstream ss;
            ss << GetName() << ": Wheel position delta - " << WheelPosDelta;
            return ss.str();
        }
    };
 
    class mouse_move_event: public event
    {
        SCL_MAKE_EVENT(MouseMove);
 
    private: 
        int X, Y;
        bool RButton, LButton, MButton;
        bool Shift, Control;
 
    public:
        /*!*
         * Mouse move event deault constructor..
         * 
         * \param X - mouse x possition.
         * \param Y - mouse y possition.
         * \param RButton - mouse right button state.
         * \param LButton - mouse left button state.
         * \param MButton - mouse middle button state.
         * \param Shift - shift key state.
         * \param Control - contrl key state.
         */
        mouse_move_event(int X, int Y, bool RButton, bool LButton, bool MButton,
                         bool Shift, bool Control) :
            X(X), Y(Y), RButton(RButton), LButton(LButton), MButton(MButton),
            Shift(Shift), Control(Control) {}
 
        int GetX() { return X; }
        int GetY() { return Y; }
        bool GetRButton() { return RButton; }
        bool GetLButton() { return LButton; }
        bool GetMButton() { return MButton; }
        bool GetShift() { return Shift; }
        bool GetControl() { return Control; }
 
        /*!*
         * Convert event to string (for debug).
         *
         * \param None.
         * \return string representation of event.
         */
        inline std::string ToString() const override
        {
            std::stringstream ss;
            ss << GetName() << ": (X, Y) - (" << X << ", " << Y
               << "), RButton - " << RButton << ", LButton - " << LButton << ", MButton - " << MButton;
            return ss.str();
        }
    };
}