xrb_eventhandler.hpp

// ///////////////////////////////////////////////////////////////////////////
// xrb_eventhandler.hpp by Victor Dods, created 2004/09/11
// ///////////////////////////////////////////////////////////////////////////
// Unless a different license was explicitly granted in writing by the
// copyright holder (Victor Dods), this software is freely distributable under
// the terms of the GNU General Public License, version 2.  Any works deriving
// from this work must also be released under the GNU GPL.  See the included
// file LICENSE for details.
// ///////////////////////////////////////////////////////////////////////////

#if !defined(_XRB_EVENTHANDLER_HPP_)
#define _XRB_EVENTHANDLER_HPP_

#include "xrb.hpp"

namespace Xrb
{

class Event;
class EventQueue;

class EventHandler
{
public:

    EventHandler (EventQueue *owner_event_queue);
    virtual ~EventHandler ();

    bool ProcessEvent (Event const *e);
    void EnqueueEvent (Event const *e);

    inline EventQueue *OwnerEventQueue () const
    {
        return m_owner_event_queue;
    }
    inline bool IsBlockingEvents () const
    {
        return m_is_blocking_events;
    }
    inline Float MostRecentEventTime () const
    {
        return Max(m_most_recent_event_time, 0.0f);
    }
    inline Float EventTime () const
    {
        ASSERT1(m_event_dt >= 0.0);
        return m_current_event_time;
    }
    inline Float EventDT () const
    {
        ASSERT1(m_event_dt >= 0.0);
        return m_event_dt;
    }

    inline void SetIsBlockingEvents (bool const is_blocking_events)
    {
        m_is_blocking_events = is_blocking_events;
    }

protected:

    inline void SetOwnerEventQueue (EventQueue *const owner_event_queue)
    {
        m_owner_event_queue = owner_event_queue;
    }

    virtual bool HandleEvent (Event const *e) = 0;

private:

    // the EventQueue which administers this EventHandler
    EventQueue *m_owner_event_queue;
    // indicates if this event handler is blocking events or not
    bool m_is_blocking_events;
    // the event time for the most recently processed event
    Float m_most_recent_event_time;
    // the current event time
    Float m_current_event_time;
    // the delta between the last event time and the current frame time
    Float m_event_dt;
}; // end of class EventHandler

} // end of namespace Xrb

#endif // !defined(_XRB_EVENTHANDLER_HPP_)

---