imstkKeyboardDeviceClient.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 KeyStateType = int;
#define KEY_RELEASE 0
#define KEY_PRESS 1

class KeyEvent : public Event
{
public:
    KeyEvent(const std::string type, const char key, const KeyStateType keyPressType) : Event(type), m_keyPressType(keyPressType), m_key(key) { }
    ~KeyEvent() override = default;

public:
    KeyStateType m_keyPressType;
    const char   m_key = -1;
};

class KeyboardDeviceClient : public DeviceClient
{
protected:
    KeyboardDeviceClient() : DeviceClient("KeyboardDevice", "") { }

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

public:
    ~KeyboardDeviceClient() override = default;

    // Only these classes may provide this object
    friend class VTKInteractorStyle;
    friend class ConsoleModule;

public:
    // *INDENT-OFF*
    SIGNAL(KeyboardDeviceClient, keyPress);

    SIGNAL(KeyboardDeviceClient, keyRelease);
    // *INDENT-ON*

public:
    const std::unordered_map<int, KeyStateType>& getKeyState() const { return m_buttons; }

protected:
    void emitKeyDown(char key);

    void emitKeyUp(char key);

    bool isKeyDown(const char key) const;
};
} // namespace imstk