This Determines the kind of user input. More...

#include <metacode.h>

Public Types
enum	ButtonState { BUTTON_LIFTING = -1, BUTTON_UP = 0, BUTTON_PRESSING = 1, BUTTON_DOWN = 2 }
	An Optional listing of value that can be used in a metacode to represent the information of a button press. More...
enum	DirectionalMotionState { DIRECTIONALMOTION_UPLEFT = 1, DIRECTIONALMOTION_UNCHANGED = 0, DIRECTIONALMOTION_DOWNRIGHT = -1 }
	An Optional listing of values that can be used in a metacode Indicate spin, digital or binary travel in a directionl. More...
enum	InputCode { KEY_FIRST = 0, KEY_UNKNOWN = 0, KEY_A = 4, KEY_B = 5, KEY_C = 6, KEY_D = 7, KEY_E = 8, KEY_F = 9, KEY_G = 10, KEY_H = 11, KEY_I = 12, KEY_J = 13, KEY_K = 14, KEY_L = 15, KEY_M = 16, KEY_N = 17, KEY_O = 18, KEY_P = 19, KEY_Q = 20, KEY_R = 21, KEY_S = 22, KEY_T = 23, KEY_U = 24, KEY_V = 25, KEY_W = 26, KEY_X = 27, KEY_Y = 28, KEY_Z = 29, KEY_1 = 30, KEY_2 = 31, KEY_3 = 32, KEY_4 = 33, KEY_5 = 34, KEY_6 = 35, KEY_7 = 36, KEY_8 = 37, KEY_9 = 38, KEY_0 = 39, KEY_RETURN = 40, KEY_ESCAPE = 41, KEY_BACKSPACE = 42, KEY_TAB = 43, KEY_SPACE = 44, KEY_MINUS = 45, KEY_EQUALS = 46, KEY_LEFTBRACKET = 47, KEY_RIGHTBRACKET = 48, KEY_BACKSLASH = 49, KEY_NONUSHASH = 50, KEY_SEMICOLON = 51, KEY_APOSTROPHE = 52, KEY_GRAVE = 53, KEY_COMMA = 54, KEY_PERIOD = 55, KEY_SLASH = 56, KEY_CAPSLOCK = 57, KEY_F1 = 58, KEY_F2 = 59, KEY_F3 = 60, KEY_F4 = 61, KEY_F5 = 62, KEY_F6 = 63, KEY_F7 = 64, KEY_F8 = 65, KEY_F9 = 66, KEY_F10 = 67, KEY_F11 = 68, KEY_F12 = 69, KEY_PRINTSCREEN = 70, KEY_SCROLLLOCK = 71, KEY_PAUSE = 72, KEY_INSERT = 73, KEY_HOME = 74, KEY_PAGEUP = 75, KEY_DELETE = 76, KEY_END = 77, KEY_PAGEDOWN = 78, KEY_RIGHT = 79, KEY_LEFT = 80, KEY_DOWN = 81, KEY_UP = 82, KEY_NUMLOCKCLEAR = 83, KEY_KP_DIVIDE = 84, KEY_KP_MULTIPLY = 85, KEY_KP_MINUS = 86, KEY_KP_PLUS = 87, KEY_KP_ENTER = 88, KEY_KP_1 = 89, KEY_KP_2 = 90, KEY_KP_3 = 91, KEY_KP_4 = 92, KEY_KP_5 = 93, KEY_KP_6 = 94, KEY_KP_7 = 95, KEY_KP_8 = 96, KEY_KP_9 = 97, KEY_KP_0 = 98, KEY_KP_PERIOD = 99, KEY_NONUSBACKSLASH = 100, KEY_APPLICATION = 101, KEY_POWER = 102, KEY_KP_EQUALS = 103, KEY_F13 = 104, KEY_F14 = 105, KEY_F15 = 106, KEY_F16 = 107, KEY_F17 = 108, KEY_F18 = 109, KEY_F19 = 110, KEY_F20 = 111, KEY_F21 = 112, KEY_F22 = 113, KEY_F23 = 114, KEY_F24 = 115, KEY_EXECUTE = 116, KEY_HELP = 117, KEY_MENU = 118, KEY_SELECT = 119, KEY_STOP = 120, KEY_AGAIN = 121, KEY_UNDO = 122, KEY_CUT = 123, KEY_COPY = 124, KEY_PASTE = 125, KEY_FIND = 126, KEY_MUTE = 127, KEY_VOLUMEUP = 128, KEY_VOLUMEDOWN = 129, KEY_KP_COMMA = 133, KEY_KP_EQUALSAS400 = 134, KEY_INTERNATIONAL1 = 135, KEY_INTERNATIONAL2 = 136, KEY_INTERNATIONAL3 = 137, KEY_INTERNATIONAL4 = 138, KEY_INTERNATIONAL5 = 139, KEY_INTERNATIONAL6 = 140, KEY_INTERNATIONAL7 = 141, KEY_INTERNATIONAL8 = 142, KEY_INTERNATIONAL9 = 143, KEY_LANG1 = 144, KEY_LANG2 = 145, KEY_LANG3 = 146, KEY_LANG4 = 147, KEY_LANG5 = 148, KEY_LANG6 = 149, KEY_LANG7 = 150, KEY_LANG8 = 151, KEY_LANG9 = 152, KEY_ALTERASE = 153, KEY_SYSREQ = 154, KEY_CANCEL = 155, KEY_CLEAR = 156, KEY_PRIOR = 157, KEY_RETURN2 = 158, KEY_SEPARATOR = 159, KEY_OUT = 160, KEY_OPER = 161, KEY_CLEARAGAIN = 162, KEY_CRSEL = 163, KEY_EXSEL = 164, KEY_KP_00 = 176, KEY_KP_000 = 177, KEY_THOUSANDSSEPARATOR = 178, KEY_DECIMALSEPARATOR = 179, KEY_CURRENCYUNIT = 180, KEY_CURRENCYSUBUNIT = 181, KEY_KP_LEFTPAREN = 182, KEY_KP_RIGHTPAREN = 183, KEY_KP_LEFTBRACE = 184, KEY_KP_RIGHTBRACE = 185, KEY_KP_TAB = 186, KEY_KP_BACKSPACE = 187, KEY_KP_A = 188, KEY_KP_B = 189, KEY_KP_C = 190, KEY_KP_D = 191, KEY_KP_E = 192, KEY_KP_F = 193, KEY_KP_XOR = 194, KEY_KP_POWER = 195, KEY_KP_PERCENT = 196, KEY_KP_LESS = 197, KEY_KP_GREATER = 198, KEY_KP_AMPERSAND = 199, KEY_KP_DBLAMPERSAND = 200, KEY_KP_VERTICALBAR = 201, KEY_KP_DBLVERTICALBAR = 202, KEY_KP_COLON = 203, KEY_KP_HASH = 204, KEY_KP_SPACE = 205, KEY_KP_AT = 206, KEY_KP_EXCLAM = 207, KEY_KP_MEMSTORE = 208, KEY_KP_MEMRECALL = 209, KEY_KP_MEMCLEAR = 210, KEY_KP_MEMADD = 211, KEY_KP_MEMSUBTRACT = 212, KEY_KP_MEMMULTIPLY = 213, KEY_KP_MEMDIVIDE = 214, KEY_KP_PLUSMINUS = 215, KEY_KP_CLEAR = 216, KEY_KP_CLEARENTRY = 217, KEY_KP_BINARY = 218, KEY_KP_OCTAL = 219, KEY_KP_DECIMAL = 220, KEY_KP_HEXADECIMAL = 221, KEY_LCTRL = 224, KEY_LSHIFT = 225, KEY_LALT = 226, KEY_LSUPER = 227, KEY_RCTRL = 228, KEY_RSHIFT = 229, KEY_RALT = 230, KEY_RSUPER = 231, KEY_MODE = 257, KEY_AUDIONEXT = 258, KEY_AUDIOPREV = 259, KEY_AUDIOSTOP = 260, KEY_AUDIOPLAY = 261, KEY_AUDIOMUTE = 262, KEY_MEDIASELECT = 263, KEY_WWW = 264, KEY_MAIL = 265, KEY_CALCULATOR = 266, KEY_COMPUTER = 267, KEY_AC_SEARCH = 268, KEY_AC_HOME = 269, KEY_AC_BACK = 270, KEY_AC_FORWARD = 271, KEY_AC_STOP = 272, KEY_AC_REFRESH = 273, KEY_AC_BOOKMARKS = 274, KEY_BRIGHTNESSDOWN = 275, KEY_BRIGHTNESSUP = 276, KEY_DISPLAYSWITCH = 277, KEY_KBDILLUMTOGGLE = 278, KEY_KBDILLUMDOWN = 279, KEY_KBDILLUMUP = 280, KEY_EJECT = 281, KEY_SLEEP = 282, KEY_LAST = 379, MOUSE_FIRST = 380, MOUSEBUTTON = 380, MOUSEBUTTON_FIRST = 381, MOUSEBUTTON_1 = 381, MOUSEBUTTON_2 = 382, MOUSEBUTTON_3 = 383, MOUSEBUTTON_4 = 384, MOUSEBUTTON_5 = 385, MOUSEBUTTON_6 = 386, MOUSEBUTTON_7 = 387, MOUSEBUTTON_8 = 388, MOUSEBUTTON_9 = 389, MOUSEBUTTON_10 = 390, MOUSEBUTTON_11 = 391, MOUSEBUTTON_12 = 392, MOUSEBUTTON_13 = 393, MOUSEBUTTON_14 = 394, MOUSEBUTTON_15 = 395, MOUSEBUTTON_16 = 396, MOUSEBUTTON_17 = 397, MOUSEBUTTON_18 = 398, MOUSEBUTTON_19 = 399, MOUSEBUTTON_20 = 400, MOUSEBUTTON_LAST = 400, INPUTEVENT_FIRST = 401, MOUSEABSOLUTEVERTICAL = 402, MOUSEABSOLUTEHORIZONTAL = 403, MOUSEVERTICAL = 404, MOUSEHORIZONTAL = 405, MOUSEWHEELVERTICAL = 406, MOUSEWHEELHORIZONTAL = 407, MOUSE_LAST = 410, MOTION_FIRST = 420, MOTION_LAST = 429, MULTITOUCH_FIRST = 440, MULTITOUCH_ACTION = 441, MULTITOUCH_GESTURE = 442, MULTITOUCH_PINCH = 443, MULTITOUCH_STRETCH = 444, MULTITOUCH_LAST = 449, JOYSTICK_FIRST = 450, JOYSTICKBUTTON = 450, JOYSTICKBUTTON_FIRST = 451, JOYSTICKBUTTON_1 = 451, JOYSTICKBUTTON_2 = 452, JOYSTICKBUTTON_3 = 453, JOYSTICKBUTTON_4 = 454, JOYSTICKBUTTON_5 = 455, JOYSTICKBUTTON_6 = 456, JOYSTICKBUTTON_7 = 457, JOYSTICKBUTTON_8 = 458, JOYSTICKBUTTON_9 = 459, JOYSTICKBUTTON_10 = 460, JOYSTICKBUTTON_11 = 461, JOYSTICKBUTTON_12 = 462, JOYSTICKBUTTON_13 = 463, JOYSTICKBUTTON_14 = 464, JOYSTICKBUTTON_15 = 465, JOYSTICKBUTTON_16 = 466, JOYSTICKBUTTON_17 = 467, JOYSTICKBUTTON_18 = 468, JOYSTICKBUTTON_19 = 469, JOYSTICKBUTTON_20 = 470, JOYSTICKBUTTON_LAST = 470, JOYSTICKAXIS = 480, JOYSTICKAXIS_FIRST = 481, JOYSTICKAXIS_1 = 481, JOYSTICKAXIS_2 = 482, JOYSTICKAXIS_3 = 483, JOYSTICKAXIS_4 = 484, JOYSTICKAXIS_5 = 485, JOYSTICKAXIS_6 = 486, JOYSTICKAXIS_7 = 487, JOYSTICKAXIS_8 = 488, JOYSTICKAXIS_9 = 489, JOYSTICKAXIS_10 = 490, JOYSTICKAXIS_11 = 491, JOYSTICKAXIS_12 = 492, JOYSTICKAXIS_13 = 493, JOYSTICKAXIS_14 = 494, JOYSTICKAXIS_15 = 495, JOYSTICKAXIS_16 = 496, JOYSTICKAXIS_17 = 497, JOYSTICKAXIS_18 = 498, JOYSTICKAXIS_19 = 499, JOYSTICKAXIS_20 = 500, JOYSTICKAXIS_LAST = 500, JOYSTICKBALL_VERTICAL = 501, JOYSTICKBALL_HORIZONTAL = 502, JOYSTICKHAT_1_VERTICAL = 505, JOYSTICKHAT_1_HORIZONTAL = 506, JOYSTICKHAT_2_VERTICAL = 507, JOYSTICKHAT_2_HORIZONTAL = 508, JOYSTICKHAT_3_VERTICAL = 509, JOYSTICKHAT_3_HORIZONTAL = 510, JOYSTICK_LAST = 512, INPUTEVENT_LAST = 1024 }
	The InputCode enum defines all the posible types of inputs. More...
Usage page 0x0C
These values are mapped from usage page 0x0C (USB consumer page).
Walther keys
These are values that Christian Walther added (for mac keyboard?).
Public Member Functions
	MetaCode ()
	Default constructor.
	MetaCode (const int &MetaValue_, const MetaCode::InputCode &Code_)
	Descriptive Constructor.
	MetaCode (const RawEvent &RawEvent_)
	The Heavy Lifting Constructor.
MetaCode::InputCode	GetCode () const
	This Returns the Inputcode.
int	GetMetaValue () const
	This Returns the MetaValue.
MetaCode::ButtonState	GetMetaValueAsButtonState () const
	Get the MetaValue as a MetaCode::ButtonState.
MetaCode::DirectionalMotionState	GetMetaValueAsDirectionalMotionState () const
	Get the MetaValue as a MetaCode::
bool	IsAltKey () const
	Is this a left or right Alt key.
bool	IsCtrlKey () const
	Is this a left or right Ctrl key.
bool	IsJoyStickEvent () const
	Does this MetaCode Represent a state of a Joystick Event.
bool	IsKeyboardButton () const
	Does this MetaCode Represent a state of a keyboard key.
bool	IsMouseButton () const
	Does this MetaCode Represent a state of a Mouse button.
bool	IsOtherInputEvent () const
	Does this MetaCode Represent some other (non-keyboard and non-mouse button)
bool	IsPollable () const
	Is this metacode a pollable event.
bool	IsShiftKey () const
	Is this a left or right Shift key.
bool	IsSuperKey () const
	Is this a left or right Super key (Windows logo key, Apple logo key, etc...)
bool	operator== (const MetaCode &other) const
	Compares two MetaCodes for equality.
virtual void	ProtoDeSerialize (const xml::Node &OneNode)
	Take the data stored in an XML and overwrite this instance of this object with it.
virtual void	ProtoSerialize (xml::Node &CurrentRoot) const
	Convert this class to an xml::Node ready for serialization.
String	SerializableName () const
	Get the name of the the XML tag this class will leave behind as its instances are serialized.
void	SetCode (int Code_)
	This Sets The InputCode using an int.
void	SetCode (const MetaCode::InputCode &Code_)
	This Sets The InputCode.
void	SetMetaValue (const int &MetaValue_)
	This Sets The MetaValue.
Static Public Member Functions
static MetaCode::InputCode	GetJoystickAxisCode (short unsigned int AxisNumber)
	Accepts a int and returns the InputCode for the Corresponding Joystick Axis.
static MetaCode::InputCode	GetJoystickButtonCode (short unsigned int ButtonNumber)
	Accepts a int and returns the InputCode for the Corresponding Joystick button.
static MetaCode::InputCode	GetMouseButtonCode (short unsigned int ButtonNumber)
	Accepts a int and returns the InputCode for the Corresponding Mouse button.

Detailed Description

This Determines the kind of user input.

A Metacode contains the data that is passed around with an input event. It stores one type of button press or analog representation (Mouse move, joystick tilt, wheel spin, etc...). If it is an analog representation it will also store how far or how it is pushed, pressed, rotated, or whatever. Several of these can be used in combination to represent button combinations, or complex input combinations (like portions of fighter game moves).

Definition at line 86 of file metacode.h.

Member Enumeration Documentation

enum Mezzanine::MetaCode::ButtonState

An Optional listing of value that can be used in a metacode to represent the information of a button press.

This is optional set of values that can make working with buttons easier. The values the engine pass via the the event manager will all use these whereever appropriate.

Enumerator:

BUTTON_LIFTING	Used when the key stops being pressed.
BUTTON_UP	The default state of a key.
BUTTON_PRESSING	This is used at the exact point in time that a key goes from unpressed to pressed.
BUTTON_DOWN	This is used the entire time a key is down.

Definition at line 550 of file metacode.h.

enum Mezzanine::MetaCode::DirectionalMotionState

An Optional listing of values that can be used in a metacode Indicate spin, digital or binary travel in a directionl.

This is optional set of values that can make working with the MouseWheel, Joystick hats and other items that can be moved along 1 axis in two dirctions easier. The values the engine pass via the the event manager will all use these whereever appropriate.

Enumerator:

DIRECTIONALMOTION_UPLEFT	Optionally Used when the device is spun/moved up or to the left as a MetaValue
DIRECTIONALMOTION_UNCHANGED	This really isn't used in normal situations, but if a mousewheel or joyhat event is ever needed when the device is unmoved
DIRECTIONALMOTION_DOWNRIGHT	Optionally Used when the MouseWheel/Joyhat is spun Down/Right as a Meta Code

Definition at line 561 of file metacode.h.

enum Mezzanine::MetaCode::InputCode

The InputCode enum defines all the posible types of inputs.

It has one entry for each key on a most keyboards. Then it has an entry for most mouse and joystick input methods.

Warning:: Once upon a time, this partially matched with ascii. It doesn't anymore.

Enumerator:

KEY_FIRST	KEY_FIRST Same Value as KEY_UNKOWN, is Guaranteed to be the lowest value of any key.
KEY_UNKNOWN	KEY_UNKNOWN This is used for unsupported keys or keys that are not in Unicode.
KEY_BACKSLASH	Located at the lower left of the return key on ISO keyboards and at the right end of the QWERTY row on ANSI keyboards. Produces REVERSE SOLIDUS (backslash) and VERTICAL LINE in a US layout, REVERSE SOLIDUS and VERTICAL LINE in a UK Mac layout, NUMBER SIGN and TILDE in a UK Windows layout, DOLLAR SIGN and POUND SIGN in a Swiss German layout, NUMBER SIGN and APOSTROPHE in a German layout, GRAVE ACCENT and POUND SIGN in a French Mac layout, and ASTERISK and MICRO SIGN in a French Windows layout.
KEY_NONUSHASH	ISO USB keyboards actually use this code instead of 49 for the same key, but all OSes I've seen treat the two codes identically. So, as an implementor, unless your keyboard generates both of those codes and your OS treats them differently, you should generate KEY_BACKSLASH instead of this code. As a user, you should not rely on this code because SDL will never generate it with most (all?) keyboards.
KEY_GRAVE	Located in the top left corner (on both ANSI and ISO keyboards). Produces GRAVE ACCENT and TILDE in a US Windows layout and in US and UK Mac layouts on ANSI keyboards, GRAVE ACCENT and NOT SIGN in a UK Windows layout, SECTION SIGN and PLUS-MINUS SIGN in US and UK Mac layouts on ISO keyboards, SECTION SIGN and DEGREE SIGN in a Swiss German layout (Mac: only on ISO keyboards), CIRCUMFLEX ACCENT and DEGREE SIGN in a German layout (Mac: only on ISO keyboards), SUPERSCRIPT TWO and TILDE in a French Windows layout, COMMERCIAL AT and NUMBER SIGN in a French Mac layout on ISO keyboards, and LESS-THAN SIGN and GREATER-THAN SIGN in a Swiss German, German, or French Mac layout on ANSI keyboards.
KEY_INSERT	insert on PC, help on some Mac keyboards (but does send code 73, not 117)
KEY_NUMLOCKCLEAR	num lock on PC, clear on Mac keyboards
KEY_NONUSBACKSLASH	This is the additional key that ISO keyboards have over ANSI ones, located between left shift and Y. Produces GRAVE ACCENT and TILDE in a US or UK Mac layout, REVERSE SOLIDUS (backslash) and VERTICAL LINE in a US or UK Windows layout, and LESS-THAN SIGN and GREATER-THAN SIGN in a Swiss German, German, or French layout.
KEY_APPLICATION	windows contextual menu, compose
KEY_POWER	The USB document says this is a status flag, not a physical key - but some Mac keyboards do have a power key.
KEY_AGAIN	redo
KEY_INTERNATIONAL1	used on Asian keyboards, see footnotes in USB doc
KEY_INTERNATIONAL3	Yen
KEY_LANG1	Hangul/English toggle
KEY_LANG2	Hanja conversion
KEY_LANG3	Katakana
KEY_LANG4	Hiragana
KEY_LANG5	Zenkaku/Hankaku
KEY_LANG6	reserved
KEY_LANG7	reserved
KEY_LANG8	reserved
KEY_LANG9	reserved
KEY_ALTERASE	Erase-Eaze
KEY_LALT	alt, option
KEY_LSUPER	windows, command (apple), meta
KEY_RALT	alt gr, option
KEY_RSUPER	windows, command (apple), meta
KEY_MODE	I'm not sure if this is really not covered by any of the above, but since there's a special KMOD_MODE for it I'm adding it here
KEY_DISPLAYSWITCH	display mirroring/dual display switch, video mode switch
KEY_LAST	The last Keyboard InputCode, all Keys values will be less than this, and all Events will be larger than that.
MOUSE_FIRST	The First Mouse event, all Mouse Event values will be more than this.
MOUSEBUTTON	This is the generic Some mouse button code. You can add the number of the mouse button to this and you will get the approriate code. Example (MOUSEBUTTON_1 == MOUSEBUTTON + 1)
MOUSEBUTTON_FIRST	This is the lowest mouse button value, all mice values will be larger of equal to this.
MOUSEBUTTON_1	Most commonly left click.
MOUSEBUTTON_2	Most Commonly Right click.
MOUSEBUTTON_3	Most commonly middle click.
MOUSEBUTTON_LAST	The Last mouse button event, all mouse button event will be lower or equal to this.
INPUTEVENT_FIRST	The First non-button event, all Mouse and keyboard button values will be Less than this.
MOUSE_LAST	The last MouseEvent Code, all Mouse events will be less than this.
MOTION_FIRST	The first Motion event.
MOTION_LAST	The last Motion event.
MULTITOUCH_FIRST	The first Multi Touch event.
MULTITOUCH_LAST	The last Multi Touch event.
JOYSTICK_FIRST	The First JoyStick event, all Joystick Event values will be more than this.
JOYSTICKBUTTON	This is the generic Some stickbutton button code. You can add the number of the jpystick button to this and you will get the approriate code. Example (JOYSTICKBUTTON_1 == JOYSTICKBUTTON + 1)
JOYSTICKBUTTON_FIRST	This is the lowest Joystick button value, all joystickbutton values will be larger of equal to this.
JOYSTICKBUTTON_LAST	The Last Joystick button event, all joystick button event will be lower or equal to this.
JOYSTICKAXIS	This is the generic joystick axis code. You can add the number of the joystick axis to this and you will get the approriate code. Example (JOYSTICKAXIS_1 == JOYSTICKAXIS + 1)
JOYSTICKAXIS_FIRST	This is the lowest Joystick axis value, all jpystick values will be larger of equal to this.
JOYSTICKAXIS_LAST	The Last Joystick axis event, all joystick axis event will be lower or equal to this.
JOYSTICK_LAST	The last JoyStick Input Code, all JoyStick events will be less than this.
INPUTEVENT_LAST	The last Input Code, all event codes will be less than this.

Definition at line 95 of file metacode.h.

Constructor & Destructor Documentation

Mezzanine::MetaCode::MetaCode ( )

Default constructor.

This sets nothing on the MetaCode and leaves it completely unassigned. Accessing a data member could cause problems

Definition at line 71 of file metacode.cpp.

Mezzanine::MetaCode::MetaCode	(	const int &	MetaValue_,
		const MetaCode::InputCode &	Code_
	)

Descriptive Constructor.

This sets all values in the MetaCode, leaving it in completely ready state. This is the ideal constructor for simulating user input.

Parameters:

MetaValue_	How much is something moving, tilting, rotating or whatever. For buttons a positive value is pushed, and a negative value is becoming unpressed, and 0 is unpressed.
Code_	Which key or which type of input was pressed. Sqeaky, thinks this has partial unicode support.

Definition at line 74 of file metacode.cpp.

Mezzanine::MetaCode::MetaCode ( const RawEvent & RawEvent_ )

The Heavy Lifting Constructor.

This contructor accepts a RawEvent from the input event subsystem internal to the engine. This converts all the required information from the lower level format and store what is needed in the event that is created. This is used heavily by engine internals.
This constructor expects to receive a type of RawEvent that can be converted into exactly one kind of Metacode. Depending on the User input subsystem, this could be all RawEvents, or even just some RawEvents.

Exceptions:

RawEvent which creates Multiple Metacodes inserted into Metacode	- Thrown when passed a certain (system dependant) incorrect type of RawEvent.
Unknown User Input Inserted into Metacode	- Thrown when receiving either a corrupt, improperly handle, or unsupported RawEvent.

Warning:: We recomend against using this Constructor, because the binary format of RawEvent could change if the input event SubSystem Changes. In that event you would have to recompile your application to get it working with a new version of Mezzanine. Using this function in Game code removes any gaurantees of Game Code Portability.

Definition at line 79 of file metacode.cpp.

Member Function Documentation

MetaCode::InputCode Mezzanine::MetaCode::GetCode ( ) const

This Returns the Inputcode.

This Value can be use to determine what keyboard button has been pressed, or what specific kind of Joystick or mouse event has occurred. This value can be set with SetCode .

Returns:: This returns the input code for this MetaCode

Definition at line 191 of file metacode.cpp.

MetaCode::InputCode Mezzanine::MetaCode::GetJoystickAxisCode ( short unsigned int AxisNumber ) [static]

Accepts a int and returns the InputCode for the Corresponding Joystick Axis.

Parameters:

AxisNumber The number of the button you want the code for

Returns:: When passed 0 this returns MetaCode::JOYSTICKAXIS, otherwise this returns MetaCode::JOYSTICKAXIS_X where X is the number that was passed in

Definition at line 227 of file metacode.cpp.

MetaCode::InputCode Mezzanine::MetaCode::GetJoystickButtonCode ( short unsigned int ButtonNumber ) [static]

Accepts a int and returns the InputCode for the Corresponding Joystick button.

Parameters:

ButtonerNumber The number of the button you want the code for

Returns:: When passed 0 this returns MetaCode::JOYSTICKBUTTON, otherwise this returns MetaCode::JOYSTICKBUTTON_X where X is the number that was passed in

Definition at line 219 of file metacode.cpp.

int Mezzanine::MetaCode::GetMetaValue ( ) const

This Returns the MetaValue.

The MetaValue can be use to determine how far something is tilted, pushed, rotated, or other analog value. This value can be set with SetMetaValue .

Returns:: This returns the input code for this MetaCode. This could return any number inside a range (depending on hardware and configuration) to represent how tilted a joystick or how much a mouse moved.

Definition at line 186 of file metacode.cpp.

MetaCode::ButtonState Mezzanine::MetaCode::GetMetaValueAsButtonState ( ) const

Get the MetaValue as a MetaCode::ButtonState.

Returns:: This returns the appropriate button state or throws an Mezzanine::Exception if an invalid button state is stored in the MetaValue

Exceptions:

This	throws a Mezzanine::Exception if the MetaValue is less than BUTTON_LIFTING or greater than BUTTON_DOWN.

Definition at line 164 of file metacode.cpp.

MetaCode::DirectionalMotionState Mezzanine::MetaCode::GetMetaValueAsDirectionalMotionState ( ) const

Get the MetaValue as a MetaCode::

Returns:: This returns the appropriate MouseWheel state or throws an Mezzanine::Exception if an invalid state is stored in the MetaValue

Exceptions:

This	throws a Mezzanine::Exception if the MetaValue is less than MOUSEWHEEL_DOWN or greater than MOUSEWHEEL_UP.

Definition at line 174 of file metacode.cpp.

MetaCode::InputCode Mezzanine::MetaCode::GetMouseButtonCode ( short unsigned int ButtonNumber ) [static]

Accepts a int and returns the InputCode for the Corresponding Mouse button.

Parameters:

ButtonerNumber The number of the button you want the code for

Returns:: When passed 0 this returns MetaCode::MOUSEBUTTON, otherwise this returns MetaCode::MOUSEBUTTON_X where X is the number that was passed in

Definition at line 211 of file metacode.cpp.

bool Mezzanine::MetaCode::IsAltKey ( ) const

Is this a left or right Alt key.

Returns true if this MetaCode pertains to a either keyboard Alt key.

Returns:: This returns a bool which will be true if this is a left or right Alt key.

Definition at line 238 of file metacode.cpp.

bool Mezzanine::MetaCode::IsCtrlKey ( ) const

Is this a left or right Ctrl key.

Returns true if this MetaCode pertains to a either keyboard Ctrl key.

Returns:: This returns a bool which will be true if this is a left or right Ctrl key.

Definition at line 241 of file metacode.cpp.

bool Mezzanine::MetaCode::IsJoyStickEvent ( ) const

Does this MetaCode Represent a state of a Joystick Event.

Returns true if this MetaCode pertains to a joystick button being twisted, tilted, up, polled, down, pressed, or lifted, or whatever else you can do to a joystick.

Returns:: This returns a bool which will be true if this is between JOYSTICK_FIRST and JOYSTICK_LAST.

Definition at line 256 of file metacode.cpp.

bool Mezzanine::MetaCode::IsKeyboardButton ( ) const

Does this MetaCode Represent a state of a keyboard key.

Returns true if this MetaCode pertains to a keyboard key being up, polled, down, pressed, or lifted.

Returns:: This returns a bool which will be true if this is keyboard event.

Definition at line 235 of file metacode.cpp.

bool Mezzanine::MetaCode::IsMouseButton ( ) const

Does this MetaCode Represent a state of a Mouse button.

Returns true if this MetaCode pertains to a mouse button being up, polled, down, pressed, or lifted.

Returns:: This returns a bool which will be true if this is MOUSEBUTTON_X event.

Definition at line 250 of file metacode.cpp.

bool Mezzanine::MetaCode::IsOtherInputEvent ( ) const

Does this MetaCode Represent some other (non-keyboard and non-mouse button)

Returns true if this MetaCode pertains to any being up, polled, down, pressed, or lifted.

Returns:: This returns a bool which will be true if this is between INPUTEVENT_FIRST and INPUTEVENT_LAST.

Definition at line 259 of file metacode.cpp.

bool Mezzanine::MetaCode::IsPollable ( ) const

Is this metacode a pollable event.

Returns:: if this metacode stores a Keyboard button, Mouse Button or joystick button, then this is a pollable event

Definition at line 253 of file metacode.cpp.

bool Mezzanine::MetaCode::IsShiftKey ( ) const

Is this a left or right Shift key.

Returns true if this MetaCode pertains to a either keyboard Shift key.

Returns:: This returns a bool which will be true if this is a left or right Shift key.

Definition at line 244 of file metacode.cpp.

bool Mezzanine::MetaCode::IsSuperKey ( ) const

Is this a left or right Super key (Windows logo key, Apple logo key, etc...)

Returns true if this MetaCode pertains to a either keyboard Super key.

Returns:: This returns a bool which will be true if this is a left or right Super key.

Definition at line 247 of file metacode.cpp.

bool Mezzanine::MetaCode::operator== ( const MetaCode & other ) const

Compares two MetaCodes for equality.

This returns true if the MetaValue and Code are the Same, this ignores ID.

Definition at line 265 of file metacode.cpp.

void Mezzanine::MetaCode::ProtoDeSerialize ( const xml::Node & OneNode ) [virtual]

Take the data stored in an XML and overwrite this instance of this object with it.

Parameters:

OneNode and xml::Node containing the data.

Definition at line 300 of file metacode.cpp.

void Mezzanine::MetaCode::ProtoSerialize ( xml::Node & CurrentRoot ) const [virtual]

Convert this class to an xml::Node ready for serialization.

Parameters:

CurrentRoot The point in the XML hierarchy that all this vector3 should be appended to.

Definition at line 277 of file metacode.cpp.

String Mezzanine::MetaCode::SerializableName ( ) const

Get the name of the the XML tag this class will leave behind as its instances are serialized.

Returns:: A string containing "Vector3"

Definition at line 316 of file metacode.cpp.

void Mezzanine::MetaCode::SetCode ( int Code_ )

This Sets The InputCode using an int.

This will cast an int into an InputCode. Be careful, it is possible to put impossible or ridiculous values, in with this. For example Accidentally stuffing in the result of MOUSEBUTTON + 22 looks like it would give you MOUSEBUTTON_22. But that Doesn't exist, at the time of this writing you would get MOUSEABSOLUTEVERTICAL. Be careful, or skip this alltogether and use one of the provided functions that do the math for you like

Parameters:

Code_ The value you want the stored code to become.

Definition at line 206 of file metacode.cpp.

void Mezzanine::MetaCode::SetCode ( const MetaCode::InputCode & Code_ )

This Sets The InputCode.

See GetCode to see exactly what the Code is. This will Set the code stored in this MetaCode. This value can be retrieved with GetCode .

Parameters:

Code_ The value you want the stored code to become.

Definition at line 201 of file metacode.cpp.

void Mezzanine::MetaCode::SetMetaValue ( const int & MetaValue_ )

This Sets The MetaValue.

See GetMetaValue to see exactly what the MetaValue is. This will set the MetaValue stored in this MetaCode. This value can be retrieved with GetMetaValue .

Parameters:

MetaValue_ The value you want the stored MetaValue to become. No bounds checking will be done. You can supply a completely invalid value if you choose to.

Definition at line 196 of file metacode.cpp.

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

Mezzanine::MetaCode Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation