llkeyboard.h
上传用户:king477883
上传日期:2021-03-01
资源大小:9553k
文件大小:5k
源码类别:

游戏引擎

开发平台:

C++ Builder

  1. /** 
  2.  * @file llkeyboard.h
  3.  * @brief Handler for assignable key bindings
  4.  *
  5.  * $LicenseInfo:firstyear=2001&license=viewergpl$
  6.  * 
  7.  * Copyright (c) 2001-2010, Linden Research, Inc.
  8.  * 
  9.  * Second Life Viewer Source Code
  10.  * The source code in this file ("Source Code") is provided by Linden Lab
  11.  * to you under the terms of the GNU General Public License, version 2.0
  12.  * ("GPL"), unless you have obtained a separate licensing agreement
  13.  * ("Other License"), formally executed by you and Linden Lab.  Terms of
  14.  * the GPL can be found in doc/GPL-license.txt in this distribution, or
  15.  * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
  16.  * 
  17.  * There are special exceptions to the terms and conditions of the GPL as
  18.  * it is applied to this Source Code. View the full text of the exception
  19.  * in the file doc/FLOSS-exception.txt in this software distribution, or
  20.  * online at
  21.  * http://secondlifegrid.net/programs/open_source/licensing/flossexception
  22.  * 
  23.  * By copying, modifying or distributing this software, you acknowledge
  24.  * that you have read and understood your obligations described above,
  25.  * and agree to abide by those obligations.
  26.  * 
  27.  * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
  28.  * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
  29.  * COMPLETENESS OR PERFORMANCE.
  30.  * $/LicenseInfo$
  31.  */
  32. #ifndef LL_LLKEYBOARD_H
  33. #define LL_LLKEYBOARD_H
  34. #include <map>
  35. #include "string_table.h"
  36. #include "lltimer.h"
  37. #include "indra_constants.h"
  38. enum EKeystate 
  39. {
  40. KEYSTATE_DOWN,
  41. KEYSTATE_LEVEL,
  42. KEYSTATE_UP 
  43. };
  44. typedef void (*LLKeyFunc)(EKeystate keystate);
  45. typedef std::string (LLKeyStringTranslatorFunc)(const char *label);
  46. enum EKeyboardInsertMode
  47. {
  48. LL_KIM_INSERT,
  49. LL_KIM_OVERWRITE
  50. };
  51. class LLKeyBinding
  52. {
  53. public:
  54. KEY mKey;
  55. MASK mMask;
  56. //  const char *mName; // unused
  57. LLKeyFunc mFunction;
  58. };
  59. class LLWindowCallbacks;
  60. class LLKeyboard
  61. {
  62. public:
  63. typedef enum e_numpad_distinct
  64. {
  65. ND_NEVER,
  66. ND_NUMLOCK_OFF,
  67. ND_NUMLOCK_ON
  68. } ENumpadDistinct;
  69. public:
  70. LLKeyboard();
  71. virtual ~LLKeyboard();
  72. void resetKeys();
  73. F32 getCurKeyElapsedTime() { return getKeyDown(mCurScanKey) ? getKeyElapsedTime( mCurScanKey ) : 0.f; }
  74. F32 getCurKeyElapsedFrameCount() { return getKeyDown(mCurScanKey) ? (F32)getKeyElapsedFrameCount( mCurScanKey ) : 0.f; }
  75. BOOL getKeyDown(const KEY key) { return mKeyLevel[key]; }
  76. BOOL getKeyRepeated(const KEY key) { return mKeyRepeated[key]; }
  77. BOOL translateKey(const U16 os_key, KEY *translated_key);
  78. U16 inverseTranslateKey(const KEY translated_key);
  79. BOOL handleTranslatedKeyUp(KEY translated_key, U32 translated_mask); // Translated into "Linden" keycodes
  80. BOOL handleTranslatedKeyDown(KEY translated_key, U32 translated_mask); // Translated into "Linden" keycodes
  81. virtual BOOL handleKeyUp(const U16 key, MASK mask) = 0;
  82. virtual BOOL handleKeyDown(const U16 key, MASK mask) = 0;
  83. // Asynchronously poll the control, alt, and shift keys and set the
  84. // appropriate internal key masks.
  85. virtual void resetMaskKeys() = 0;
  86. virtual void scanKeyboard() = 0; // scans keyboard, calls functions as necessary
  87. // Mac must differentiate between Command = Control for keyboard events
  88. // and Command != Control for mouse events.
  89. virtual MASK currentMask(BOOL for_mouse_event) = 0;
  90. virtual KEY currentKey() { return mCurTranslatedKey; }
  91. EKeyboardInsertMode getInsertMode() { return mInsertMode; }
  92. void toggleInsertMode();
  93. static BOOL maskFromString(const std::string& str, MASK *mask); // False on failure
  94. static BOOL keyFromString(const std::string& str, KEY *key); // False on failure
  95. static std::string stringFromKey(KEY key);
  96. static std::string stringFromAccelerator( MASK accel_mask, KEY key );
  97. e_numpad_distinct getNumpadDistinct() { return mNumpadDistinct; }
  98. void setNumpadDistinct(e_numpad_distinct val) { mNumpadDistinct = val; }
  99. void setCallbacks(LLWindowCallbacks *cbs) { mCallbacks = cbs; }
  100. F32 getKeyElapsedTime( KEY key );  // Returns time in seconds since key was pressed.
  101. S32 getKeyElapsedFrameCount( KEY key );  // Returns time in frames since key was pressed.
  102. static void setStringTranslatorFunc( LLKeyStringTranslatorFunc *trans_func );
  103. protected:
  104. void  addKeyName(KEY key, const std::string& name);
  105. protected:
  106. std::map<U16, KEY> mTranslateKeyMap; // Map of translations from OS keys to Linden KEYs
  107. std::map<KEY, U16> mInvTranslateKeyMap; // Map of translations from Linden KEYs to OS keys
  108. LLWindowCallbacks *mCallbacks;
  109. LLTimer mKeyLevelTimer[KEY_COUNT]; // Time since level was set
  110. S32 mKeyLevelFrameCount[KEY_COUNT]; // Frames since level was set
  111. BOOL mKeyLevel[KEY_COUNT]; // Levels
  112. BOOL mKeyRepeated[KEY_COUNT]; // Key was repeated
  113. BOOL mKeyUp[KEY_COUNT]; // Up edge
  114. BOOL mKeyDown[KEY_COUNT]; // Down edge
  115. KEY mCurTranslatedKey;
  116. KEY mCurScanKey; // Used during the scanKeyboard()
  117. static LLKeyStringTranslatorFunc* mStringTranslator; // Used for l10n + PC/Mac/Linux accelerator labeling
  118. e_numpad_distinct mNumpadDistinct;
  119. EKeyboardInsertMode mInsertMode;
  120. static std::map<KEY,std::string> sKeysToNames;
  121. static std::map<std::string,KEY> sNamesToKeys;
  122. };
  123. extern LLKeyboard *gKeyboard;
  124. #endif