GHOST_Event Class Reference

#include <GHOST_Event.hh>

Inherits GHOST_IEvent.

Inherited by GHOST_EventButton, GHOST_EventCursor, GHOST_EventDragnDrop, GHOST_EventKey, GHOST_EventNDOFButton, GHOST_EventNDOFMotion, GHOST_EventString, GHOST_EventTrackpad, and GHOST_EventWheel.

Public Member Functions
	GHOST_Event (uint64_t msec, GHOST_TEventType type, GHOST_IWindow *window)
GHOST_TEventType	getType () const override
uint64_t	getTime () const override
GHOST_IWindow *	getWindow () const override
GHOST_TEventDataPtr	getData () const override
Public Member Functions inherited from GHOST_IEvent
virtual	~GHOST_IEvent ()=default

Protected Attributes
GHOST_TEventType	type_
uint64_t	time_
GHOST_IWindow *	window_
GHOST_TEventDataPtr	data_ = nullptr

Detailed Description

Base class for events received the operating system.

Definition at line 17 of file GHOST_Event.hh.

Constructor & Destructor Documentation

GHOST_Event()

GHOST_Event::GHOST_Event ( uint64_t msec, GHOST_TEventType type, GHOST_IWindow * window )

inline

Constructor.

Parameters

msec	The time this event was generated.
type	The type of this event.
window	The generating window (or nullptr if system event).

Definition at line 25 of file GHOST_Event.hh.

References time_, type_, and window_.

Referenced by GHOST_EventButton::GHOST_EventButton(), GHOST_EventCursor::GHOST_EventCursor(), GHOST_EventDragnDrop::GHOST_EventDragnDrop(), GHOST_EventKey::GHOST_EventKey(), GHOST_EventKey::GHOST_EventKey(), GHOST_EventNDOFButton::GHOST_EventNDOFButton(), GHOST_EventNDOFMotion::GHOST_EventNDOFMotion(), GHOST_EventString::GHOST_EventString(), GHOST_EventTrackpad::GHOST_EventTrackpad(), and GHOST_EventWheel::GHOST_EventWheel().

Member Function Documentation

getData()

GHOST_TEventDataPtr GHOST_Event::getData ( ) const

inlineoverridevirtual

Returns the event data.

Returns

The event data.

Implements GHOST_IEvent.

Definition at line 49 of file GHOST_Event.hh.

References data_.

getTime()

uint64_t GHOST_Event::getTime ( ) const

inlineoverridevirtual

Returns the time this event was generated.

Returns

The event generation time.

Implements GHOST_IEvent.

Definition at line 37 of file GHOST_Event.hh.

References time_.

Referenced by touch_seat_handle_frame().

getType()

GHOST_TEventType GHOST_Event::getType ( ) const

inlineoverridevirtual

Returns the event type.

Returns

The event type.

Implements GHOST_IEvent.

Definition at line 31 of file GHOST_Event.hh.

References type_.

getWindow()

GHOST_IWindow * GHOST_Event::getWindow ( ) const

inlineoverridevirtual

Returns the window this event was generated on, or nullptr if it is a 'system' event.

Returns

The generating window.

Implements GHOST_IEvent.

Definition at line 43 of file GHOST_Event.hh.

References window_.

Member Data Documentation

data_

GHOST_TEventDataPtr GHOST_Event::data_ = nullptr

protected

Pointer to the event data.

Definition at line 62 of file GHOST_Event.hh.

Referenced by getData(), GHOST_EventDragnDrop::GHOST_EventDragnDrop(), GHOST_EventKey::GHOST_EventKey(), GHOST_EventKey::GHOST_EventKey(), GHOST_EventNDOFButton::GHOST_EventNDOFButton(), GHOST_EventNDOFMotion::GHOST_EventNDOFMotion(), GHOST_EventString::GHOST_EventString(), GHOST_EventTrackpad::GHOST_EventTrackpad(), GHOST_EventWheel::GHOST_EventWheel(), and GHOST_EventString::~GHOST_EventString().

time_

uint64_t GHOST_Event::time_

protected

The time this event was generated.

Definition at line 58 of file GHOST_Event.hh.

Referenced by getTime(), and GHOST_Event().

type_

GHOST_TEventType GHOST_Event::type_

protected

Type of this event.

Definition at line 56 of file GHOST_Event.hh.

Referenced by getType(), and GHOST_Event().

window_

GHOST_IWindow* GHOST_Event::window_

protected

Pointer to the generating window.

Definition at line 60 of file GHOST_Event.hh.

Referenced by getWindow(), and GHOST_Event().

---

The documentation for this class was generated from the following file:

• GHOST_Event.hh