---

EventQueue Class Reference

A queue of pending events. More...

#include <eventQueue.h>

List of all members.

Public Types
enum	{ max_events = 500 }
Public Member Functions
	EventQueue ()
	~EventQueue ()
void	queue_event (CPT_Event event)
void	clear ()
	Empties all events on the queue, throwing them on the floor.
bool	is_queue_empty () const
bool	is_queue_full () const
CPT_Event	dequeue_event ()
Static Public Member Functions
EventQueue *	get_global_event_queue ()
	Returns a pointer to the one global EventQueue object.
Static Protected Member Functions
void	make_global_event_queue ()
Protected Attributes
CircBuffer< CPT_Event, max_events >	_queue
Static Protected Attributes
EventQueue *	_global_event_queue = NULL

---

Detailed Description

A queue of pending events.

As events are thrown, they are added to this queue; eventually, they will be extracted out again by an EventHandler and processed.

Definition at line 49 of file eventQueue.h.

---

Member Enumeration Documentation

anonymous enum

Enumeration values: max_events  Definition at line 51 of file eventQueue.h.

---

Constructor & Destructor Documentation

EventQueue::EventQueue (   )

Definition at line 36 of file eventQueue.cxx.

EventQueue::~EventQueue (   )

Definition at line 47 of file eventQueue.cxx. References _queue, CircBuffer< CPT_Event, max_events >::full(), and CircBuffer< CPT_Event, max_events >::push_back().

---

Member Function Documentation

void EventQueue::clear (   )

Empties all events on the queue, throwing them on the floor. Definition at line 91 of file eventQueue.cxx. References _queue, and CircBuffer< CPT_Event, max_events >::empty().

CPT_Event EventQueue::dequeue_event (   )

Definition at line 124 of file eventQueue.cxx. Referenced by EventHandler::EventHandler().

EventQueue * EventQueue::get_global_event_queue (   )  [inline, static]

Returns a pointer to the one global EventQueue object. If the global object has not yet been created, this will create it. Definition at line 36 of file eventQueue.I. Referenced by throw_event().

bool EventQueue::is_queue_empty (   )  const

Definition at line 106 of file eventQueue.cxx. References _queue, and CircBuffer< CPT_Event, max_events >::front(). Referenced by EventHandler::EventHandler().

bool EventQueue::is_queue_full (   )  const

Definition at line 111 of file eventQueue.cxx. References _queue.

void EventQueue::make_global_event_queue (   )  [static, protected]

Definition at line 140 of file eventQueue.cxx.

void EventQueue::queue_event (  CPT_Event  event  )

Definition at line 58 of file eventQueue.cxx. Referenced by throw_event().

---

Member Data Documentation

EventQueue * EventQueue::_global_event_queue = NULL [static, protected]

Definition at line 25 of file eventQueue.cxx.

CircBuffer<CPT_Event, max_events> EventQueue::_queue [protected]

Definition at line 68 of file eventQueue.h. Referenced by clear(), is_queue_empty(), is_queue_full(), and ~EventQueue().

---

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

• panda/src/event/eventQueue.h
• panda/src/event/eventQueue.cxx
• panda/src/event/eventQueue.I

---