imstkMouseDeviceClient.h

/*
** This file is part of the Interactive Medical Simulation Toolkit (iMSTK)
** iMSTK is distributed under the Apache License, Version 2.0.
** See accompanying NOTICE for details.
*/

#pragma once

#include "imstkDeviceClient.h"

#include <unordered_map>

namespace imstk
{
using MouseActionType = int;
#define MOUSE_RELEASE 0
#define MOUSE_PRESS 1

using MouseButtonType = int;
#define LEFT_BUTTON 0
#define RIGHT_BUTTON 1
#define MIDDLE_BUTTON 2

class MouseEvent : public Event
{
public:
    MouseEvent(const std::string type, const MouseButtonType buttonId) :
        Event(type), m_scrollDx(0.0), m_buttonId(buttonId)
    {
    }

    MouseEvent(std::string type, const double scrollDx) :
        Event(type), m_scrollDx(scrollDx), m_buttonId(0)
    {
    }

    MouseEvent(std::string type) :
        Event(type), m_scrollDx(0.0), m_buttonId(0)
    {
    }

    ~MouseEvent() override = default;

public:
    double m_scrollDx;          
    MouseButtonType m_buttonId; 
};

class MouseDeviceClient : public DeviceClient
{
protected:
    MouseDeviceClient() : DeviceClient("MouseDevice", ""),
        m_prevPos(Vec2d(0.0, 0.0)), m_pos(Vec2d(0.0, 0.0)) { }

    static std::shared_ptr<MouseDeviceClient> New();

public:
    ~MouseDeviceClient() override = default;

    // Only the viewer is allowed to provide these objects
    friend class VTKInteractorStyle;

public:
    // *INDENT-OFF*
    SIGNAL(MouseDeviceClient, mouseButtonPress);

    SIGNAL(MouseDeviceClient, mouseButtonRelease);

    SIGNAL(MouseDeviceClient, mouseScroll);

    SIGNAL(MouseDeviceClient, mouseMove);
    // *INDENT-ON*

public:
    const Vec2d& getPos() const { return m_pos; }

    const Vec2d& getPrevPos() const { return m_prevPos; }

    bool isButtonDown(const MouseButtonType buttonId) const
    {
        if (m_buttons.find(buttonId) != m_buttons.end())
        {
            return m_buttons.at(buttonId) == MOUSE_PRESS;
        }
        else
        {
            return MOUSE_RELEASE;
        }
    }

protected:
    void updateMousePos(const Vec2d& pos)
    {
        m_prevPos = m_pos;
        m_pos     = pos;
        this->postEvent(MouseEvent(MouseDeviceClient::mouseMove()));
    }

    void emitButtonPress(const MouseButtonType buttonId)
    {
        m_buttons[buttonId] = MOUSE_PRESS;
        this->postEvent(MouseEvent(MouseDeviceClient::mouseButtonPress(), buttonId));
    }

    void emitButtonRelease(const MouseButtonType buttonId)
    {
        m_buttons[buttonId] = MOUSE_RELEASE;
        this->postEvent(MouseEvent(MouseDeviceClient::mouseButtonRelease(), buttonId));
    }

    void emitScroll(const double dx) { this->postEvent(MouseEvent(MouseDeviceClient::mouseScroll(), dx)); }

protected:
    Vec2d m_prevPos;
    Vec2d m_pos;
};
} // namespace imstk