#include <GHOST_EventManager.hh>

Public Member Functions
	GHOST_EventManager ()
	~GHOST_EventManager ()
uint32_t	getNumEvents ()
uint32_t	getNumEvents (GHOST_TEventType type)
GHOST_TSuccess	pushEvent (const GHOST_IEvent *event)
void	dispatchEvent (const GHOST_IEvent *event)
void	dispatchEvent ()
void	dispatchEvents ()
GHOST_TSuccess	addConsumer (GHOST_IEventConsumer *consumer)
GHOST_TSuccess	removeConsumer (GHOST_IEventConsumer *consumer)
void	removeWindowEvents (const GHOST_IWindow *window)
void	removeTypeEvents (GHOST_TEventType type, const GHOST_IWindow *window=nullptr)

Protected Types
using	TEventStack = std::deque<const GHOST_IEvent *>
using	TConsumerVector = std::vector<GHOST_IEventConsumer *>

Protected Member Functions
void	disposeEvents ()

Protected Attributes
std::deque< const GHOST_IEvent * >	events_
std::deque< const GHOST_IEvent * >	handled_events_
TConsumerVector	consumers_

Detailed Description

Manages an event stack and a list of event consumers. The stack works on a FIFO (First In First Out) basis. Events are pushed on the front of the stack and retrieved from the back. Ownership of the event is transferred to the event manager as soon as an event is pushed. Ownership of the event is transferred from the event manager as soon as an event is popped. Events can be dispatched to the event consumers.

Definition at line 25 of file GHOST_EventManager.hh.

Member Typedef Documentation

◆ TConsumerVector

using GHOST_EventManager::TConsumerVector = std::vector<GHOST_IEventConsumer *>

protected

A vector with event consumers.

Definition at line 118 of file GHOST_EventManager.hh.

◆ TEventStack

using GHOST_EventManager::TEventStack = std::deque<const GHOST_IEvent *>

protected

A stack with events.

Definition at line 111 of file GHOST_EventManager.hh.

Constructor & Destructor Documentation

◆ GHOST_EventManager()

GHOST_EventManager::GHOST_EventManager ( )

default

Constructor.

◆ ~GHOST_EventManager()

GHOST_EventManager::~GHOST_EventManager ( )

Destructor.

Definition at line 19 of file GHOST_EventManager.cc.

References consumers_, and disposeEvents().

Member Function Documentation

◆ addConsumer()

GHOST_TSuccess GHOST_EventManager::addConsumer ( GHOST_IEventConsumer * consumer )

Adds a consumer to the list of event consumers.

Parameters

consumer The consumer added to the list.

Returns: Indication as to whether addition has succeeded.

Definition at line 89 of file GHOST_EventManager.cc.

References consumers_, GHOST_ASSERT, GHOST_kFailure, and GHOST_kSuccess.

◆ dispatchEvent() [1/2]

void GHOST_EventManager::dispatchEvent ( )

Dispatches the event at the back of the stack. The event will be removed from the stack.

Definition at line 71 of file GHOST_EventManager.cc.

References dispatchEvent(), events_, and handled_events_.

Referenced by dispatchEvent(), and dispatchEvents().

◆ dispatchEvent() [2/2]

void GHOST_EventManager::dispatchEvent ( const GHOST_IEvent * event )

Dispatches the given event directly, bypassing the event stack.

Definition at line 62 of file GHOST_EventManager.cc.

References consumers_.

◆ dispatchEvents()

void GHOST_EventManager::dispatchEvents ( )

Dispatches all the events on the stack. The event stack will be empty afterwards.

Definition at line 80 of file GHOST_EventManager.cc.

References dispatchEvent(), disposeEvents(), and events_.

◆ disposeEvents()

void GHOST_EventManager::disposeEvents ( )

protected

Removes all events from the stack.

Definition at line 171 of file GHOST_EventManager.cc.

References events_, GHOST_ASSERT, and handled_events_.

Referenced by dispatchEvents(), and ~GHOST_EventManager().

◆ getNumEvents() [1/2]

uint32_t GHOST_EventManager::getNumEvents ( )

Returns the number of events currently on the stack.

Returns: The number of events on the stack.

Definition at line 31 of file GHOST_EventManager.cc.

References events_.

◆ getNumEvents() [2/2]

uint32_t GHOST_EventManager::getNumEvents ( GHOST_TEventType type )

Returns the number of events of a certain type currently on the stack.

Parameters

type	The type of events to be counted.

Returns: The number of events on the stack of this type.

Definition at line 36 of file GHOST_EventManager.cc.

References events_.

◆ pushEvent()

GHOST_TSuccess GHOST_EventManager::pushEvent ( const GHOST_IEvent * event )

Pushes an event on the stack. To dispatch it, call dispatchEvent() or dispatchEvents(). Do not delete the event!

Parameters

event The event to push on the stack.

Definition at line 48 of file GHOST_EventManager.cc.

References events_, GHOST_ASSERT, GHOST_kFailure, and GHOST_kSuccess.

◆ removeConsumer()

GHOST_TSuccess GHOST_EventManager::removeConsumer ( GHOST_IEventConsumer * consumer )

Removes a consumer from the list of event consumers.

Parameters

consumer The consumer removed from the list.

Returns: Indication as to whether removal has succeeded.

Definition at line 108 of file GHOST_EventManager.cc.

References consumers_, GHOST_ASSERT, GHOST_kFailure, and GHOST_kSuccess.

◆ removeTypeEvents()

void GHOST_EventManager::removeTypeEvents	(	GHOST_TEventType	type,
		const GHOST_IWindow *	window = nullptr )

Removes all events of a certain type from the stack. The window parameter is optional. If non-null, the routine will remove events only associated with that window.

Parameters

type	The type of events to be removed.
window	The window to remove the events for.

Definition at line 149 of file GHOST_EventManager.cc.

References events_, and GHOST_PRINT.

Referenced by GHOST_SystemWin32::s_wndProc().

◆ removeWindowEvents()

void GHOST_EventManager::removeWindowEvents ( const GHOST_IWindow * window )

Removes all events for a window from the stack.

Parameters

window The window to remove events for.

Definition at line 127 of file GHOST_EventManager.cc.

References events_, and GHOST_PRINT.

Member Data Documentation

◆ consumers_

TConsumerVector GHOST_EventManager::consumers_

protected

The list with event consumers.

Definition at line 121 of file GHOST_EventManager.hh.

Referenced by addConsumer(), dispatchEvent(), removeConsumer(), and ~GHOST_EventManager().

◆ events_

std::deque<const GHOST_IEvent *> GHOST_EventManager::events_

protected

The event stack.

Definition at line 114 of file GHOST_EventManager.hh.

Referenced by dispatchEvent(), dispatchEvents(), disposeEvents(), getNumEvents(), getNumEvents(), pushEvent(), removeTypeEvents(), and removeWindowEvents().

◆ handled_events_

std::deque<const GHOST_IEvent *> GHOST_EventManager::handled_events_

protected

Definition at line 115 of file GHOST_EventManager.hh.

Referenced by dispatchEvent(), and disposeEvents().

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

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ TConsumerVector

◆ TEventStack

Constructor & Destructor Documentation

◆ GHOST_EventManager()

◆ ~GHOST_EventManager()

Member Function Documentation

◆ addConsumer()

◆ dispatchEvent() [1/2]

◆ dispatchEvent() [2/2]

◆ dispatchEvents()

◆ disposeEvents()

◆ getNumEvents() [1/2]

◆ getNumEvents() [2/2]

◆ pushEvent()

◆ removeConsumer()

◆ removeTypeEvents()

◆ removeWindowEvents()

Member Data Documentation

◆ consumers_

◆ events_

◆ handled_events_