xrb_keyrepeater.hpp

// ///////////////////////////////////////////////////////////////////////////
// xrb_keyrepeater.hpp by Victor Dods, created 2005/02/08
// ///////////////////////////////////////////////////////////////////////////
// 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_KEYREPEATER_HPP_)
#define _XRB_KEYREPEATER_HPP_

#include "xrb.hpp"

#include "xrb_circularqueue.hpp"
#include "xrb_eventhandler.hpp"
#include "xrb_framehandler.hpp"
#include "xrb_input_events.hpp"

namespace Xrb
{

class KeyRepeater : public EventHandler, public FrameHandler
{
public:

    KeyRepeater (
        Float repeat_delay = 0.25,
        Float repeat_period = 0.033);
    ~KeyRepeater ();

    inline bool IsEventQueueFull () const
    {
        return m_key_event_queue.IsFull();
    }
    inline bool IsEventQueueEmpty () const
    {
        return m_key_event_queue.IsEmpty();
    }

    EventKeyRepeat *DequeueEvent ();

protected:

    virtual void HandleFrame ();
    virtual bool HandleEvent (Event const *e);

private:

    void GenerateKeyEvents (Float time);

    enum
    {
        DEFAULT_KEY_EVENT_BUFFER_SIZE = 32
    };

    // indicates if there is a key currently being kept track
    // of by m_current_key_event
    bool m_is_current_key_event_active;
    // the keyboard event which is of the last key to be held down
    // which is still currently held down
    EventKeyDown m_current_key_event;
    // delay before key repeating starts
    Float m_repeat_delay;
    // period of repeat cycle (time between each additional key event
    // to be generated once key repeating has engaged)
    Float m_repeat_period;
    // the earliest time that a repeat event can be generated
    Float m_next_repeat_time;
    // circular queue of buffered key events
    CircularQueue<EventKeyRepeat *, DEFAULT_KEY_EVENT_BUFFER_SIZE> m_key_event_queue;
}; // end of class KeyRepeater

} // end of namespace Xrb

#endif // !defined(_XRB_KEYREPEATER_HPP_)

---