Event.h

Go to the documentation of this file.

#pragma once
 
#include <Common/primitive_type.h>
#include <Common/assertion.h>
#include <Math/math.h>
#include <Utility/utility.h>
 
#include <string>
 
namespace ph::editor
{
 
enum class EEventType
{
    Unknown = 0,
 
    // TODO: distanguish between main window and window (child/internal)?
 
    DisplayClose,
    DisplayResize,
    DisplayFocus,
    DisplayLostFocus,
    DisplayMove,
 
    FramebufferResize,
 
    AppTick,
    AppUpdate,
    AppRender,
 
    KeyDown,
    KeyUp,
    KeyHit,
 
    MouseButtonDown,
    MouseButtonUp,
    MouseClick,
    MouseScroll,
    MouseMove,
};
 
enum class EEventSource : uint32f
{
    Unknown = 0,
 
    App         = math::flag_bit<uint32f, 0>(),
    Input       = math::flag_bit<uint32f, 1>(),
    Keyboard    = math::flag_bit<uint32f, 2>(),
    Mouse       = math::flag_bit<uint32f, 3>(),
    MouseButton = math::flag_bit<uint32f, 4>(),
};
 
class Event
{
// Hide special members as this class is not intended to be used polymorphically.
// It is derived class's choice to expose them (by defining them in public) or not.
protected:
    PH_DEFINE_INLINE_RULE_OF_5_MEMBERS(Event);
 
public:
    /*inline Event() = default;
    inline virtual ~Event() = default;*/
 
    /*virtual EEventType getDynamicType() const = 0;
    virtual EEventSource getSourceType() const = 0;
    virtual std::string toString() const = 0;*/
 
    void consume();
    bool isConsumed() const;
    //bool isFromSource(EEventSource fromSourceType) const;
 
private:
    uint8 m_isConsumed : 1 = false;
};
 
inline void Event::consume()
{
    PH_ASSERT_MSG(!m_isConsumed, "Consuming already-consumed editor event.");
 
    m_isConsumed = true;
}
 
inline bool Event::isConsumed() const
{
    return m_isConsumed;
}
 
}// end namespace ph::editor