gcn::Input Class Reference

#include <input.hpp>

Inheritance diagram for gcn::Input:

List of all members.

---

Detailed Description

Abstract class for providing functions for user input.

Guichan contains implementations of Input for common libraries like the Allegro library, the HGE library, and the SDL library. To make Guichan usable with other libraries, an Input class must be implemented.

See also:

AllegroInput, HGEInput, OpenLayerInput, SDLInput

Definition at line 79 of file input.hpp.

Public Member Functions
virtual void	_pollInput ()=0
	Polls all exsisting input.
virtual KeyInput	dequeueKeyInput ()=0
	Dequeues the key input queue.
virtual MouseInput	dequeueMouseInput ()=0
	Dequeues the mouse input queue.
virtual bool	isKeyQueueEmpty ()=0
	Checks if the key queue is empty, or not.
virtual bool	isMouseQueueEmpty ()=0
	Checks if the mouse queue is empyt, or not.
virtual	~Input ()
	Destructor.

---

Member Function Documentation

virtual void gcn::Input::_pollInput

(

)

[pure virtual]

Polls all exsisting input.

Called when input should be polled. The function exists for compatibility reason where some libraries need to poll input at a certain logic rate.

Implemented in gcn::AllegroInput, gcn::GenericInput, gcn::HGEInput, gcn::OpenLayerInput, and gcn::SDLInput.

Referenced by gcn::Gui::logic().

virtual KeyInput gcn::Input::dequeueKeyInput

(

)

[pure virtual]

Dequeues the key input queue.

Returns:

The first key input in the key input queue.

Implemented in gcn::AllegroInput, gcn::GenericInput, gcn::HGEInput, gcn::OpenLayerInput, and gcn::SDLInput.

Referenced by gcn::Gui::handleKeyInput().

virtual MouseInput gcn::Input::dequeueMouseInput

(

)

[pure virtual]

Dequeues the mouse input queue.

Returns:

The first mouse input in the mouse input queue.

Implemented in gcn::AllegroInput, gcn::GenericInput, gcn::HGEInput, gcn::OpenLayerInput, and gcn::SDLInput.

Referenced by gcn::Gui::handleMouseInput().

virtual bool gcn::Input::isKeyQueueEmpty

(

)

[pure virtual]

Checks if the key queue is empty, or not.

Returns:

True if the key queue is empty, false otherwise.

Implemented in gcn::AllegroInput, gcn::GenericInput, gcn::HGEInput, gcn::OpenLayerInput, and gcn::SDLInput.

Referenced by gcn::Gui::handleKeyInput().

virtual bool gcn::Input::isMouseQueueEmpty

(

)

[pure virtual]

Checks if the mouse queue is empyt, or not.

Returns:

True if the mouse queue is empty, false otherwise.

Implemented in gcn::AllegroInput, gcn::GenericInput, gcn::HGEInput, gcn::OpenLayerInput, and gcn::SDLInput.

Referenced by gcn::Gui::handleMouseInput().

---

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

• input.hpp

---