Files
test2/intern/ghost/intern/GHOST_Event.hh

77 lines
1.6 KiB
C++

/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
*
* SPDX-License-Identifier: GPL-2.0-or-later */
/** \file
* \ingroup GHOST
* Declaration of GHOST_Event class.
*/
#pragma once
#include "GHOST_IEvent.hh"
/**
* Base class for events received the operating system.
*/
class GHOST_Event : public GHOST_IEvent {
public:
/**
* Constructor.
* \param msec: The time this event was generated.
* \param type: The type of this event.
* \param window: The generating window (or nullptr if system event).
*/
GHOST_Event(uint64_t msec, GHOST_TEventType type, GHOST_IWindow *window)
: m_type(type), m_time(msec), m_window(window)
{
}
/**
* Returns the event type.
* \return The event type.
*/
GHOST_TEventType getType() const override
{
return m_type;
}
/**
* Returns the time this event was generated.
* \return The event generation time.
*/
uint64_t getTime() const override
{
return m_time;
}
/**
* Returns the window this event was generated on,
* or nullptr if it is a 'system' event.
* \return The generating window.
*/
GHOST_IWindow *getWindow() const override
{
return m_window;
}
/**
* Returns the event data.
* \return The event data.
*/
GHOST_TEventDataPtr getData() const override
{
return m_data;
}
protected:
/** Type of this event. */
GHOST_TEventType m_type;
/** The time this event was generated. */
uint64_t m_time;
/** Pointer to the generating window. */
GHOST_IWindow *m_window;
/** Pointer to the event data. */
GHOST_TEventDataPtr m_data = nullptr;
};