Convert top-level constants to enums

src/deprecated/deprecated.js

@@ -45,6 +45,8 @@
 import { XrInputSource } from '../framework/xr/xr-input-source.js';
 
 import { ElementInput } from '../framework/input/element-input.js';
+import { Key } from '../platform/input/key.js';
+import { MouseButton } from '../platform/input/mouse-button.js';
 import { MouseEvent } from '../platform/input/mouse-event.js';
 
 import { AppBase } from '../framework/app-base.js';
@@ -771,6 +773,109 @@
 export const EVENT_SELECTSTART = 'selectstart';
 export const EVENT_SELECTEND = 'selectend';
 
+export const KEY_BACKSPACE = Key.Backspace;
+export const KEY_TAB = Key.Tab;
+export const KEY_RETURN = Key.Return;
+export const KEY_ENTER = Key.Enter;
+export const KEY_SHIFT = Key.Shift;
+export const KEY_CONTROL = Key.Control;
+export const KEY_ALT = Key.Alt;
+export const KEY_PAUSE = Key.Pause;
+export const KEY_CAPS_LOCK = Key.CapsLock;
+export const KEY_ESCAPE = Key.Escape;
+export const KEY_SPACE = Key.Space;
+export const KEY_PAGE_UP = Key.PageUp;
+export const KEY_PAGE_DOWN = Key.PageDown;
+export const KEY_END = Key.End;
+export const KEY_HOME = Key.Home;
+export const KEY_LEFT = Key.Left;
+export const KEY_UP = Key.Up;
+export const KEY_RIGHT = Key.Right;
+export const KEY_DOWN = Key.Down;
+export const KEY_PRINT_SCREEN = Key.PrintScreen;
+export const KEY_INSERT = Key.Insert;
+export const KEY_DELETE = Key.Delete;
+export const KEY_0 = Key.Key0;
+export const KEY_1 = Key.Key1;
+export const KEY_2 = Key.Key2;
+export const KEY_3 = Key.Key3;
+export const KEY_4 = Key.Key4;
+export const KEY_5 = Key.Key5;
+export const KEY_6 = Key.Key6;
+export const KEY_7 = Key.Key7;
+export const KEY_8 = Key.Key8;
+export const KEY_9 = Key.Key9;
+export const KEY_SEMICOLON = Key.Semicolon;
+export const KEY_EQUAL = Key.Equal;
+export const KEY_A = Key.A;
+export const KEY_B = Key.B;
+export const KEY_C = Key.C;
+export const KEY_D = Key.D;
+export const KEY_E = Key.E;
+export const KEY_F = Key.F;
+export const KEY_G = Key.G;
+export const KEY_H = Key.H;
+export const KEY_I = Key.I;
+export const KEY_J = Key.J;
+export const KEY_K = Key.K;
+export const KEY_L = Key.L;
+export const KEY_M = Key.M;
+export const KEY_N = Key.N;
+export const KEY_O = Key.O;
+export const KEY_P = Key.P;
+export const KEY_Q = Key.Q;
+export const KEY_R = Key.R;
+export const KEY_S = Key.S;
+export const KEY_T = Key.T;
+export const KEY_U = Key.U;
+export const KEY_V = Key.V;
+export const KEY_W = Key.W;
+export const KEY_X = Key.X;
+export const KEY_Y = Key.Y;
+export const KEY_Z = Key.Z;
+export const KEY_WINDOWS = Key.Windows;
+export const KEY_CONTEXT_MENU = Key.ContextMenu;
+export const KEY_NUMPAD_0 = Key.Numpad0;
+export const KEY_NUMPAD_1 = Key.Numpad1;
+export const KEY_NUMPAD_2 = Key.Numpad2;
+export const KEY_NUMPAD_3 = Key.Numpad3;
+export const KEY_NUMPAD_4 = Key.Numpad4;
+export const KEY_NUMPAD_5 = Key.Numpad5;
+export const KEY_NUMPAD_6 = Key.Numpad6;
+export const KEY_NUMPAD_7 = Key.Numpad7;
+export const KEY_NUMPAD_8 = Key.Numpad8;
+export const KEY_NUMPAD_9 = Key.Numpad9;
+export const KEY_MULTIPLY = Key.Multiply;
+export const KEY_ADD = Key.Add;
+export const KEY_SEPARATOR = Key.Separator;
+export const KEY_SUBTRACT = Key.Subtract;
+export const KEY_DECIMAL = Key.Decimal;
+export const KEY_DIVIDE = Key.Divide;
+export const KEY_F1 = Key.F1;
+export const KEY_F2 = Key.F2;
+export const KEY_F3 = Key.F3;
+export const KEY_F4 = Key.F4;
+export const KEY_F5 = Key.F5;
+export const KEY_F6 = Key.F6;
+export const KEY_F7 = Key.F7;
+export const KEY_F8 = Key.F8;
+export const KEY_F9 = Key.F9;
+export const KEY_F10 = Key.F10;
+export const KEY_F11 = Key.F11;
+export const KEY_F12 = Key.F12;
+export const KEY_COMMA = Key.Comma;
+export const KEY_PERIOD = Key.Period;
+export const KEY_SLASH = Key.Slash;
+export const KEY_OPEN_BRACKET = Key.OpenBracket;
+export const KEY_BACK_SLASH = Key.BackSlash;
+export const KEY_CLOSE_BRACKET = Key.CloseBracket;
+export const KEY_META = Key.Meta;
+
+export const MOUSEBUTTON_NONE = MouseButton.None;
+export const MOUSEBUTTON_LEFT = MouseButton.Left;
+export const MOUSEBUTTON_MIDDLE = MouseButton.Middle;
+export const MOUSEBUTTON_RIGHT = MouseButton.Right;
+
 Object.defineProperty(ElementInput.prototype, 'wheel', {
     get: function () {
         return this.wheelDelta * -2;

src/framework/app-base.js

@@ -284,7 +284,7 @@ class AppBase extends EventHandler {
      * @type {boolean}
      * @example
      * // Render the scene only while space key is pressed
-     * if (this.app.keyboard.isPressed(pc.KEY_SPACE)) {
+     * if (this.app.keyboard.isPressed(pc.Key.Space)) {
      *     this.app.renderNextFrame = true;
      * }
      */

src/framework/xr/xr-manager.js

@@ -569,7 +569,7 @@ class XrManager extends EventHandler {
      * session.
      * @example
      * app.keyboard.on('keydown', (evt) => {
-     *     if (evt.key === pc.KEY_ESCAPE && app.xr.active) {
+     *     if (evt.key === pc.Key.Escape && app.xr.active) {
      *         app.xr.end();
      *     }
      * });

src/index.js

@@ -144,6 +144,7 @@ export { GamePads } from './platform/input/game-pads.js';
 export { Keyboard } from './platform/input/keyboard.js';
 export { KeyboardEvent } from './platform/input/keyboard-event.js';
 export { Mouse } from './platform/input/mouse.js';
+export { MouseButton } from './platform/input/mouse-button.js';
 export { MouseEvent } from './platform/input/mouse-event.js';
 export { TouchDevice } from './platform/input/touch-device.js';
 export { getTouchTargetCoords, Touch, TouchEvent } from './platform/input/touch-event.js';