kg: src/Input.hh@440763821484 (annotated)

185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	1	#ifndef INPUT_HH
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	2	#define INPUT_HH
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	3
311 440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	4	#include "Timer.hh"
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	5	#include "Types.hh"
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	6
230 78cf0cd69af4 better input handling terom parents: 229 diff changeset	7	#include <ClanLib/Display/input_device.h>
221 fbc5db6fce45 reorganize the weapons code and input handling code terom parents: 212 diff changeset	8	#include <ClanLib/Display/keys.h>
311 440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	9	#include <queue>
185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	10
283 7540b0859579 start adding some documentation, most core classes (outside of Network) are now doxygen-enabled terom parents: 237 diff changeset	11	// const TimeMS INPUT_INTERVAL_MS = 20;
221 fbc5db6fce45 reorganize the weapons code and input handling code terom parents: 212 diff changeset	12
283 7540b0859579 start adding some documentation, most core classes (outside of Network) are now doxygen-enabled terom parents: 237 diff changeset	13	/**
311 440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	14	* Flags to control input behaviour
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	15	*/
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	16	enum InputFlagBits {
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	17	/** Default */
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	18	INPUT_FLAG_REPEAT = 0x0000,
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	19	INPUT_FLAG_NOREPEAT = 0x0001,
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	20	};
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	21
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	22	/**
283 7540b0859579 start adding some documentation, most core classes (outside of Network) are now doxygen-enabled terom parents: 237 diff changeset	23	* The bits used in the PlayerInput bitmask, each represents a separate action handled by LocalPlayer::handleInput.
7540b0859579 start adding some documentation, most core classes (outside of Network) are now doxygen-enabled terom parents: 237 diff changeset	24	*
7540b0859579 start adding some documentation, most core classes (outside of Network) are now doxygen-enabled terom parents: 237 diff changeset	25	* @see LocalPlayer::handleInput
7540b0859579 start adding some documentation, most core classes (outside of Network) are now doxygen-enabled terom parents: 237 diff changeset	26	*/
233 ff4ecea83cf5 start using CL_ResourceManager, change most draw methods to take a Graphics, implment even better input handling, and draw weapon names terom* parents: 230 diff changeset	27	enum PlayerInputBit {
ff4ecea83cf5 start using CL_ResourceManager, change most draw methods to take a Graphics, implment even better input handling, and draw weapon names terom* parents: 230 diff changeset	28	INPUT_NONE = 0x0000,
ff4ecea83cf5 start using CL_ResourceManager, change most draw methods to take a Graphics, implment even better input handling, and draw weapon names terom* parents: 230 diff changeset	29
221 fbc5db6fce45 reorganize the weapons code and input handling code terom parents: 212 diff changeset	30	INPUT_AIM_UP = 0x0001,
fbc5db6fce45 reorganize the weapons code and input handling code terom parents: 212 diff changeset	31	INPUT_AIM_DOWN = 0x0002,
185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	32
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	33	INPUT_MOVE_LEFT = 0x0004,
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	34	INPUT_MOVE_RIGHT = 0x0008,
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	35
221 fbc5db6fce45 reorganize the weapons code and input handling code terom parents: 212 diff changeset	36	INPUT_JUMP = 0x0010,
fbc5db6fce45 reorganize the weapons code and input handling code terom parents: 212 diff changeset	37	INPUT_DIG = 0x0020,
185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	38	INPUT_SHOOT = 0x0040,
237 3d5465bcb67d tweak weapon params and improve weapon changing terom parents: 235 diff changeset	39	INPUT_CHANGE_NEXT = 0x0080,
3d5465bcb67d tweak weapon params and improve weapon changing terom parents: 235 diff changeset	40	INPUT_CHANGE_PREV = 0x0100,
3d5465bcb67d tweak weapon params and improve weapon changing terom parents: 235 diff changeset	41	INPUT_ROPE = 0x0200,
3d5465bcb67d tweak weapon params and improve weapon changing terom parents: 235 diff changeset	42	INPUT_UNROPE = 0x0400,
3d5465bcb67d tweak weapon params and improve weapon changing terom parents: 235 diff changeset	43	INPUT_ROPE_UP = 0x0800,
3d5465bcb67d tweak weapon params and improve weapon changing terom parents: 235 diff changeset	44	INPUT_ROPE_DOWN = 0x1000,
300 417183866f35 suicide key and respawning terom parents: 283 diff changeset	45
417183866f35 suicide key and respawning terom parents: 283 diff changeset	46	INPUT_SUICIDE = 0x2000,
185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	47	};
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	48
283 7540b0859579 start adding some documentation, most core classes (outside of Network) are now doxygen-enabled terom parents: 237 diff changeset	49	/**
7540b0859579 start adding some documentation, most core classes (outside of Network) are now doxygen-enabled terom parents: 237 diff changeset	50	* The bits used in the GuiInput bitmask, each represents something handled locally by Graphics.
7540b0859579 start adding some documentation, most core classes (outside of Network) are now doxygen-enabled terom parents: 237 diff changeset	51	*/
233 ff4ecea83cf5 start using CL_ResourceManager, change most draw methods to take a Graphics, implment even better input handling, and draw weapon names terom* parents: 230 diff changeset	52	enum GuiInputBit {
311 440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	53	GUI_INPUT_NONE = 0x0000,
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	54
233 ff4ecea83cf5 start using CL_ResourceManager, change most draw methods to take a Graphics, implment even better input handling, and draw weapon names terom* parents: 230 diff changeset	55	GUI_INPUT_QUIT = 0x0001,
ff4ecea83cf5 start using CL_ResourceManager, change most draw methods to take a Graphics, implment even better input handling, and draw weapon names terom* parents: 230 diff changeset	56	GUI_INPUT_DISPLAY_WEAPON = 0x0002,
ff4ecea83cf5 start using CL_ResourceManager, change most draw methods to take a Graphics, implment even better input handling, and draw weapon names terom* parents: 230 diff changeset	57	GUI_INPUT_DEBUG_PLAYER = 0x0004,
221 fbc5db6fce45 reorganize the weapons code and input handling code terom parents: 212 diff changeset	58	};
fbc5db6fce45 reorganize the weapons code and input handling code terom parents: 212 diff changeset	59
283 7540b0859579 start adding some documentation, most core classes (outside of Network) are now doxygen-enabled terom parents: 237 diff changeset	60	/**
311 440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	61	* Bitmask of InputFlagBits
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	62	*/
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	63	typedef uint8_t InputFlags;
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	64
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	65	/**
283 7540b0859579 start adding some documentation, most core classes (outside of Network) are now doxygen-enabled terom parents: 237 diff changeset	66	* Bitmask of PlayerInputBits
7540b0859579 start adding some documentation, most core classes (outside of Network) are now doxygen-enabled terom parents: 237 diff changeset	67	*
7540b0859579 start adding some documentation, most core classes (outside of Network) are now doxygen-enabled terom parents: 237 diff changeset	68	* @see PlayerInputBit
7540b0859579 start adding some documentation, most core classes (outside of Network) are now doxygen-enabled terom parents: 237 diff changeset	69	*/
233 ff4ecea83cf5 start using CL_ResourceManager, change most draw methods to take a Graphics, implment even better input handling, and draw weapon names terom* parents: 230 diff changeset	70	typedef uint16_t PlayerInput;
283 7540b0859579 start adding some documentation, most core classes (outside of Network) are now doxygen-enabled terom parents: 237 diff changeset	71
7540b0859579 start adding some documentation, most core classes (outside of Network) are now doxygen-enabled terom parents: 237 diff changeset	72	/**
7540b0859579 start adding some documentation, most core classes (outside of Network) are now doxygen-enabled terom parents: 237 diff changeset	73	* Bitmask for GuiInputBits
7540b0859579 start adding some documentation, most core classes (outside of Network) are now doxygen-enabled terom parents: 237 diff changeset	74	*
7540b0859579 start adding some documentation, most core classes (outside of Network) are now doxygen-enabled terom parents: 237 diff changeset	75	* @see GuiInputBit
7540b0859579 start adding some documentation, most core classes (outside of Network) are now doxygen-enabled terom parents: 237 diff changeset	76	*/
233 ff4ecea83cf5 start using CL_ResourceManager, change most draw methods to take a Graphics, implment even better input handling, and draw weapon names terom* parents: 230 diff changeset	77	typedef uint16_t GuiInput;
185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	78
283 7540b0859579 start adding some documentation, most core classes (outside of Network) are now doxygen-enabled terom parents: 237 diff changeset	79	/**
311 440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	80	* Keymap definition struct
283 7540b0859579 start adding some documentation, most core classes (outside of Network) are now doxygen-enabled terom parents: 237 diff changeset	81	*/
311 440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	82	template <typename BitEnumType> struct InputKeymapEntry {
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	83	/**
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	84	* The input bit to set if present
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	85	*/
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	86	BitEnumType input;
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	87
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	88	/**
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	89	* Flags to use
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	90	*
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	91	* @see InputFlagBits
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	92	*/
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	93	InputFlags flags;
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	94
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	95	/**
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	96	* Up to two keycodes to check
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	97	*/
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	98	int keycodes[2];
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	99	};
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	100
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	101
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	102	/**
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	103	* A InputKeyRepeatQueue entry, this contains the input bit value itself, and then the remaining expire time
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	104	*/
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	105	template <typename BitEnumType> struct InputKeyRepeatEntry {
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	106	BitEnumType value;
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	107	TimeMS expire;
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	108
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	109	public:
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	110	InputKeyRepeatEntry (BitEnumType value, TimeMS expire);
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	111
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	112	/**
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	113	* Since priority_queue always gives the greatest item, the one with the longest expire is the least item
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	114	*/
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	115	bool operator< (const struct InputKeyRepeatEntry &other);
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	116
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	117	/**
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	118	* Decrements expire, returning true if it has now expired, false otherwise
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	119	*/
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	120	bool updateExpired (TimeMS dt);
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	121	};
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	122
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	123	/**
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	124	* A InputKeyRepeatQueue maintains a list of InputKeyRepeatEntry's, lets you add new input values, find old ones,
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	125	* and update the list
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	126	*/
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	127	template <typename BitEnumType> class InputKeyRepeatQueue {
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	128	private:
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	129	TimeMS expire;
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	130
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	131	typedef InputKeyRepeatEntry<BitEnumType> entry_type;
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	132
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	133	std::list<entry_type> list;
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	134
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	135	typedef typename std::list<entry_type>::iterator list_iterator;
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	136
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	137	public:
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	138	/**
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	139	* Constructs this queue to contain entries with the given expiry time
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	140	*/
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	141	InputKeyRepeatQueue (TimeMS expire);
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	142
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	143	/**
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	144	* Push a new input bit onto the queue
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	145	*/
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	146	void push (BitEnumType bit);
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	147
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	148	/**
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	149	* Checks if the given input is in the queue
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	150	*/
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	151	bool find (BitEnumType bit);
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	152
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	153	/**
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	154	* Updates the list, removing expired items
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	155	*/
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	156	void update (TimeMS dt);
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	157	};
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	158
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	159	/**
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	160	* An InputHandler uses an InputKeymapEntry to maintain a BitMaskType of current inputs
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	161	*/
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	162	template <typename BitEnumType, typename BitMaskType> class InputHandler {
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	163	private:
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	164	/**
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	165	* The keyboard that we read input from
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	166	*/
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	167	CL_InputDevice &keyboard;
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	168
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	169	/**
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	170	* The keymap that we use
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	171	*/
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	172	InputKeymapEntry<BitEnumType> *keymap;
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	173
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	174	/**
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	175	* The current bitmask value
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	176	*/
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	177	BitMaskType value;
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	178
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	179	/**
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	180	* How long the bitmask was held...
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	181	*/
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	182	TimeMS dt;
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	183
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	184	/**
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	185	* The KeyRepeatQueue
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	186	*/
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	187	InputKeyRepeatQueue<BitEnumType> queue;
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	188
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	189	public:
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	190	/**
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	191	* Constructs the InputHandler using the given keyboard, keymap and key-repeat expire time
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	192	*/
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	193	InputHandler (CL_InputDevice &keyboard, InputKeymapEntry<BitEnumType> *keymap, TimeMS keyrepeat_expire);
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	194
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	195	private:
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	196	/**
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	197	* Returns true if the keycode is valid, false if not.
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	198	*
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	199	* A positive keycode requires that the keycode be active, a negative keycode that the keycode be inactive,
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	200	* and a zero keycode always returns true.
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	201	*
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	202	* @param keycode A positive keycode to check that it's set, negative keycode to check that it's not set, or zero
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	203	* @returns bool true if positive+set/negavtive+notset/zero, false otherwise
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	204	*/
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	205	bool checkKeycode (int keycode);
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	206
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	207	public:
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	208	/**
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	209	* Updates the keyrepeat queue
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	210	*/
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	211	void update (TimeMS dt);
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	212
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	213	/**
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	214	* Reads the current input mask value and length into mask and dt, and reset ours to zero
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	215	*
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	216	* @param mask our BitMaskType value is returned using this
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	217	* @param dt how long the input was held for
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	218	*/
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	219	void readValue (BitMaskType &mask, TimeMS &dt);
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	220
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	221	};
235 0a0c729365ee code cleanup terom parents: 233 diff changeset	222
283 7540b0859579 start adding some documentation, most core classes (outside of Network) are now doxygen-enabled terom parents: 237 diff changeset	223	/**
7540b0859579 start adding some documentation, most core classes (outside of Network) are now doxygen-enabled terom parents: 237 diff changeset	224	* Handles reading input from a keyboard and mapping it to PlayerInput/GuiInput bitmasks
7540b0859579 start adding some documentation, most core classes (outside of Network) are now doxygen-enabled terom parents: 237 diff changeset	225	*/
235 0a0c729365ee code cleanup terom parents: 233 diff changeset	226	class Input {
0a0c729365ee code cleanup terom parents: 233 diff changeset	227	protected:
311 440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	228	/**
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	229	* The keyboard device that we use
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	230	*/
235 0a0c729365ee code cleanup terom parents: 233 diff changeset	231	CL_InputDevice &keyboard;
0a0c729365ee code cleanup terom parents: 233 diff changeset	232
311 440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	233	/**
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	234	* Our update timer
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	235	*/
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	236	Timer update_timer;
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	237
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	238	CL_SlotContainer slots;
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	239
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	240	/**
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	241	* Our PlayerInput
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	242	*/
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	243	InputHandler<PlayerInputBit, PlayerInput> player;
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	244
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	245	/**
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	246	* Our GuiInput
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	247	*/
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	248	InputHandler<GuiInputBit, GuiInput> gui;
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	249
235 0a0c729365ee code cleanup terom parents: 233 diff changeset	250	public:
311 440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	251	/**
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	252	* Build the input handler using the given keyboard and the default keymaps
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	253	*/
235 0a0c729365ee code cleanup terom parents: 233 diff changeset	254	Input (CL_InputDevice &keyboard);
0a0c729365ee code cleanup terom parents: 233 diff changeset	255
0a0c729365ee code cleanup terom parents: 233 diff changeset	256	public:
311 440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	257	/**
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	258	* Reads the current PlayerInput value via mask, and the length of the input via dt
235 0a0c729365ee code cleanup terom parents: 233 diff changeset	259	*/
311 440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	260	void readPlayerInput (PlayerInput &mask, TimeMS &dt);
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	261
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	262	/**
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	263	* Reads the current GuiInput mask and returns it
440763821484 make Input have its own timer, and add key-repeat handling, and fix some warnings terom parents: 300 diff changeset	264	*/
235 0a0c729365ee code cleanup terom parents: 233 diff changeset	265	GuiInput readGuiInput (void);
0a0c729365ee code cleanup terom parents: 233 diff changeset	266	};
230 78cf0cd69af4 better input handling terom parents: 229 diff changeset	267
185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	268	#endif

author	terom
	Mon, 08 Dec 2008 21:18:08 +0000
changeset 311	440763821484
parent 300	417183866f35
child 319	9f6a838d58c4
permissions	-rw-r--r--