Moved platform input event files under new input directory

This commit is contained in:
DavidWyand-GG 2013-01-23 02:37:37 -05:00
parent 2112878f30
commit 32a3bab2f7
8 changed files with 7 additions and 6 deletions

View file

@ -0,0 +1,59 @@
//-----------------------------------------------------------------------------
// Copyright (c) 2012 GarageGames, LLC
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.
//-----------------------------------------------------------------------------
#ifndef _IINPUTDEVICE_H_
#define _IINPUTDEVICE_H_
#include "console/consoleTypes.h"
class IInputDevice
{
protected:
/// Device name
char mName[30];
/// Device type
U32 mDeviceType;
/// Is the device enabled
bool mEnabled;
public:
inline const char* getDeviceName() const
{
return mName;
}
inline U32 getDeviceType() const
{
return mDeviceType;
}
inline bool isEnabled()
{
return mEnabled;
}
virtual bool process() = 0;
};
#endif

View file

@ -0,0 +1,548 @@
//-----------------------------------------------------------------------------
// Copyright (c) 2012 GarageGames, LLC
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.
//-----------------------------------------------------------------------------
#include "platform/input/event.h"
#include "core/module.h"
#include "core/util/journal/process.h"
#include "core/strings/stringFunctions.h"
#include "core/stringTable.h"
#include "platform/platformInput.h"
#include "math/mQuat.h"
MODULE_BEGIN( InputEventManager )
MODULE_INIT_BEFORE( SIM )
MODULE_SHUTDOWN_AFTER( SIM )
MODULE_INIT
{
ManagedSingleton< InputEventManager >::createSingleton();
}
MODULE_SHUTDOWN
{
ManagedSingleton< InputEventManager >::deleteSingleton();
}
MODULE_END;
InputEventManager::InputEventManager()
{
mNextDeviceTypeCode = INPUT_DEVICE_PLUGIN_DEVICES_START;
mNextDeviceCode = INPUT_DEVICE_PLUGIN_CODES_START;
buildVirtualMap();
}
InputEventManager::~InputEventManager()
{
}
U32 InputEventManager::getNextDeviceType()
{
U32 code = mNextDeviceTypeCode;
++mNextDeviceTypeCode;
return code;
}
U32 InputEventManager::getNextDeviceCode()
{
U32 code = mNextDeviceCode;
++mNextDeviceCode;
return code;
}
void InputEventManager::registerDevice(IInputDevice* device)
{
// Make sure the device is not already registered
for(U32 i=0; i<mDeviceList.size(); ++i)
{
if(mDeviceList[i] == device)
return;
}
// Add the new device to the list
mDeviceList.push_back(device);
}
void InputEventManager::unregisterDevice(IInputDevice* device)
{
// Remove the device from the list
for(U32 i=0; i<mDeviceList.size(); ++i)
{
if(mDeviceList[i] == device)
{
mDeviceList.erase(i);
return;
}
}
}
bool InputEventManager::isRegisteredDevice(const char* name)
{
for(Vector<IInputDevice*>::iterator itr = mDeviceList.begin(); itr != mDeviceList.end(); ++itr)
{
if((*itr)->isEnabled())
{
const char* deviceName = (*itr)->getDeviceName();
if(dStrnicmp(name, deviceName, dStrlen(deviceName)) == 0)
{
return true;
}
}
}
return false;
}
bool InputEventManager::isRegisteredDevice(U32 type)
{
for(Vector<IInputDevice*>::iterator itr = mDeviceList.begin(); itr != mDeviceList.end(); ++itr)
{
if((*itr)->isEnabled())
{
U32 deviceType = (*itr)->getDeviceType();
if(deviceType == type)
{
return true;
}
}
}
return false;
}
bool InputEventManager::isRegisteredDeviceWithAttributes(const char* name, U32& deviceType, U32&nameLen)
{
for(Vector<IInputDevice*>::iterator itr = mDeviceList.begin(); itr != mDeviceList.end(); ++itr)
{
if((*itr)->isEnabled())
{
const char* deviceName = (*itr)->getDeviceName();
S32 length = dStrlen(deviceName);
if(dStrnicmp(name, deviceName, length) == 0)
{
deviceType = (*itr)->getDeviceType();
nameLen = length;
return true;
}
}
}
return false;
}
const char* InputEventManager::getRegisteredDeviceName(U32 type)
{
for(Vector<IInputDevice*>::iterator itr = mDeviceList.begin(); itr != mDeviceList.end(); ++itr)
{
if((*itr)->isEnabled())
{
U32 deviceType = (*itr)->getDeviceType();
if(deviceType == type)
{
return (*itr)->getDeviceName();
}
}
}
return NULL;
}
void InputEventManager::start()
{
Process::notify(this, &InputEventManager::process, PROCESS_INPUT_ORDER);
}
void InputEventManager::stop()
{
Process::remove(this, &InputEventManager::process);
}
void InputEventManager::process()
{
// Process each device
for(Vector<IInputDevice*>::iterator itr = mDeviceList.begin(); itr != mDeviceList.end(); ++itr)
{
if((*itr)->isEnabled())
{
(*itr)->process();
}
}
}
// Used for the old virtual map table that was originally in actionMap.cpp
struct CodeMapping
{
const char* pDescription;
InputEventType type;
InputObjectInstances code;
};
CodeMapping gVirtualMap[] =
{
//-------------------------------------- KEYBOARD EVENTS
//
{ "backspace", SI_KEY, KEY_BACKSPACE },
{ "tab", SI_KEY, KEY_TAB },
{ "return", SI_KEY, KEY_RETURN },
{ "enter", SI_KEY, KEY_RETURN },
{ "shift", SI_KEY, KEY_SHIFT },
{ "ctrl", SI_KEY, KEY_CONTROL },
{ "alt", SI_KEY, KEY_ALT },
{ "pause", SI_KEY, KEY_PAUSE },
{ "capslock", SI_KEY, KEY_CAPSLOCK },
{ "escape", SI_KEY, KEY_ESCAPE },
{ "space", SI_KEY, KEY_SPACE },
{ "pagedown", SI_KEY, KEY_PAGE_DOWN },
{ "pageup", SI_KEY, KEY_PAGE_UP },
{ "end", SI_KEY, KEY_END },
{ "home", SI_KEY, KEY_HOME },
{ "left", SI_KEY, KEY_LEFT },
{ "up", SI_KEY, KEY_UP },
{ "right", SI_KEY, KEY_RIGHT },
{ "down", SI_KEY, KEY_DOWN },
{ "print", SI_KEY, KEY_PRINT },
{ "insert", SI_KEY, KEY_INSERT },
{ "delete", SI_KEY, KEY_DELETE },
{ "help", SI_KEY, KEY_HELP },
{ "win_lwindow", SI_KEY, KEY_WIN_LWINDOW },
{ "win_rwindow", SI_KEY, KEY_WIN_RWINDOW },
{ "win_apps", SI_KEY, KEY_WIN_APPS },
{ "cmd", SI_KEY, KEY_ALT },
{ "opt", SI_KEY, KEY_MAC_OPT },
{ "lopt", SI_KEY, KEY_MAC_LOPT },
{ "ropt", SI_KEY, KEY_MAC_ROPT },
{ "numpad0", SI_KEY, KEY_NUMPAD0 },
{ "numpad1", SI_KEY, KEY_NUMPAD1 },
{ "numpad2", SI_KEY, KEY_NUMPAD2 },
{ "numpad3", SI_KEY, KEY_NUMPAD3 },
{ "numpad4", SI_KEY, KEY_NUMPAD4 },
{ "numpad5", SI_KEY, KEY_NUMPAD5 },
{ "numpad6", SI_KEY, KEY_NUMPAD6 },
{ "numpad7", SI_KEY, KEY_NUMPAD7 },
{ "numpad8", SI_KEY, KEY_NUMPAD8 },
{ "numpad9", SI_KEY, KEY_NUMPAD9 },
{ "numpadmult", SI_KEY, KEY_MULTIPLY },
{ "numpadadd", SI_KEY, KEY_ADD },
{ "numpadsep", SI_KEY, KEY_SEPARATOR },
{ "numpadminus", SI_KEY, KEY_SUBTRACT },
{ "numpaddecimal", SI_KEY, KEY_DECIMAL },
{ "numpaddivide", SI_KEY, KEY_DIVIDE },
{ "numpadenter", SI_KEY, KEY_NUMPADENTER },
{ "f1", SI_KEY, KEY_F1 },
{ "f2", SI_KEY, KEY_F2 },
{ "f3", SI_KEY, KEY_F3 },
{ "f4", SI_KEY, KEY_F4 },
{ "f5", SI_KEY, KEY_F5 },
{ "f6", SI_KEY, KEY_F6 },
{ "f7", SI_KEY, KEY_F7 },
{ "f8", SI_KEY, KEY_F8 },
{ "f9", SI_KEY, KEY_F9 },
{ "f10", SI_KEY, KEY_F10 },
{ "f11", SI_KEY, KEY_F11 },
{ "f12", SI_KEY, KEY_F12 },
{ "f13", SI_KEY, KEY_F13 },
{ "f14", SI_KEY, KEY_F14 },
{ "f15", SI_KEY, KEY_F15 },
{ "f16", SI_KEY, KEY_F16 },
{ "f17", SI_KEY, KEY_F17 },
{ "f18", SI_KEY, KEY_F18 },
{ "f19", SI_KEY, KEY_F19 },
{ "f20", SI_KEY, KEY_F20 },
{ "f21", SI_KEY, KEY_F21 },
{ "f22", SI_KEY, KEY_F22 },
{ "f23", SI_KEY, KEY_F23 },
{ "f24", SI_KEY, KEY_F24 },
{ "numlock", SI_KEY, KEY_NUMLOCK },
{ "scrolllock", SI_KEY, KEY_SCROLLLOCK },
{ "lshift", SI_KEY, KEY_LSHIFT },
{ "rshift", SI_KEY, KEY_RSHIFT },
{ "lcontrol", SI_KEY, KEY_LCONTROL },
{ "rcontrol", SI_KEY, KEY_RCONTROL },
{ "lalt", SI_KEY, KEY_LALT },
{ "ralt", SI_KEY, KEY_RALT },
{ "tilde", SI_KEY, KEY_TILDE },
{ "minus", SI_KEY, KEY_MINUS },
{ "equals", SI_KEY, KEY_EQUALS },
{ "lbracket", SI_KEY, KEY_LBRACKET },
{ "rbracket", SI_KEY, KEY_RBRACKET },
{ "backslash", SI_KEY, KEY_BACKSLASH },
{ "semicolon", SI_KEY, KEY_SEMICOLON },
{ "apostrophe", SI_KEY, KEY_APOSTROPHE },
{ "comma", SI_KEY, KEY_COMMA },
{ "period", SI_KEY, KEY_PERIOD },
{ "slash", SI_KEY, KEY_SLASH },
{ "lessthan", SI_KEY, KEY_OEM_102 },
//-------------------------------------- BUTTON EVENTS
// Joystick/Mouse buttons
{ "button0", SI_BUTTON, KEY_BUTTON0 },
{ "button1", SI_BUTTON, KEY_BUTTON1 },
{ "button2", SI_BUTTON, KEY_BUTTON2 },
{ "button3", SI_BUTTON, KEY_BUTTON3 },
{ "button4", SI_BUTTON, KEY_BUTTON4 },
{ "button5", SI_BUTTON, KEY_BUTTON5 },
{ "button6", SI_BUTTON, KEY_BUTTON6 },
{ "button7", SI_BUTTON, KEY_BUTTON7 },
{ "button8", SI_BUTTON, KEY_BUTTON8 },
{ "button9", SI_BUTTON, KEY_BUTTON9 },
{ "button10", SI_BUTTON, KEY_BUTTON10 },
{ "button11", SI_BUTTON, KEY_BUTTON11 },
{ "button12", SI_BUTTON, KEY_BUTTON12 },
{ "button13", SI_BUTTON, KEY_BUTTON13 },
{ "button14", SI_BUTTON, KEY_BUTTON14 },
{ "button15", SI_BUTTON, KEY_BUTTON15 },
{ "button16", SI_BUTTON, KEY_BUTTON16 },
{ "button17", SI_BUTTON, KEY_BUTTON17 },
{ "button18", SI_BUTTON, KEY_BUTTON18 },
{ "button19", SI_BUTTON, KEY_BUTTON19 },
{ "button20", SI_BUTTON, KEY_BUTTON20 },
{ "button21", SI_BUTTON, KEY_BUTTON21 },
{ "button22", SI_BUTTON, KEY_BUTTON22 },
{ "button23", SI_BUTTON, KEY_BUTTON23 },
{ "button24", SI_BUTTON, KEY_BUTTON24 },
{ "button25", SI_BUTTON, KEY_BUTTON25 },
{ "button26", SI_BUTTON, KEY_BUTTON26 },
{ "button27", SI_BUTTON, KEY_BUTTON27 },
{ "button28", SI_BUTTON, KEY_BUTTON28 },
{ "button29", SI_BUTTON, KEY_BUTTON29 },
{ "button30", SI_BUTTON, KEY_BUTTON30 },
{ "button31", SI_BUTTON, KEY_BUTTON31 },
{ "button32", SI_BUTTON, KEY_BUTTON32 },
{ "button33", SI_BUTTON, KEY_BUTTON33 },
{ "button34", SI_BUTTON, KEY_BUTTON34 },
{ "button35", SI_BUTTON, KEY_BUTTON35 },
{ "button36", SI_BUTTON, KEY_BUTTON36 },
{ "button37", SI_BUTTON, KEY_BUTTON37 },
{ "button38", SI_BUTTON, KEY_BUTTON38 },
{ "button39", SI_BUTTON, KEY_BUTTON39 },
{ "button40", SI_BUTTON, KEY_BUTTON40 },
{ "button41", SI_BUTTON, KEY_BUTTON41 },
{ "button42", SI_BUTTON, KEY_BUTTON42 },
{ "button43", SI_BUTTON, KEY_BUTTON43 },
{ "button44", SI_BUTTON, KEY_BUTTON44 },
{ "button45", SI_BUTTON, KEY_BUTTON45 },
{ "button46", SI_BUTTON, KEY_BUTTON46 },
{ "button47", SI_BUTTON, KEY_BUTTON47 },
//-------------------------------------- MOVE EVENTS
// Mouse/Joystick axes:
{ "xaxis", SI_AXIS, SI_XAXIS },
{ "yaxis", SI_AXIS, SI_YAXIS },
{ "zaxis", SI_AXIS, SI_ZAXIS },
{ "rxaxis", SI_AXIS, SI_RXAXIS },
{ "ryaxis", SI_AXIS, SI_RYAXIS },
{ "rzaxis", SI_AXIS, SI_RZAXIS },
{ "slider", SI_AXIS, SI_SLIDER },
//-------------------------------------- POV EVENTS
// Joystick POV:
{ "xpov", SI_POV, SI_XPOV },
{ "ypov", SI_POV, SI_YPOV },
{ "upov", SI_POV, SI_UPOV },
{ "dpov", SI_POV, SI_DPOV },
{ "lpov", SI_POV, SI_LPOV },
{ "rpov", SI_POV, SI_RPOV },
{ "xpov2", SI_POV, SI_XPOV2 },
{ "ypov2", SI_POV, SI_YPOV2 },
{ "upov2", SI_POV, SI_UPOV2 },
{ "dpov2", SI_POV, SI_DPOV2 },
{ "lpov2", SI_POV, SI_LPOV2 },
{ "rpov2", SI_POV, SI_RPOV2 },
#if defined( TORQUE_OS_WIN32 ) || defined( TORQUE_OS_XENON )
//-------------------------------------- XINPUT EVENTS
// Controller connect / disconnect:
{ "connect", SI_BUTTON, XI_CONNECT },
// L & R Thumbsticks:
{ "thumblx", SI_AXIS, XI_THUMBLX },
{ "thumbly", SI_AXIS, XI_THUMBLY },
{ "thumbrx", SI_AXIS, XI_THUMBRX },
{ "thumbry", SI_AXIS, XI_THUMBRY },
// L & R Triggers:
{ "triggerl", SI_AXIS, XI_LEFT_TRIGGER },
{ "triggerr", SI_AXIS, XI_RIGHT_TRIGGER },
// DPAD Buttons:
{ "dpadu", SI_BUTTON, SI_UPOV },
{ "dpadd", SI_BUTTON, SI_DPOV },
{ "dpadl", SI_BUTTON, SI_LPOV },
{ "dpadr", SI_BUTTON, SI_RPOV },
// START & BACK Buttons:
{ "btn_start", SI_BUTTON, XI_START },
{ "btn_back", SI_BUTTON, XI_BACK },
// L & R Thumbstick Buttons:
{ "btn_lt", SI_BUTTON, XI_LEFT_THUMB },
{ "btn_rt", SI_BUTTON, XI_RIGHT_THUMB },
// L & R Shoulder Buttons:
{ "btn_l", SI_BUTTON, XI_LEFT_SHOULDER },
{ "btn_r", SI_BUTTON, XI_RIGHT_SHOULDER },
// Primary buttons:
{ "btn_a", SI_BUTTON, XI_A },
{ "btn_b", SI_BUTTON, XI_B },
{ "btn_x", SI_BUTTON, XI_X },
{ "btn_y", SI_BUTTON, XI_Y },
#endif
//-------------------------------------- MISCELLANEOUS EVENTS
//
{ "anykey", SI_KEY, KEY_ANYKEY },
{ "nomatch", SI_UNKNOWN, (InputObjectInstances)0xFFFFFFFF }
};
void InputEventManager::buildVirtualMap()
{
char desc[256];
VirtualMapData* data;
for (U32 j = 0; gVirtualMap[j].code != 0xFFFFFFFF; j++)
{
// Make sure the description is lower case
desc[0] = 0;
dStrncpy(desc, gVirtualMap[j].pDescription, 255);
dStrlwr(desc);
data = new VirtualMapData();
data->type = gVirtualMap[j].type;
data->code = gVirtualMap[j].code;
data->desc = StringTable->insert(desc);
mVirtualMap.insert(data, desc);
mActionCodeMap.insertUnique(data->code, *data);
}
}
void InputEventManager::addVirtualMap(const char* description, InputEventType type, InputObjectInstances code)
{
// Make sure the description is lower case
char desc[256];
desc[0] = 0;
dStrncpy(desc, description, 255);
dStrlwr(desc);
VirtualMapData* data = new VirtualMapData();
data->type = type;
data->code = code;
data->desc = StringTable->insert(desc);
mVirtualMap.insert(data, desc);
mActionCodeMap.insertUnique(data->code, *data);
}
InputEventManager::VirtualMapData* InputEventManager::findVirtualMap(const char* description)
{
char desc[256];
desc[0] = 0;
dStrncpy(desc, description, 255);
dStrlwr(desc);
return mVirtualMap.retreive(desc);
}
const char* InputEventManager::findVirtualMapDescFromCode(U32 code)
{
HashTable<U32, VirtualMapData>::Iterator itr = mActionCodeMap.find(code);
if(itr != mActionCodeMap.end())
return itr->value.desc;
return NULL;
}
void InputEventManager::buildInputEvent(U32 deviceType, U32 deviceInst, InputEventType objType, InputObjectInstances objInst, InputActionType action, S32 iValue)
{
InputEventInfo newEvent;
newEvent.deviceType = deviceType;
newEvent.deviceInst = deviceInst;
newEvent.objType = objType;
newEvent.objInst = objInst;
newEvent.action = action;
newEvent.iValue = iValue;
newEvent.postToSignal(Input::smInputEvent);
}
void InputEventManager::buildInputEvent(U32 deviceType, U32 deviceInst, InputEventType objType, InputObjectInstances objInst, InputActionType action, float fValue)
{
InputEventInfo newEvent;
newEvent.deviceType = deviceType;
newEvent.deviceInst = deviceInst;
newEvent.objType = objType;
newEvent.objInst = objInst;
newEvent.action = action;
newEvent.fValue = fValue;
newEvent.postToSignal(Input::smInputEvent);
}
void InputEventManager::buildInputEvent(U32 deviceType, U32 deviceInst, InputEventType objType, InputObjectInstances objInst, InputActionType action, Point3F& pValue)
{
InputEventInfo newEvent;
newEvent.deviceType = deviceType;
newEvent.deviceInst = deviceInst;
newEvent.objType = objType;
newEvent.objInst = objInst;
newEvent.action = action;
newEvent.fValue = pValue.x;
newEvent.fValue2 = pValue.y;
newEvent.fValue3 = pValue.z;
newEvent.postToSignal(Input::smInputEvent);
}
void InputEventManager::buildInputEvent(U32 deviceType, U32 deviceInst, InputEventType objType, InputObjectInstances objInst, InputActionType action, QuatF& qValue)
{
InputEventInfo newEvent;
newEvent.deviceType = deviceType;
newEvent.deviceInst = deviceInst;
newEvent.objType = objType;
newEvent.objInst = objInst;
newEvent.action = action;
newEvent.fValue = qValue.x;
newEvent.fValue2 = qValue.y;
newEvent.fValue3 = qValue.z;
newEvent.fValue4 = qValue.w;
newEvent.postToSignal(Input::smInputEvent);
}

View file

@ -0,0 +1,531 @@
//-----------------------------------------------------------------------------
// Copyright (c) 2012 GarageGames, LLC
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.
//-----------------------------------------------------------------------------
/// @file
/// Library-wide input events
///
/// All external events are converted into system events, which are defined
/// in this file.
///
#ifndef _EVENT_H_
#define _EVENT_H_
#include "platform/types.h"
#include "platform/input/IInputDevice.h"
#include "core/util/journal/journaledSignal.h"
#include "core/util/tSingleton.h"
#include "core/util/tDictionary.h"
#include "core/tSimpleHashTable.h"
#define AddInputVirtualMap( description, type, code ) \
INPUTMGR->addVirtualMap( #description, type, code );
/// @defgroup input_constants Input system constants
/// @{
/// Input event constants:
typedef U32 InputObjectInstances;
enum InputObjectInstancesEnum
{
KEY_NULL = 0x000, ///< Invalid KeyCode
KEY_BACKSPACE = 0x001,
KEY_TAB = 0x002,
KEY_RETURN = 0x003,
KEY_CONTROL = 0x004,
KEY_ALT = 0x005,
KEY_SHIFT = 0x006,
KEY_PAUSE = 0x007,
KEY_CAPSLOCK = 0x008,
KEY_ESCAPE = 0x009,
KEY_SPACE = 0x00a,
KEY_PAGE_DOWN = 0x00b,
KEY_PAGE_UP = 0x00c,
KEY_END = 0x00d,
KEY_HOME = 0x00e,
KEY_LEFT = 0x00f,
KEY_UP = 0x010,
KEY_RIGHT = 0x011,
KEY_DOWN = 0x012,
KEY_PRINT = 0x013,
KEY_INSERT = 0x014,
KEY_DELETE = 0x015,
KEY_HELP = 0x016,
KEY_0 = 0x017,
KEY_1 = 0x018,
KEY_2 = 0x019,
KEY_3 = 0x01a,
KEY_4 = 0x01b,
KEY_5 = 0x01c,
KEY_6 = 0x01d,
KEY_7 = 0x01e,
KEY_8 = 0x01f,
KEY_9 = 0x020,
KEY_A = 0x021,
KEY_B = 0x022,
KEY_C = 0x023,
KEY_D = 0x024,
KEY_E = 0x025,
KEY_F = 0x026,
KEY_G = 0x027,
KEY_H = 0x028,
KEY_I = 0x029,
KEY_J = 0x02a,
KEY_K = 0x02b,
KEY_L = 0x02c,
KEY_M = 0x02d,
KEY_N = 0x02e,
KEY_O = 0x02f,
KEY_P = 0x030,
KEY_Q = 0x031,
KEY_R = 0x032,
KEY_S = 0x033,
KEY_T = 0x034,
KEY_U = 0x035,
KEY_V = 0x036,
KEY_W = 0x037,
KEY_X = 0x038,
KEY_Y = 0x039,
KEY_Z = 0x03a,
KEY_TILDE = 0x03b,
KEY_MINUS = 0x03c,
KEY_EQUALS = 0x03d,
KEY_LBRACKET = 0x03e,
KEY_RBRACKET = 0x03f,
KEY_BACKSLASH = 0x040,
KEY_SEMICOLON = 0x041,
KEY_APOSTROPHE = 0x042,
KEY_COMMA = 0x043,
KEY_PERIOD = 0x044,
KEY_SLASH = 0x045,
KEY_NUMPAD0 = 0x046,
KEY_NUMPAD1 = 0x047,
KEY_NUMPAD2 = 0x048,
KEY_NUMPAD3 = 0x049,
KEY_NUMPAD4 = 0x04a,
KEY_NUMPAD5 = 0x04b,
KEY_NUMPAD6 = 0x04c,
KEY_NUMPAD7 = 0x04d,
KEY_NUMPAD8 = 0x04e,
KEY_NUMPAD9 = 0x04f,
KEY_MULTIPLY = 0x050,
KEY_ADD = 0x051,
KEY_SEPARATOR = 0x052,
KEY_SUBTRACT = 0x053,
KEY_DECIMAL = 0x054,
KEY_DIVIDE = 0x055,
KEY_NUMPADENTER = 0x056,
KEY_F1 = 0x057,
KEY_F2 = 0x058,
KEY_F3 = 0x059,
KEY_F4 = 0x05a,
KEY_F5 = 0x05b,
KEY_F6 = 0x05c,
KEY_F7 = 0x05d,
KEY_F8 = 0x05e,
KEY_F9 = 0x05f,
KEY_F10 = 0x060,
KEY_F11 = 0x061,
KEY_F12 = 0x062,
KEY_F13 = 0x063,
KEY_F14 = 0x064,
KEY_F15 = 0x065,
KEY_F16 = 0x066,
KEY_F17 = 0x067,
KEY_F18 = 0x068,
KEY_F19 = 0x069,
KEY_F20 = 0x06a,
KEY_F21 = 0x06b,
KEY_F22 = 0x06c,
KEY_F23 = 0x06d,
KEY_F24 = 0x06e,
KEY_NUMLOCK = 0x06f,
KEY_SCROLLLOCK = 0x070,
KEY_LCONTROL = 0x071,
KEY_RCONTROL = 0x072,
KEY_LALT = 0x073,
KEY_RALT = 0x074,
KEY_LSHIFT = 0x075,
KEY_RSHIFT = 0x076,
KEY_WIN_LWINDOW = 0x077,
KEY_WIN_RWINDOW = 0x078,
KEY_WIN_APPS = 0x079,
KEY_OEM_102 = 0x080,
KEY_MAC_OPT = 0x090,
KEY_MAC_LOPT = 0x091,
KEY_MAC_ROPT = 0x092,
KEY_BUTTON0 = 0x0100,
KEY_BUTTON1 = 0x0101,
KEY_BUTTON2 = 0x0102,
KEY_BUTTON3 = 0x0103,
KEY_BUTTON4 = 0x0104,
KEY_BUTTON5 = 0x0105,
KEY_BUTTON6 = 0x0106,
KEY_BUTTON7 = 0x0107,
KEY_BUTTON8 = 0x0108,
KEY_BUTTON9 = 0x0109,
KEY_BUTTON10 = 0x010A,
KEY_BUTTON11 = 0x010B,
KEY_BUTTON12 = 0x010C,
KEY_BUTTON13 = 0x010D,
KEY_BUTTON14 = 0x010E,
KEY_BUTTON15 = 0x010F,
KEY_BUTTON16 = 0x0110,
KEY_BUTTON17 = 0x0111,
KEY_BUTTON18 = 0x0112,
KEY_BUTTON19 = 0x0113,
KEY_BUTTON20 = 0x0114,
KEY_BUTTON21 = 0x0115,
KEY_BUTTON22 = 0x0116,
KEY_BUTTON23 = 0x0117,
KEY_BUTTON24 = 0x0118,
KEY_BUTTON25 = 0x0119,
KEY_BUTTON26 = 0x011A,
KEY_BUTTON27 = 0x011B,
KEY_BUTTON28 = 0x011C,
KEY_BUTTON29 = 0x011D,
KEY_BUTTON30 = 0x011E,
KEY_BUTTON31 = 0x011F,
KEY_BUTTON32 = 0x0120,
KEY_BUTTON33 = 0x0121,
KEY_BUTTON34 = 0x0122,
KEY_BUTTON35 = 0x0123,
KEY_BUTTON36 = 0x0124,
KEY_BUTTON37 = 0x0125,
KEY_BUTTON38 = 0x0126,
KEY_BUTTON39 = 0x0127,
KEY_BUTTON40 = 0x0128,
KEY_BUTTON41 = 0x0129,
KEY_BUTTON42 = 0x012A,
KEY_BUTTON43 = 0x012B,
KEY_BUTTON44 = 0x012C,
KEY_BUTTON45 = 0x012D,
KEY_BUTTON46 = 0x012E,
KEY_BUTTON47 = 0x012F,
KEY_ANYKEY = 0xfffe,
/// Joystick event codes.
SI_XPOV = 0x204,
SI_YPOV = 0x205,
SI_UPOV = 0x206,
SI_DPOV = 0x207,
SI_LPOV = 0x208,
SI_RPOV = 0x209,
SI_XAXIS = 0x20B,
SI_YAXIS = 0x20C,
SI_ZAXIS = 0x20D,
SI_RXAXIS = 0x20E,
SI_RYAXIS = 0x20F,
SI_RZAXIS = 0x210,
SI_SLIDER = 0x211,
SI_XPOV2 = 0x212,
SI_YPOV2 = 0x213,
SI_UPOV2 = 0x214,
SI_DPOV2 = 0x215,
SI_LPOV2 = 0x216,
SI_RPOV2 = 0x217,
XI_CONNECT = 0x300,
XI_THUMBLX = 0x301,
XI_THUMBLY = 0x302,
XI_THUMBRX = 0x303,
XI_THUMBRY = 0x304,
XI_LEFT_TRIGGER = 0x305,
XI_RIGHT_TRIGGER = 0x306,
/*XI_DPAD_UP = 0x307,
XI_DPAD_DOWN = 0x308,
XI_DPAD_LEFT = 0x309,
XI_DPAD_RIGHT = 0x310,*/
XI_START = 0x311,
XI_BACK = 0x312,
XI_LEFT_THUMB = 0x313,
XI_RIGHT_THUMB = 0x314,
XI_LEFT_SHOULDER = 0x315,
XI_RIGHT_SHOULDER = 0x316,
XI_A = 0x317,
XI_B = 0x318,
XI_X = 0x319,
XI_Y = 0x320,
INPUT_DEVICE_PLUGIN_CODES_START = 0x400,
};
/// Input device types
typedef U32 InputDeviceTypes;
enum InputDeviceTypesEnum
{
UnknownDeviceType,
MouseDeviceType,
KeyboardDeviceType,
JoystickDeviceType,
GamepadDeviceType,
XInputDeviceType,
NUM_INPUT_DEVICE_TYPES,
INPUT_DEVICE_PLUGIN_DEVICES_START = NUM_INPUT_DEVICE_TYPES,
};
/// Device Event Action Types
enum InputActionType
{
/// Button was depressed.
SI_MAKE = 0x01,
/// Button was released.
SI_BREAK = 0x02,
/// An axis moved.
SI_MOVE = 0x03,
/// A key repeat occurred. Happens in between a SI_MAKE and SI_BREAK.
SI_REPEAT = 0x04,
/// A value of some type. Matched with SI_FLOAT or SI_INT.
SI_VALUE = 0x05,
};
///Device Event Types
enum InputEventType
{
SI_UNKNOWN = 0x01,
SI_BUTTON = 0x02, // Button press/release
SI_POV = 0x03, // Point of View hat
SI_AXIS = 0x04, // Axis in range -1.0..1.0
SI_POS = 0x05, // Absolute position value (Point3F)
SI_ROT = 0x06, // Absolute rotation value (QuatF)
SI_INT = 0x07, // Integer value (S32)
SI_FLOAT = 0x08, // Float value (F32)
SI_KEY = 0x0A, // Keyboard key
};
/// Wildcard match used by the input system.
#define SI_ANY 0xff
// Modifier Keys
enum InputModifiers
{
/// shift and ctrl are the same between platforms.
SI_LSHIFT = BIT(0),
SI_RSHIFT = BIT(1),
SI_SHIFT = (SI_LSHIFT|SI_RSHIFT),
SI_LCTRL = BIT(2),
SI_RCTRL = BIT(3),
SI_CTRL = (SI_LCTRL|SI_RCTRL),
/// win altkey, mapped to mac cmdkey.
SI_LALT = BIT(4),
SI_RALT = BIT(5),
SI_ALT = (SI_LALT|SI_RALT),
/// mac optionkey
SI_MAC_LOPT = BIT(6),
SI_MAC_ROPT = BIT(7),
SI_MAC_OPT = (SI_MAC_LOPT|SI_MAC_ROPT),
/// modifier keys used for common operations
#if defined(TORQUE_OS_MAC)
SI_COPYPASTE = SI_ALT,
SI_MULTISELECT = SI_ALT,
SI_RANGESELECT = SI_SHIFT,
SI_PRIMARY_ALT = SI_MAC_OPT, ///< Primary key used for toggling into alternates of commands.
SI_PRIMARY_CTRL = SI_ALT, ///< Primary key used for triggering commands.
#else
SI_COPYPASTE = SI_CTRL,
SI_MULTISELECT = SI_CTRL,
SI_RANGESELECT = SI_SHIFT,
SI_PRIMARY_ALT = SI_ALT,
SI_PRIMARY_CTRL = SI_CTRL,
#endif
/// modfier key used in conjunction w/ arrow keys to move cursor to next word
#if defined(TORQUE_OS_MAC)
SI_WORDJUMP = SI_MAC_OPT,
#else
SI_WORDJUMP = SI_CTRL,
#endif
/// modifier key used in conjunction w/ arrow keys to move cursor to beginning / end of line
SI_LINEJUMP = SI_ALT,
/// modifier key used in conjunction w/ home & end to jump to the top or bottom of a document
#if defined(TORQUE_OS_MAC)
SI_DOCJUMP = SI_ANY,
#else
SI_DOCJUMP = SI_CTRL,
#endif
};
/// @}
/// Generic input event.
struct InputEventInfo
{
InputEventInfo()
{
deviceInst = 0;
fValue = 0.f;
fValue2 = 0.f;
fValue3 = 0.f;
fValue4 = 0.f;
iValue = 0;
deviceType = (InputDeviceTypes)0;
objType = (InputEventType)0;
ascii = 0;
objInst = (InputObjectInstances)0;
action = (InputActionType)0;
modifier = (InputModifiers)0;
}
/// Device instance: joystick0, joystick1, etc
U32 deviceInst;
/// Value typically ranges from -1.0 to 1.0, but doesn't have to.
/// It depends on the context.
F32 fValue;
/// Extended float values (often used for absolute rotation Quat)
F32 fValue2;
F32 fValue3;
F32 fValue4;
/// Signed integer value
S32 iValue;
/// What was the action? (MAKE/BREAK/MOVE)
InputActionType action;
InputDeviceTypes deviceType;
InputEventType objType;
InputObjectInstances objInst;
/// ASCII character code if this is a keyboard event.
U16 ascii;
/// Modifiers to action: SI_LSHIFT, SI_LCTRL, etc.
InputModifiers modifier;
inline void postToSignal(InputEvent &ie)
{
ie.trigger(deviceInst, fValue, fValue2, fValue3, fValue4, iValue, deviceType, objType, ascii, objInst, action, modifier);
}
};
class Point3F;
class QuatF;
/// Handles input device plug-ins
class InputEventManager
{
public:
struct VirtualMapData
{
StringTableEntry desc;
InputEventType type;
InputObjectInstances code;
};
public:
InputEventManager();
virtual ~InputEventManager();
/// Get the next device type code
U32 getNextDeviceType();
/// Get the next device action code
U32 getNextDeviceCode();
void registerDevice(IInputDevice* device);
void unregisterDevice(IInputDevice* device);
/// Check if the given device name is a registered device.
/// The given name can optionally include an instance number on the end.
bool isRegisteredDevice(const char* name);
/// Check if the given device type is a registered device.
bool isRegisteredDevice(U32 type);
/// Same as above but also provides the found device type and actual
// device name length. Used by ActionMap::getDeviceTypeAndInstance()
bool isRegisteredDeviceWithAttributes(const char* name, U32& deviceType, U32&nameLen);
/// Returns the name of a registered device given its type
const char* getRegisteredDeviceName(U32 type);
void start();
void stop();
void process();
// Add to the virtual map table
void addVirtualMap(const char* description, InputEventType type, InputObjectInstances code);
// Find a virtual map entry based on the text description
VirtualMapData* findVirtualMap(const char* description);
// Find a virtual map entry's description based on the action code
const char* findVirtualMapDescFromCode(U32 code);
/// Build an input event based on a single iValue
void buildInputEvent(U32 deviceType, U32 deviceInst, InputEventType objType, InputObjectInstances objInst, InputActionType action, S32 iValue);
/// Build an input event based on a single fValue
void buildInputEvent(U32 deviceType, U32 deviceInst, InputEventType objType, InputObjectInstances objInst, InputActionType action, float fValue);
/// Build an input event based on a Point3F
void buildInputEvent(U32 deviceType, U32 deviceInst, InputEventType objType, InputObjectInstances objInst, InputActionType action, Point3F& pValue);
/// Build an input event based on a QuatF
void buildInputEvent(U32 deviceType, U32 deviceInst, InputEventType objType, InputObjectInstances objInst, InputActionType action, QuatF& qValue);
protected:
U32 mNextDeviceTypeCode;
U32 mNextDeviceCode;
Vector<IInputDevice*> mDeviceList;
// Holds description to VirtualMapData struct
SimpleHashTable<VirtualMapData> mVirtualMap;
// Used to look up a description based on a VirtualMapData.code
HashTable<U32, VirtualMapData> mActionCodeMap;
protected:
void buildVirtualMap();
public:
// For ManagedSingleton.
static const char* getSingletonName() { return "InputEventManager"; }
};
/// Returns the InputEventManager singleton.
#define INPUTMGR ManagedSingleton<InputEventManager>::instance()
#endif