Orxonox: src/core/input/InputInterfaces.h File Reference

# InputInterfaces.h File Reference

Declarations of various interface classes for the input management. More...

`#include "core/CorePrereqs.h"`
`#include <ois/OISKeyboard.h>`
`#include <ois/OISMouse.h>`
`#include <ois/OISJoyStick.h>`
`#include "util/Math.h"`

## Namespaces

namespace | orxonox
namespace | orxonox::InputDevice
namespace | orxonox::JoyStickAxisCode
namespace | orxonox::JoyStickButtonCode
namespace | orxonox::KeyboardModifier
namespace | orxonox::KeyCode
namespace | orxonox::MouseAxisCode
namespace | orxonox::MouseButtonCode

## Classes

class | orxonox::EmptyHandler
class | orxonox::InputHandler
class | orxonox::JoyStickHandler
| Interface class used for joy stick input listeners. More...
struct | orxonox::Key
class | orxonox::KeyEvent
class | orxonox::KeyHandler
| Interface class used for key input listeners. More...
class | orxonox::MouseHandler
| Interface class used for mouse input listeners. More...

## Enumerations

enum

orxonox::JoyStickAxisCode::ByEnum {
orxonox::JoyStickAxisCode::Slider0 = 0, orxonox::JoyStickAxisCode::Slider1 = 1, orxonox::JoyStickAxisCode::Slider2 = 2, orxonox::JoyStickAxisCode::Slider3 = 3,
orxonox::JoyStickAxisCode::Slider4 = 4, orxonox::JoyStickAxisCode::Slider5 = 5, orxonox::JoyStickAxisCode::Slider6 = 6, orxonox::JoyStickAxisCode::Slider7 = 7,
orxonox::JoyStickAxisCode::Axis0 = 8, orxonox::JoyStickAxisCode::Axis1 = 9, orxonox::JoyStickAxisCode::Axis2 = 10, orxonox::JoyStickAxisCode::Axis3 = 11,
orxonox::JoyStickAxisCode::Axis4 = 12, orxonox::JoyStickAxisCode::Axis5 = 13, orxonox::JoyStickAxisCode::Axis6 = 14, orxonox::JoyStickAxisCode::Axis7 = 15,
orxonox::JoyStickAxisCode::Axis8 = 16, orxonox::JoyStickAxisCode::Axis9 = 17, orxonox::JoyStickAxisCode::Axis10 = 18, orxonox::JoyStickAxisCode::Axis11 = 19,
orxonox::JoyStickAxisCode::Axis12 = 20, orxonox::JoyStickAxisCode::Axis13 = 21, orxonox::JoyStickAxisCode::Axis14 = 22, orxonox::JoyStickAxisCode::Axis15 = 23
}

enum

orxonox::JoyStickButtonCode::ByEnum {
orxonox::JoyStickButtonCode::Button0 = 0, orxonox::JoyStickButtonCode::Button1 = 1, orxonox::JoyStickButtonCode::Button2 = 2, orxonox::JoyStickButtonCode::Button3 = 3,
orxonox::JoyStickButtonCode::Button4 = 4, orxonox::JoyStickButtonCode::Button5 = 5, orxonox::JoyStickButtonCode::Button6 = 6, orxonox::JoyStickButtonCode::Button7 = 7,
orxonox::JoyStickButtonCode::Button8 = 8, orxonox::JoyStickButtonCode::Button9 = 9, orxonox::JoyStickButtonCode::Button10 = 10, orxonox::JoyStickButtonCode::Button11 = 11,
orxonox::JoyStickButtonCode::Button12 = 12, orxonox::JoyStickButtonCode::Button13 = 13, orxonox::JoyStickButtonCode::Button14 = 14, orxonox::JoyStickButtonCode::Button15 = 15,
orxonox::JoyStickButtonCode::Button16 = 16, orxonox::JoyStickButtonCode::Button17 = 17, orxonox::JoyStickButtonCode::Button18 = 18, orxonox::JoyStickButtonCode::Button19 = 19,
orxonox::JoyStickButtonCode::Button20 = 20, orxonox::JoyStickButtonCode::Button21 = 21, orxonox::JoyStickButtonCode::Button22 = 22, orxonox::JoyStickButtonCode::Button23 = 23,
orxonox::JoyStickButtonCode::Button24 = 24, orxonox::JoyStickButtonCode::Button25 = 25, orxonox::JoyStickButtonCode::Button26 = 26, orxonox::JoyStickButtonCode::Button27 = 27,
orxonox::JoyStickButtonCode::Button28 = 28, orxonox::JoyStickButtonCode::Button29 = 29, orxonox::JoyStickButtonCode::Button30 = 30, orxonox::JoyStickButtonCode::Button31 = 31,
orxonox::JoyStickButtonCode::POV0North = 32, orxonox::JoyStickButtonCode::POV0South = 33, orxonox::JoyStickButtonCode::POV0East = 34, orxonox::JoyStickButtonCode::POV0West = 35,
orxonox::JoyStickButtonCode::POV0NorthEast = 36, orxonox::JoyStickButtonCode::POV0SouthEast = 37, orxonox::JoyStickButtonCode::POV0NorthWest = 38, orxonox::JoyStickButtonCode::POV0SouthWest = 39,
orxonox::JoyStickButtonCode::POV1North = 40, orxonox::JoyStickButtonCode::POV1South = 41, orxonox::JoyStickButtonCode::POV1East = 42, orxonox::JoyStickButtonCode::POV1West = 43,
orxonox::JoyStickButtonCode::POV1NorthEast = 44, orxonox::JoyStickButtonCode::POV1SouthEast = 45, orxonox::JoyStickButtonCode::POV1NorthWest = 46, orxonox::JoyStickButtonCode::POV1SouthWest = 47,
orxonox::JoyStickButtonCode::POV2North = 48, orxonox::JoyStickButtonCode::POV2South = 49, orxonox::JoyStickButtonCode::POV2East = 50, orxonox::JoyStickButtonCode::POV2West = 51,
orxonox::JoyStickButtonCode::POV2NorthEast = 52, orxonox::JoyStickButtonCode::POV2SouthEast = 53, orxonox::JoyStickButtonCode::POV2NorthWest = 54, orxonox::JoyStickButtonCode::POV2SouthWest = 55,
orxonox::JoyStickButtonCode::POV3North = 56, orxonox::JoyStickButtonCode::POV3South = 57, orxonox::JoyStickButtonCode::POV3East = 58, orxonox::JoyStickButtonCode::POV3West = 59,
orxonox::JoyStickButtonCode::POV3NorthEast = 60, orxonox::JoyStickButtonCode::POV3SouthEast = 61, orxonox::JoyStickButtonCode::POV3NorthWest = 62, orxonox::JoyStickButtonCode::POV3SouthWest = 63
}

enum | orxonox::MouseAxisCode::ByEnum { orxonox::MouseAxisCode::X, orxonox::MouseAxisCode::Y }

enum

orxonox::MouseButtonCode::ByEnum {
orxonox::MouseButtonCode::Left = OIS::MB_Left, orxonox::MouseButtonCode::Right = OIS::MB_Right, orxonox::MouseButtonCode::Middle = OIS::MB_Middle, orxonox::MouseButtonCode::Button3 = OIS::MB_Button3,
orxonox::MouseButtonCode::Button4 = OIS::MB_Button4, orxonox::MouseButtonCode::Button5 = OIS::MB_Button5, orxonox::MouseButtonCode::Button6 = OIS::MB_Button6, orxonox::MouseButtonCode::Button7 = OIS::MB_Button7
}

enum

orxonox::KeyCode::ByEnum {
orxonox::KeyCode::Unassigned = OIS::KC_UNASSIGNED, orxonox::KeyCode::Escape = OIS::KC_ESCAPE, orxonox::KeyCode::NumRow1 = OIS::KC_1, orxonox::KeyCode::NumRow2 = OIS::KC_2,
orxonox::KeyCode::NumRow3 = OIS::KC_3, orxonox::KeyCode::NumRow4 = OIS::KC_4, orxonox::KeyCode::NumRow5 = OIS::KC_5, orxonox::KeyCode::NumRow6 = OIS::KC_6,
orxonox::KeyCode::NumRow7 = OIS::KC_7, orxonox::KeyCode::NumRow8 = OIS::KC_8, orxonox::KeyCode::NumRow9 = OIS::KC_9, orxonox::KeyCode::NumRow0 = OIS::KC_0,
orxonox::KeyCode::Minus = OIS::KC_MINUS, orxonox::KeyCode::Equals = OIS::KC_EQUALS, orxonox::KeyCode::Back = OIS::KC_BACK, orxonox::KeyCode::Tab = OIS::KC_TAB,
orxonox::KeyCode::Q = OIS::KC_Q, orxonox::KeyCode::W = OIS::KC_W, orxonox::KeyCode::E = OIS::KC_E, orxonox::KeyCode::R = OIS::KC_R,
orxonox::KeyCode::T = OIS::KC_T, orxonox::KeyCode::Y = OIS::KC_Y, orxonox::KeyCode::U = OIS::KC_U, orxonox::KeyCode::I = OIS::KC_I,
orxonox::KeyCode::O = OIS::KC_O, orxonox::KeyCode::P = OIS::KC_P, orxonox::KeyCode::LeftBracket = OIS::KC_LBRACKET, orxonox::KeyCode::RightBracket = OIS::KC_RBRACKET,
orxonox::KeyCode::Return = OIS::KC_RETURN, orxonox::KeyCode::LeftControl = OIS::KC_LCONTROL, orxonox::KeyCode::A = OIS::KC_A, orxonox::KeyCode::S = OIS::KC_S,
orxonox::KeyCode::D = OIS::KC_D, orxonox::KeyCode::F = OIS::KC_F, orxonox::KeyCode::G = OIS::KC_G, orxonox::KeyCode::H = OIS::KC_H,
orxonox::KeyCode::J = OIS::KC_J, orxonox::KeyCode::K = OIS::KC_K, orxonox::KeyCode::L = OIS::KC_L, orxonox::KeyCode::Semicolon = OIS::KC_SEMICOLON,
orxonox::KeyCode::Apostrophe = OIS::KC_APOSTROPHE, orxonox::KeyCode::Grave = OIS::KC_GRAVE, orxonox::KeyCode::LeftShift = OIS::KC_LSHIFT, orxonox::KeyCode::Backslash = OIS::KC_BACKSLASH,
orxonox::KeyCode::Z = OIS::KC_Z, orxonox::KeyCode::X = OIS::KC_X, orxonox::KeyCode::C = OIS::KC_C, orxonox::KeyCode::V = OIS::KC_V,
orxonox::KeyCode::B = OIS::KC_B, orxonox::KeyCode::N = OIS::KC_N, orxonox::KeyCode::M = OIS::KC_M, orxonox::KeyCode::Comma = OIS::KC_COMMA,
orxonox::KeyCode::Period = OIS::KC_PERIOD, orxonox::KeyCode::Slash = OIS::KC_SLASH, orxonox::KeyCode::RightShift = OIS::KC_RSHIFT, orxonox::KeyCode::Multiply = OIS::KC_MULTIPLY,
orxonox::KeyCode::LeftAlt = OIS::KC_LMENU, orxonox::KeyCode::Space = OIS::KC_SPACE, orxonox::KeyCode::CapsLock = OIS::KC_CAPITAL, orxonox::KeyCode::F1 = OIS::KC_F1,
orxonox::KeyCode::F2 = OIS::KC_F2, orxonox::KeyCode::F3 = OIS::KC_F3, orxonox::KeyCode::F4 = OIS::KC_F4, orxonox::KeyCode::F5 = OIS::KC_F5,
orxonox::KeyCode::F6 = OIS::KC_F6, orxonox::KeyCode::F7 = OIS::KC_F7, orxonox::KeyCode::F8 = OIS::KC_F8, orxonox::KeyCode::F9 = OIS::KC_F9,
orxonox::KeyCode::F10 = OIS::KC_F10, orxonox::KeyCode::NumLock = OIS::KC_NUMLOCK, orxonox::KeyCode::ScrollLock = OIS::KC_SCROLL, orxonox::KeyCode::Numpad7 = OIS::KC_NUMPAD7,
orxonox::KeyCode::Numpad8 = OIS::KC_NUMPAD8, orxonox::KeyCode::Numpad9 = OIS::KC_NUMPAD9, orxonox::KeyCode::NumpadSubtract = OIS::KC_SUBTRACT, orxonox::KeyCode::Numpad4 = OIS::KC_NUMPAD4,
orxonox::KeyCode::Numpad5 = OIS::KC_NUMPAD5, orxonox::KeyCode::Numpad6 = OIS::KC_NUMPAD6, orxonox::KeyCode::NumpadAdd = OIS::KC_ADD, orxonox::KeyCode::Numpad1 = OIS::KC_NUMPAD1,
orxonox::KeyCode::Numpad2 = OIS::KC_NUMPAD2, orxonox::KeyCode::Numpad3 = OIS::KC_NUMPAD3, orxonox::KeyCode::Numpad0 = OIS::KC_NUMPAD0, orxonox::KeyCode::NumpadPeriod = OIS::KC_DECIMAL,
orxonox::KeyCode::LessThan = OIS::KC_OEM_102, orxonox::KeyCode::F11 = OIS::KC_F11, orxonox::KeyCode::F12 = OIS::KC_F12, orxonox::KeyCode::F13 = OIS::KC_F13,
orxonox::KeyCode::F14 = OIS::KC_F14, orxonox::KeyCode::F15 = OIS::KC_F15, orxonox::KeyCode::Kana = OIS::KC_KANA, orxonox::KeyCode::ABNT_C1 = OIS::KC_ABNT_C1,
orxonox::KeyCode::Convert = OIS::KC_CONVERT, orxonox::KeyCode::NoConvert = OIS::KC_NOCONVERT, orxonox::KeyCode::Yen = OIS::KC_YEN, orxonox::KeyCode::ABNT_C2 = OIS::KC_ABNT_C2,
orxonox::KeyCode::NumpadEquals = OIS::KC_NUMPADEQUALS, orxonox::KeyCode::PreviousTrack = OIS::KC_PREVTRACK, orxonox::KeyCode::AT = OIS::KC_AT, orxonox::KeyCode::Colon = OIS::KC_COLON,
orxonox::KeyCode::Underline = OIS::KC_UNDERLINE, orxonox::KeyCode::Kanji = OIS::KC_KANJI, orxonox::KeyCode::Stop = OIS::KC_STOP, orxonox::KeyCode::AX = OIS::KC_AX,
orxonox::KeyCode::Unlabeled = OIS::KC_UNLABELED, orxonox::KeyCode::NextTrack = OIS::KC_NEXTTRACK, orxonox::KeyCode::NumpadEnter = OIS::KC_NUMPADENTER, orxonox::KeyCode::RightControl = OIS::KC_RCONTROL,
orxonox::KeyCode::Mute = OIS::KC_MUTE, orxonox::KeyCode::Calculator = OIS::KC_CALCULATOR, orxonox::KeyCode::PlayPause = OIS::KC_PLAYPAUSE, orxonox::KeyCode::MediaStop = OIS::KC_MEDIASTOP,
orxonox::KeyCode::VolumeDown = OIS::KC_VOLUMEDOWN, orxonox::KeyCode::VolumeUp = OIS::KC_VOLUMEUP, orxonox::KeyCode::WebHome = OIS::KC_WEBHOME, orxonox::KeyCode::NumpadComma = OIS::KC_NUMPADCOMMA,
orxonox::KeyCode::Divide = OIS::KC_DIVIDE, orxonox::KeyCode::SystemRequest = OIS::KC_SYSRQ, orxonox::KeyCode::RightAlt = OIS::KC_RMENU, orxonox::KeyCode::Pause = OIS::KC_PAUSE,
orxonox::KeyCode::Home = OIS::KC_HOME, orxonox::KeyCode::Up = OIS::KC_UP, orxonox::KeyCode::PageUp = OIS::KC_PGUP, orxonox::KeyCode::Left = OIS::KC_LEFT,
orxonox::KeyCode::Right = OIS::KC_RIGHT, orxonox::KeyCode::End = OIS::KC_END, orxonox::KeyCode::Down = OIS::KC_DOWN, orxonox::KeyCode::PageDown = OIS::KC_PGDOWN,
orxonox::KeyCode::Insert = OIS::KC_INSERT, orxonox::KeyCode::Delete = OIS::KC_DELETE, orxonox::KeyCode::LeftWindows = OIS::KC_LWIN, orxonox::KeyCode::RightWindows = OIS::KC_RWIN,
orxonox::KeyCode::Apps = OIS::KC_APPS, orxonox::KeyCode::Power = OIS::KC_POWER, orxonox::KeyCode::Sleep = OIS::KC_SLEEP, orxonox::KeyCode::Wake = OIS::KC_WAKE,
orxonox::KeyCode::WebSearch = OIS::KC_WEBSEARCH, orxonox::KeyCode::WebFavorites = OIS::KC_WEBFAVORITES, orxonox::KeyCode::WebRefresh = OIS::KC_WEBREFRESH, orxonox::KeyCode::WebStop = OIS::KC_WEBSTOP,
orxonox::KeyCode::WebForward = OIS::KC_WEBFORWARD, orxonox::KeyCode::WebBack = OIS::KC_WEBBACK, orxonox::KeyCode::MyComputer = OIS::KC_MYCOMPUTER, orxonox::KeyCode::Mail = OIS::KC_MAIL,
orxonox::KeyCode::MediaSelect = OIS::KC_MEDIASELECT
}

enum | orxonox::InputDevice::Enum { orxonox::InputDevice::Keyboard, orxonox::InputDevice::Mouse, orxonox::InputDevice::JoyStick0, orxonox::InputDevice::JoyStick1, orxonox::InputDevice::JoyStick2, orxonox::InputDevice::JoyStick3 }
enum | orxonox::KeyboardModifier::Enum { orxonox::KeyboardModifier::Shift = 0x0000001, orxonox::KeyboardModifier::Ctrl = 0x0000010, orxonox::KeyboardModifier::Alt = 0x0000100 }

## Variables

const char *const | orxonox::JoyStickAxisCode::ByString []
const char *const | orxonox::JoyStickButtonCode::ByString []
const char *const | orxonox::MouseAxisCode::ByString []
const char *const | orxonox::MouseButtonCode::ByString []
const char *const | orxonox::KeyCode::ByString []
const unsigned int | orxonox::JoyStickAxisCode::numberOfAxes = 24
const unsigned int | orxonox::MouseAxisCode::numberOfAxes = 2
const unsigned int | orxonox::JoyStickButtonCode::numberOfButtons = 64
const unsigned int | orxonox::MouseButtonCode::numberOfButtons = 8
const unsigned int | orxonox::KeyCode::numberOfKeys = 0xEE

## Detailed Description

Declarations of various interface classes for the input management.