From be90a1cfdc6f54e5ed8d27f40138c83426dab640 Mon Sep 17 00:00:00 2001 From: terry feng Date: Tue, 5 Dec 2023 13:22:13 -0800 Subject: [PATCH] Introduce HID, add documentation, clean chuck code --- dist/Hid.d.ts | 39 ++++++++---- dist/Hid.js | 76 ++++++++++++---------- dist/hidCk.d.ts | 4 +- dist/hidCk.js | 61 ++++-------------- docs/assets/search.js | 2 +- docs/classes/Chuck.html | 106 +++++++++++++++---------------- docs/classes/HID.html | 91 ++++++++++---------------- src/Hid.ck | 105 ------------------------------ src/Hid.ts | 109 +++++++++++++++++--------------- src/HidMsg.ck | 71 --------------------- src/hidCk.ts | 61 ++++-------------- src/wc-bundle.js | 137 +++++++++++++++++----------------------- test/chuckTest.js | 5 +- 13 files changed, 306 insertions(+), 561 deletions(-) delete mode 100644 src/Hid.ck delete mode 100644 src/HidMsg.ck diff --git a/dist/Hid.d.ts b/dist/Hid.d.ts index 53b79be..b65813f 100644 --- a/dist/Hid.d.ts +++ b/dist/Hid.d.ts @@ -1,9 +1,20 @@ import Chuck from "./Chuck"; +/** + * Introducing HID (Human Interface Device) support for WebChucK. WebChucK HID + * brings mouse and keyboard support to work with the native {@link https://chuck.stanford.edu/doc/reference/io.html#Hid | Hid} + * class in ChucK. WebChucK HID wraps JavaScript mouse and keyboard event + * listeners. To get started with HID: + * @example + * ```ts + * import { Chuck, HID } from "webchuck"; + * + * const theChuck = await Chuck.init([]); + * const hid = await HID.init(theChuck); + * ``` + */ export default class HID { private theChuck; private keymap; - private mousePos; - private lastPos; private _mouseActive; private _kbdActive; private boundHandleMouseMove; @@ -20,12 +31,12 @@ export default class HID { * Mouse and keyboard event listeners are added if `enableMouse` and `enableKeyboard` are true (default). * @example * ```ts - * theChuck = await Chuck.init(); // Initialize WebChucK + * theChuck = await Chuck.init([]); * hid = await HID.init(theChuck); // Initialize HID with mouse and keyboard * ``` * @example * ```ts - * theChuck = await Chuck.init(); // Initialize WebChucK + * theChuck = await Chuck.init([]); * hid = await HID.init(theChuck, false, true); // Initialize HID, no mouse, only keyboard * ``` * @param theChuck WebChucK instance @@ -54,7 +65,7 @@ export default class HID { y: number; }; /** - * Enable Mouse HID Javascript event listeners to communicate with ChucK + * Enable Mouse HID Javascript event listeners for Chuck HID * Adds a mousemove, mousedown, mouseup, and wheel listener to the document. * @example * ```ts @@ -73,7 +84,7 @@ export default class HID { */ disableMouse(): void; /** - * Enable keyboard HID Javascript event listeners to communicate with ChucK. + * Enable keyboard HID Javascript event listeners for Chuck HID * Adds a keydown and keyup listener to the document. * @example * ```ts @@ -92,22 +103,24 @@ export default class HID { */ disableKeyboard(): void; /** @internal */ - handleMouseMove(e: MouseEvent): void; + private handleMouseMove; /** @internal */ - handleMouseDown(e: MouseEvent): void; + private handleMouseDown; /** @internal */ - handleMouseUp(e: MouseEvent): void; + private handleMouseUp; /** @internal */ - handleMouseWheel(e: WheelEvent): void; + private handleMouseWheel; /** @internal */ - handleKeyDown(e: KeyboardEvent): void; + private static handleContextMenu; /** @internal */ - handleKeyUp(e: KeyboardEvent): void; + private handleKeyDown; + /** @internal */ + private handleKeyUp; /** * @internal * Handle keyboard presses to send to chuck * @param e Keyboard event * @param isDown Is key down */ - keyPressManager(e: KeyboardEvent, isDown: boolean): void; + private keyPressManager; } diff --git a/dist/Hid.js b/dist/Hid.js index cad4ef1..da65e86 100644 --- a/dist/Hid.js +++ b/dist/Hid.js @@ -1,4 +1,24 @@ import { Hid_ck, HidMsg_ck } from "./hidCk"; +var HidMsgType; +(function (HidMsgType) { + HidMsgType[HidMsgType["BUTTON_DOWN"] = 1] = "BUTTON_DOWN"; + HidMsgType[HidMsgType["BUTTON_UP"] = 2] = "BUTTON_UP"; + HidMsgType[HidMsgType["MOUSE_MOTION"] = 5] = "MOUSE_MOTION"; + HidMsgType[HidMsgType["WHEEL_MOTION"] = 6] = "WHEEL_MOTION"; +})(HidMsgType || (HidMsgType = {})); +/** + * Introducing HID (Human Interface Device) support for WebChucK. WebChucK HID + * brings mouse and keyboard support to work with the native {@link https://chuck.stanford.edu/doc/reference/io.html#Hid | Hid} + * class in ChucK. WebChucK HID wraps JavaScript mouse and keyboard event + * listeners. To get started with HID: + * @example + * ```ts + * import { Chuck, HID } from "webchuck"; + * + * const theChuck = await Chuck.init([]); + * const hid = await HID.init(theChuck); + * ``` + */ export default class HID { /** @internal */ constructor(theChuck) { @@ -7,8 +27,6 @@ export default class HID { // Initialize members this.theChuck = theChuck; this.keymap = new Array(256).fill(false); - this.mousePos = { x: 0, y: 0 }; - this.lastPos = { x: 0, y: 0 }; // Bind handlers this.boundHandleMouseMove = this.handleMouseMove.bind(this); this.boundHandleMouseDown = this.handleMouseDown.bind(this); @@ -23,12 +41,12 @@ export default class HID { * Mouse and keyboard event listeners are added if `enableMouse` and `enableKeyboard` are true (default). * @example * ```ts - * theChuck = await Chuck.init(); // Initialize WebChucK + * theChuck = await Chuck.init([]); * hid = await HID.init(theChuck); // Initialize HID with mouse and keyboard * ``` * @example * ```ts - * theChuck = await Chuck.init(); // Initialize WebChucK + * theChuck = await Chuck.init([]); * hid = await HID.init(theChuck, false, true); // Initialize HID, no mouse, only keyboard * ``` * @param theChuck WebChucK instance @@ -78,7 +96,7 @@ export default class HID { }; } /** - * Enable Mouse HID Javascript event listeners to communicate with ChucK + * Enable Mouse HID Javascript event listeners for Chuck HID * Adds a mousemove, mousedown, mouseup, and wheel listener to the document. * @example * ```ts @@ -91,6 +109,7 @@ export default class HID { document.addEventListener("mousedown", this.boundHandleMouseDown); document.addEventListener("mouseup", this.boundHandleMouseUp); document.addEventListener("wheel", this.boundHandleMouseWheel); + document.addEventListener("contextmenu", HID.handleContextMenu); } /** * Disable Mouse HID Javascript event listeners @@ -105,9 +124,10 @@ export default class HID { document.removeEventListener("mousedown", this.boundHandleMouseDown); document.removeEventListener("mouseup", this.boundHandleMouseUp); document.removeEventListener("wheel", this.boundHandleMouseWheel); + document.removeEventListener("contextmenu", HID.handleContextMenu); } /** - * Enable keyboard HID Javascript event listeners to communicate with ChucK. + * Enable keyboard HID Javascript event listeners for Chuck HID * Adds a keydown and keyup listener to the document. * @example * ```ts @@ -139,55 +159,47 @@ export default class HID { handleMouseMove(e) { this.mouseActive(); if (this._mouseActive) { - this.mousePos = this.getMousePos(e); - this.theChuck.setInt("_mouseMotion", 1); - this.theChuck.broadcastEvent("_hid"); - this.theChuck.setInt("_mouseX", this.mousePos.x); - this.theChuck.setInt("_mouseY", this.mousePos.y); + const mousePos = this.getMousePos(e); this.theChuck.setFloat("_deltaX", e.movementX); this.theChuck.setFloat("_deltaY", e.movementY); - this.theChuck.setFloat("_scaledCursorX", this.mousePos.x / document.documentElement.clientWidth); - this.theChuck.setFloat("_scaledCursorY", this.mousePos.y / document.documentElement.clientHeight); - this.theChuck.broadcastEvent("_msg"); + this.theChuck.setFloat("_scaledCursorX", mousePos.x / document.documentElement.clientWidth); + this.theChuck.setFloat("_scaledCursorY", mousePos.y / document.documentElement.clientHeight); + this.theChuck.setInt("_type", HidMsgType.MOUSE_MOTION); + this.theChuck.broadcastEvent("_hid"); } - this.lastPos = this.mousePos; } /** @internal */ handleMouseDown(e) { this.mouseActive(); if (this._mouseActive) { - this.theChuck.setInt("_mouseMotion", 0); - this.theChuck.setInt("_mouseDown", 1); - this.theChuck.broadcastEvent("_hid"); - this.theChuck.setInt("_hidMouse", 1); this.theChuck.setInt("_which", e.which); - this.theChuck.broadcastEvent("_msg"); + this.theChuck.setInt("_type", HidMsgType.BUTTON_DOWN); + this.theChuck.broadcastEvent("_hid"); } } /** @internal */ handleMouseUp(e) { this.mouseActive(); if (this._mouseActive) { - this.theChuck.setInt("_mouseMotion", 0); - this.theChuck.setInt("_mouseUp", 1); - this.theChuck.broadcastEvent("_hid"); - this.theChuck.setInt("_hidMouse", 1); this.theChuck.setInt("_which", e.which); - this.theChuck.broadcastEvent("_msg"); + this.theChuck.setInt("_type", HidMsgType.BUTTON_UP); + this.theChuck.broadcastEvent("_hid"); } } /** @internal */ handleMouseWheel(e) { this.mouseActive(); if (this._mouseActive) { - this.theChuck.setInt("_mouseMotion", 0); - this.theChuck.setInt("_isScroll", 1); - this.theChuck.setInt("_deltaX", clamp(e.deltaX, -1, 1)); - this.theChuck.setInt("_deltaY", clamp(e.deltaY, -1, 1)); + this.theChuck.setFloat("_deltaX", clamp(e.deltaX, -1, 1)); + this.theChuck.setFloat("_deltaY", clamp(e.deltaY, -1, 1)); + this.theChuck.setInt("_type", HidMsgType.WHEEL_MOTION); this.theChuck.broadcastEvent("_hid"); - this.theChuck.broadcastEvent("_msg"); } } + /** @internal */ + static handleContextMenu(e) { + e.preventDefault(); + } //----------- KEYBOARD --------- // /** @internal */ handleKeyDown(e) { @@ -215,7 +227,7 @@ export default class HID { this.theChuck.setString("_key", e.key); this.theChuck.setInt("_which", e.which); this.theChuck.setInt("_ascii", e.keyCode); - this.theChuck.setInt("_type", isDown ? 1 : 2); + this.theChuck.setInt("_type", isDown ? HidMsgType.BUTTON_DOWN : HidMsgType.BUTTON_UP); this.theChuck.broadcastEvent("_hid"); } } @@ -227,7 +239,7 @@ export default class HID { * @param val value to clamp * @param min min value * @param max max value - * @returns clamp value + * @returns clamped value */ function clamp(val, min, max) { return Math.min(Math.max(val, min), max); diff --git a/dist/hidCk.d.ts b/dist/hidCk.d.ts index 06bcb8a..3e1cb8c 100644 --- a/dist/hidCk.d.ts +++ b/dist/hidCk.d.ts @@ -1,3 +1,3 @@ -declare const HidMsg_ck = "\nglobal Event _msg;\n \nglobal Event _hid;\nglobal int _hidMultiple;\n0 => global int _cursorX;\n0 => global int _cursorY;\n\n0 => global float _deltaX;\n0 => global float _deltaY;\n\nglobal string _key;\nglobal int _isDown;\nglobal int _isUp;\nglobal int _isMouseDown;\nglobal int _isMouseUp;\nglobal int _isScroll;\nglobal int _ascii;\nglobal int _which;\nglobal int _mouseActive;\nglobal int _kbdActive;\nglobal int _mouseMotion;\nglobal float _scaledCursorX;\nglobal float _scaledCursorY;\n\npublic class HidMsg {\n int type;\n int deviceType;\n int cursorX;\n int cursorY;\n float deltaX;\n float deltaY;\n float scaledCursorX;\n float scaledCursorY;\n int which;\n int ascii;\n string key;\n\n // type 1 message\n function int isButtonDown() {\n if (type == 1) { return 1; }\n return 0;\n }\n\n // type 2 message\n function int isButtonUp() {\n if (type == 2) { return 1; }\n return 0;\n }\n\n // type 5 message\n function int isMouseMotion(){\n if (type == 5) { return 1; }\n return 0;\n }\n\n // type 6 message\n function int isWheelMotion(){\n if (type == 6) { return 1; }\n return 0;\n }\n\n function void _copy(HidMsg localMsg) {\n localMsg.type => type;\n localMsg.deviceType => deviceType;\n localMsg.cursorX => cursorX;\n localMsg.cursorY => cursorY;\n localMsg.deltaX => deltaX;\n localMsg.deltaY => deltaY;\n localMsg.scaledCursorX => scaledCursorX;\n localMsg.scaledCursorY => scaledCursorY;\n localMsg.which => which;\n localMsg.ascii => ascii;\n localMsg.key => key;\n }\n}\n"; -declare const Hid_ck = "\nglobal Event _msg;\n\nglobal Event _hid;\nglobal int _cursorX;\nglobal int _cursorY;\n\nglobal float _deltaX;\nglobal float _deltaY;\n\nglobal int _type;\nglobal string _key;\nglobal int _isDown;\nglobal int _isUp;\nglobal int _isMouseDown;\nglobal int _isMouseUp;\nglobal int _isScroll;\nglobal int _ascii;\nglobal int _which;\nglobal int _mouseActive;\nglobal int _kbdActive;\nglobal int _mouseMotion;\nglobal float _scaledCursorX;\nglobal float _scaledCursorY;\n\npublic class Hid extends Event {\n\n 0 => int isMouseOpen;\n 0 => int isKBDOpen;\n 0 => int active;\n\n string deviceName; \n int deviceType; // mouse = 2, keyboard = 3\n\n // HidMsg Queue\n HidMsg _hidMsgQueue[0];\n\n function string name() {\n return deviceName;\n }\n\n function int openMouse(int num) {\n if (num < 0) {\n false => active;\n } else {\n \"virtualJS mouse/trackpad\" => deviceName;\n 2 => deviceType;\n true => active;\n }\n active => isMouseOpen => _mouseActive;\n return active;\n }\n\n function int openKeyboard(int num) {\n if (num < 0) {\n false => active;\n } else {\n \"virtualJS keyboard\" => deviceName;\n 3 => deviceType;\n true => active;\n }\n active => isKBDOpen => _kbdActive;\n return active;\n }\n\n // Pop the first HidMsg from the queue\n // Write it to msg and return 1\n function int recv(HidMsg msg) {\n // is empty\n if (_hidMsgQueue.size() <= 0) {\n return 0;\n }\n\n // pop the first HidMsg to msg, return true\n _hidMsgQueue[0] @=> HidMsg localMsg;\n msg._copy(localMsg); \n _hidMsgQueue.popFront();\n return 1;\n }\n\n // Hid Listener\n // Get variables from JS and write to the HidMsg \n function void _HidListener() {\n HidMsg @ msg;\n while(true){\n new HidMsg @=> msg;\n deviceType => msg.deviceType;\n _hid => now;\n\n _type => msg.type;\n _cursorX => msg.cursorX;\n _cursorY => msg.cursorY;\n _deltaX => msg.deltaX;\n _deltaY => msg.deltaY;\n _scaledCursorX => msg.scaledCursorX;\n _scaledCursorY => msg.scaledCursorY;\n _which => msg.which;\n _ascii => msg.ascii;\n _key => msg.key;\n\n _hidMsgQueue << msg;\n this.broadcast();\n }\n }\n spork ~ _HidListener();\n}\n"; +declare const HidMsg_ck = "\npublic class HidMsg {\n int type;\n int deviceType;\n int cursorX;\n int cursorY;\n float deltaX;\n float deltaY;\n float scaledCursorX;\n float scaledCursorY;\n int which;\n int ascii;\n string key;\n\n // type 1 message\n function int isButtonDown() {\n return type == 1;\n }\n\n // type 2 message\n function int isButtonUp() {\n return type == 2;\n }\n\n // type 5 message\n function int isMouseMotion(){\n return type == 5;\n }\n\n // type 6 message\n function int isWheelMotion(){\n return type == 6;\n }\n\n function void _copy(HidMsg localMsg) {\n localMsg.type => type;\n localMsg.deviceType => deviceType;\n localMsg.cursorX => cursorX;\n localMsg.cursorY => cursorY;\n localMsg.deltaX => deltaX;\n localMsg.deltaY => deltaY;\n localMsg.scaledCursorX => scaledCursorX;\n localMsg.scaledCursorY => scaledCursorY;\n localMsg.which => which;\n localMsg.ascii => ascii;\n localMsg.key => key;\n }\n}\n"; +declare const Hid_ck = "\nglobal Event _hid;\nglobal int _type;\nglobal int _mouseActive;\nglobal int _kbdActive;\n\nglobal int _cursorX;\nglobal int _cursorY;\nglobal float _deltaX;\nglobal float _deltaY;\nglobal float _scaledCursorX;\nglobal float _scaledCursorY;\n\nglobal int _ascii;\nglobal int _which;\nglobal string _key;\n\npublic class Hid extends Event {\n\n 0 => int isMouseOpen;\n 0 => int isKBDOpen;\n 0 => int active;\n\n string deviceName; \n int deviceType; // mouse = 2, keyboard = 3\n\n // HidMsg Queue\n HidMsg _hidMsgQueue[0];\n\n function string name() {\n return deviceName;\n }\n\n function int openMouse(int num) {\n if (num < 0) {\n false => active;\n } else {\n \"virtualJS mouse/trackpad\" => deviceName;\n 2 => deviceType;\n true => active;\n }\n active => isMouseOpen => _mouseActive;\n return active;\n }\n\n function int openKeyboard(int num) {\n if (num < 0) {\n false => active;\n } else {\n \"virtualJS keyboard\" => deviceName;\n 3 => deviceType;\n true => active;\n }\n active => isKBDOpen => _kbdActive;\n return active;\n }\n\n // Pop the first HidMsg from the queue\n // Write it to msg and return 1\n function int recv(HidMsg msg) {\n // is empty\n if (_hidMsgQueue.size() <= 0) {\n return 0;\n }\n\n // pop the first HidMsg to msg, return true\n _hidMsgQueue[0] @=> HidMsg localMsg;\n msg._copy(localMsg); \n _hidMsgQueue.popFront();\n return 1;\n }\n\n // Hid Listener\n // Get variables from JS and write to the HidMsg \n function void _HidListener() {\n HidMsg @ msg;\n while(true){\n new HidMsg @=> msg;\n deviceType => msg.deviceType;\n _hid => now;\n\n _type => msg.type;\n _cursorX => msg.cursorX;\n _cursorY => msg.cursorY;\n _deltaX => msg.deltaX;\n _deltaY => msg.deltaY;\n _scaledCursorX => msg.scaledCursorX;\n _scaledCursorY => msg.scaledCursorY;\n _which => msg.which;\n _ascii => msg.ascii;\n _key => msg.key;\n\n _hidMsgQueue << msg;\n this.broadcast();\n\n // Clear message type\n 0 => _type;\n }\n }\n spork ~ _HidListener();\n}\n"; export { HidMsg_ck, Hid_ck }; diff --git a/dist/hidCk.js b/dist/hidCk.js index 18e7e53..62c99c8 100644 --- a/dist/hidCk.js +++ b/dist/hidCk.js @@ -1,28 +1,4 @@ const HidMsg_ck = ` -global Event _msg; - -global Event _hid; -global int _hidMultiple; -0 => global int _cursorX; -0 => global int _cursorY; - -0 => global float _deltaX; -0 => global float _deltaY; - -global string _key; -global int _isDown; -global int _isUp; -global int _isMouseDown; -global int _isMouseUp; -global int _isScroll; -global int _ascii; -global int _which; -global int _mouseActive; -global int _kbdActive; -global int _mouseMotion; -global float _scaledCursorX; -global float _scaledCursorY; - public class HidMsg { int type; int deviceType; @@ -38,26 +14,22 @@ public class HidMsg { // type 1 message function int isButtonDown() { - if (type == 1) { return 1; } - return 0; + return type == 1; } // type 2 message function int isButtonUp() { - if (type == 2) { return 1; } - return 0; + return type == 2; } // type 5 message function int isMouseMotion(){ - if (type == 5) { return 1; } - return 0; + return type == 5; } // type 6 message function int isWheelMotion(){ - if (type == 6) { return 1; } - return 0; + return type == 6; } function void _copy(HidMsg localMsg) { @@ -76,29 +48,21 @@ public class HidMsg { } `; const Hid_ck = ` -global Event _msg; - global Event _hid; +global int _type; +global int _mouseActive; +global int _kbdActive; + global int _cursorX; global int _cursorY; - global float _deltaX; global float _deltaY; +global float _scaledCursorX; +global float _scaledCursorY; -global int _type; -global string _key; -global int _isDown; -global int _isUp; -global int _isMouseDown; -global int _isMouseUp; -global int _isScroll; global int _ascii; global int _which; -global int _mouseActive; -global int _kbdActive; -global int _mouseMotion; -global float _scaledCursorX; -global float _scaledCursorY; +global string _key; public class Hid extends Event { @@ -177,6 +141,9 @@ public class Hid extends Event { _hidMsgQueue << msg; this.broadcast(); + + // Clear message type + 0 => _type; } } spork ~ _HidListener(); diff --git a/docs/assets/search.js b/docs/assets/search.js index ad3f2fb..5f62a0e 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE72bW2+jyBLHv4v31eNN38DJ22jmzNnR7upEZ7W7D1YUEZvYKDZYQG6K5rtvd2PsKqhuMGTzFNmuqn91/aovEHib5NlzMblavE0eknQ1uWJ8Pp2k0S6eXE2+bB6XD5Pp5DHf6k/LbVQUcfGz/Xa2KXdb/dPhS/3z5Me0jsEv5ClIkialJ8ZPh99BoOlkH+VxWh4zOEVWjB8DL7O0KPPHZZnlvvjY7CRTFqtPSfFpnydPURn7RNkFl0fVVXwf53m8us6zXWIieaQJ2/fW/5I9pmXsLYDTY3Qu8ZM2+hJtt3fR8sFbiZbl+2r3qILDfnQeSfH/OFq9ejv8aDJEDU2mNH4pvxqe37/6FLHZaNVlHmvzb8k29k40aNVvOiOVbRatujSAzQCF/DH9kq28AieTIfHj/TZaxp0ayGyQzi57in+LirJbqmE5rGpdWE4mw+P/nZSbz/nau4y0TYdT6hwTMhun02tspPng7vhjo5f87taozQboJIV1/rwskydvJZuGA7SKZJ1G2/+YNdynhM0G6NzleoFZ6unSKdWyHLLiJUUZp9+y3Mb4X7r0r32U9ZBallFe/maDJem6juctq8tjkHq2P1OcdhiiHZffO8RqiwHR153R1yOi68y+6d2vK/vaZlj+nQrrUQo6vz/KXGPsGMTRaNgoujXW4zSqLvmc55H33IfNBndUp856rA5I9K9o++hdhQjbcSPrVCRsh43xc1FkyyQyu9A5w/W4DRv5kDz8biPWkz5djAxHrCx9OnmsFkq3D9629dgR9oH5Lqq4Oc8bttdxdF+fV4z3zkUP7zrKo133Zg/Mho25j856rE6daJ8DADIcMaY+R4GxWnW6vQ4F2HLEyHodD0arpdmz9w6N/XlA3OU2jnJr8T3V5/KOawbSeqjqf7fZXbT1XsQ27IYomR+vdd29zYes+qnAG9u/ELfP9Hcjb2rXEfy3tI22415iuYnpW+7HyMCiz109j9ZD/LqL9m6l4+/jdYrrPNYh2ncjoBgwGqm4yx6L+Dpr9+lRDlicrxUoJYKj2O1t+bpvT8GW1Oxo6OyK2TEtx8BeesvMXnoJ1Uk59NpHNaee+7B2hp72L73cTgb/NraD0iHhT8w7vDqt87E1ZWYv/aSGg2spvr6L4q1F7LgVeBRvWI2c57cPd66bjydFaDNS7y57TFe/ROlqG/9uxvF75lN2WP/bjUvJ1rC5FzSZcM9SfM2e0/45Haw/uhRGti6FOKsUNuGepfjTs6eSth9dhj/3dRHkWUXQyfYswd+bON72T6g2/+hCWN26FuqsWlQpd5fj1/i199Q42X5gIQ6idRWCvlWok+1Vgp5Torb82OGfpkN4xuDRZEBXBnEa3R26xJ0CNupznYA0VknRQ6RhdbZKlaQe7F0W5Z7De8tu6Hi6pdqGHq2bqb5MW8Uvk6u3yVOcF0mW6p/4TMwute19Em9X5sGnKgkdKdvtjPfN4be/YvPIkLGoTH6+mEwXF1N5MRMhv7mZLmoP+4P9wprp49SCTYWa8UAiM4bM9Ga84FQ0jsz0RrUQlJlAZnopX0jKTCIzvcotFGWmkJleBhYBZRYgMz1hFiFlFiKzuf40p8zmyExDWVxSZpe4vKbajOTAGiAsCUZaYhbM1JyRNBjGwUzZGQmEYSLMVJ6RTBiGwkzxGYmFYS7M1J+RZBhGwwwCRsJhmA4zFBjJh2FAzIBgJCKGGXEDgpOMOGbEDQhOMuKN+WInDD1jMCNuQHCSEceMuAHBSUYcM+IGBCcZccyIGxCcZMQxI25AcJIRx4y4AcFJRhwz4gYEJxlxzEgYEIJkJDAjYUAIkpHAjIQBIUhGorGs2XWNXtgwI2FACJKRwIyEASFIRgIzEgaEIBkJzEgYEIJkJDAjYUAIkpHAjIQBIUhGAjOSBoQkGUnMSBoQkmQkMSNpQEiSkcSMpAEhSUaysfvY7YfefzAjaUBIkpHEjKQBIUlGEjOSBoQkGUnMSBoQkmQkMSNpQEiSkcSMlAGhSEYKM1IGhCIZKcxIGRCKZKQwI2VAKJKRwoyUdJ1LVOOMYA8JJEyFESnDQdHnCYxIGQ6KhKkwImU4KBKmwoiU4aDmUy5mFzzAlhhRYBFdUmMPMKLAcAguSEuMKDAcAhJmgBEFwplngBEF0p0nZhQod56No5w9y5GtFGBGgQERkK0UYEaBARGQHRJgRoGbUYAZhQZEQPZSiBmFzBkzxIxCy4jsuhAzCt2MQswoNCAC+tSLGYXKHRMzCi0jclkKGyfu0B0TMwotI3IBCzGj0M0oxIzmBkRILnVzzGhuQITk7JhjRnMDIiT7c44ZzQ2IkOzPecXIXvDpK70yXn2vLvz0pVt9N+Btcnu4GlTHC8+3iV4prt5+TCd6JlZ/D591J1V/D99rYtXf8PDX2v04XTWaTyYlc8M5OtxwPknqaXWUDEKXq707Tjhz4Bw4nO3tiY29PfEQv67sjSQQAgw57BficY8CXIIA8+4AdiitLBQIctEzyC5rVEOCavTNpDGYAOTBe4Z4ru5SgighiCJdUeqnhOPqqdWTu77oObpz5nBfVv/rPXldnJxcBbQ+++pf46DpQRMp15jtf++tf3J8WgCEAOLKqW5CrOsHAIAzGK5yDhe+qgVKBSrl8rTvntzbZ/VPjqBpXfO1fjlqX70ctaxfDDoFAf3motwIggYOZr5wuVd3tR6Od7VO3iFwn3f476obfcAZ1Hzuqnl1947UBnWfuwpfubelQa/MXb1i58Ty8EoWUXkwTV1rFgqBGw70m8N5HZfR6cmze/McU2SePHuqnjwDLQAqIV2VwNH09KNjCTAq4RqWjnVfPVYFZgFYw7lr4asdo+oBSiALvEUv73YVAFPpYqpDNFYeDgbMPQOuK4ayBoUXnsK7qw1mr3BNXx1gbx73apVcgtSlJ3Xr3Ri2hOtGl3JxeNAMuANe0sOr7SkAJuHCtEnQVFdgmVGuZaZ6qunkBFaXw2lJucaZFHn1BiRYIcDu6fQqzHtD7RMRAws7c63s9QNMYJRwTXDhNI8i7etHkYAvaAXlStg8K7HP0DIUgCoFrg6u3uy5z3K7nGWNfZfD/c8ZQp8zmtsfA53AXJ1gl+5G0grAUa7mM++Y2o0PtxLoW6enefYRtDqgKV00q7fVTIGX9kVGMErQu8zVu5V7Ub3sBnxBtsyV7uHFvJYuwMJcWA6+LTKgm5irE4Hvc1JuIvtCIIgBIDFXR+aPaStvOG9dpwLt18oZLGjMNdEPfmS+YPYx15Zc9N6SwSikaxRFzy0ZZCY8mbW3ZICAuxAUzi0ZeIte3u3MwdQRrqlTtLdkMGDuGTC5JYPCC0/h3dWGJ2LXfC2cWzJIXXpSJ7dkoCy7lIktGfCSHl5tTw4wcScm++5q+zoRLOLctYjbFzS39UuS9UaCwoCxc+fYy2zvjwLWAO5aA8pN3LpuVcBRubC9IA9Qs+CiOl8ELknUoQGoWHA4mQSk5s10sk/28TZJtfHi5sePfwBVg/YXDkUAAA=="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE72b3W+jxhbA/xffV2+a+cJO3la73XZ1W93Vrdo+WNGK2MRGwWABThpF+d87M4A5x5wZMKzyFDmc79+ZDwZ4neXZczG7Xb3OHuN0M7tlfDmfpeE+mt3OPu2O68fZfHbME/1rnYRFERU/2f9e7cp9oi/V/9SXZ2/zxga/lq2ROI1Lj43/1NeBofnsEOZRWp4iaC0rxk+G11lalPlxXWa5zz4Wa92UxeZDXHw45PFTWEY+p+yay5PXTfQQ5Xm0+ZZn+9hY8rgmZH+0/0/ZMS0jbwGcGpNjiZ600KcwSe7D9aO3Eh3JH+t7QBUc8pPjiIv/R+HmxdvhJ5Ex3tBgSqN/ys+G59fPPo9YbLLXdR5p8S9xEnkHGpQaNpyRlyQLN30+gMwID/kx/ZRtvA5akTH2o0MSrqNeH0hslJ999hT9FhZlv6szyXFV68PSioy3/3dc7j7mW+800hUdT6k3JyQ2zc+g3Ejx0d3xx05P+f2t0YiN8BMXVvnjuoyfvJU8Fxzhq4i3aZj8bOZwnycsNsLPfa4nmLUeLr2uOpJjZry4KKP0S5ZbG/9L1/65j5IeU8syzMvfrLE43Tb2vGV1aYzynh0udE4rjPEdlV97nDUSI6xve61vJ1jXkX3Rq19f9I3MuPh7PWwnedDx/VHmGmNPEiehcVn0+9hO81F1ycc8D737Piw2uqN6/Wyn+gGB/hUmR+8sRMhOy6zXIyE7LsePRZGt49CsQpek61Ebl/mYOPxqE+aTIV2MBCfMLEM6eaovFO4QvF3pqRkOgflDvOLmvCxtr+Lkvr6sGD86Fp3etzAP9/2LPRAbl/MQP9upfppAh2wAkOCEnIZsBab6asIdtCnAkhMyG7Q9mOwtzZ69JzT28gi76yQKcyvxNdX78p57BlJ6rNdfkuw+TLw3sWdyYzyZi9903b3Nh6SGeYEH278Sx2f6fxMPtRsL/iNt49txlljuIvrI/WQZSAw51fP4eoxe9uHB7el0faKf7/vsWESOQ4KTtzOpqT4f713HEq1HKDPR3312TDe/hukmiX43efye+Tw7pC+PIVBKBG3S38uXw4Vur05Kzl69IsMdWIjP2XM6PKJa+r0LYdzWhfjALiqFDXhgKf70jDVS9r3L8OehKQK/qAg62IEl+HsXRcnwgBrx9y6E9dvUQlxUiyrk/nL8N3oZPDRa2XcsRO20qYIcWoUm2EElGDgkGsn3Tb8dDuqC5NFgQDuGKA3v6y5xh4CFhuwfkI9NXAxwciZ1sZcqSJ3sfRbm3UcMZ8kAubH59LvqCnp83c319m0T/TO7fZ09RXkRZ6m+xK/E1Y2WfYijZGNeiKiC0Jay/d5o39XX/orMqwRGohL56Xo2X13Pxc0VV+Lubr5qNOwF+w8rppeWFZsLecWkRGIMienJd8UpaxyJ6XlpJSgxgcT0wF1JSkwiMd3iK0WJKSQW6F8BJRYgsYX+taDEFkhsqX8tKbElEtNQVjeU2A0ur6k2IzmwMxCWBCMlMQtmas5IGgzjYKbsjATCMBFmKs9IJgxDYab4jMTCMBdm6s9IMgyjYQYBI+EwTIcZCozkwzAgZkAwEhHDjLgBwUlGHDPiBgQnGfGz8WIHDD1iMCNuQHCSEceMuAHBSUYcM+IGBCcZccyIGxCcZMQxI25AcJIRx4y4AcFJRhwz4gYEJxlxzEgYEIJkJDAjYUAIkpHAjIQBIUhG4mxas/MaPbFhRsKAECQjgRkJA0KQjARmJAwIQTISmJEwIATJSGBGwoAQJCOBGQkDQpCMBGYkDQhJMpKYkTQgJMlIYkbSgJAkI4kZSQNCkozk2epjlx96/cGMpAEhSUYSM5IGhCQZScxIGhCSZCQxI2lASJKRxIykASFJRhIzUgaEIhkpzEgZEIpkpDAjZUAokpHCjJQBoUhGCjNS0rUvUWd7BLtJIGEqjEgZDoreT2BEynBQJEyFESnDQZEwFUakDAdFwlQYUWAR3cy5vFLLG7yhwYgCwyEgYQYYUcDdNjGiwHAISOwBRhRIt03MKDAgArJBgrOtXOC2iRkFBkRAtlKAGQVLt03MKDAgArKXAsxo4Wa0wIwWlhHZdQvMaGFABGTXLTCjhWVE72Uxo4UBEZBdt6gY2dsOfb9RRpuv1e2HvoFo7klfZ9/rexKda3378zrTXXj7+jaf6c6p/sr6b1D/XVZ/F1burb1XMb9MCOaQM6wPOYGLRetCLV2q9kSWUA6A8sKhbG+Kd/am+DF62djji9aEbqY2xWEmjgdkQAIDN/0GbCqdKK6BETbQyD47q8YSVGNoJGfJMBCHGGjiuTobA1Y4sKJcVpp31qLqHapWnYMguKsY6+rJQ6sFKujqQKtzqB7UgLKBaBV3qZpnSVY/Pj27AiaAc+X0bkxsm8dRQBmkq5zpwg8HQKlApVya9k3oB/vmaKsIBrarU5pX9Q/Vq/rr5jX11gjofDnMCEocjDxXq9VnKY+nsxTQZKDbF073lf6+Ol4CymDiWLgqV50Zkb7BpLVwxV6pd10roOvCbcfEuv5AgKg8CD8YYgI3HOg3h/I2KsP2PYgH81Q9NO9BPFXvQYAWAB0oXYXE1vTwo20JkJVwpaVtPVQP+cEoAK3AXWtIoxhWr/MAt0BbDNLuVgGMf+ka/9rE2czDQcLck3BTMRQ1KLzwFN5dbTB6hWv8aAMH8/JBp+QShC49oVvts7QlnDf6PBf1aw9AHfCSHl5dTQEwCRemXYyGugKzlHIN9eoZe6sEZnRW7YqUK8+4yKvvcVptOLk4tQrzFnt3R8TAxM5cM3vzOB1kCecEF87qne+HLLdTS3a2BnK4Frka0nwyc74UMUCFuaiYj4jsWoLpgFZwdYJ9uQV0DyiQdBWo+hwh0ZuTtf1SBQQL2oG52qFSL6qvGYAuiJa5wq2/vOj4BdVlrurWup0Cg7HKXHCB7nNc7kL7xQewAZqSuboyP6aduOFQcK12Wq8TM5gjmGvs1HpkvKChmWuVKwavciAL6cqiGLjKgciEJ7LuKgcQcBeCwrnKAW0xSLsbORg6wjV0iu4qBxLmnoTJVQ4UXngK76423GS6xmvhXOVA6NITOrnKAc+yzzOxygFe0sOrq8kBJu7EZD9O6t56gbmYu+Zi+wVO0nwF06wHyAzInTtzL7OD3wqYA7hrDih3UedWUAFFRWK7m88O8SFK4lQLre7e3v4Fxz7QE3s+AAA="; \ No newline at end of file diff --git a/docs/classes/Chuck.html b/docs/classes/Chuck.html index 8f947ec..879d733 100644 --- a/docs/classes/Chuck.html +++ b/docs/classes/Chuck.html @@ -27,7 +27,7 @@

Hierarchy

+
  • Defined in src/Chuck.ts:30
    • @@ -145,34 +145,34 @@

    Returns

    +
  • Defined in src/Chuck.ts:48

    • Properties

    Private deferredPromises

    deferredPromises: DeferredPromisesMap = {}
    +
  • Defined in src/Chuck.ts:31

    • Private deferredPromiseCounter

    deferredPromiseCounter: number = 0
    +
  • Defined in src/Chuck.ts:32

    • Private eventCallbacks

    eventCallbacks: EventCallbacksMap = {}
    +
  • Defined in src/Chuck.ts:33

    • Private eventCallbackCounter

    eventCallbackCounter: number = 0
    +
  • Defined in src/Chuck.ts:34

    • Private isReady

    isReady: default<void> = ...
    +
  • Defined in src/Chuck.ts:35

    • onprocessorerror

    onprocessorerror: null | ((this, ev) => any)
    @@ -291,7 +291,7 @@

    Example

    // Initialize
    +
  • Defined in src/Chuck.ts:108

    • Private nextDeferID

    +
  • Defined in src/Chuck.ts:146

    • createFile

    +
  • Defined in src/Chuck.ts:161

    • loadFile

    +
  • Defined in src/Chuck.ts:177

    • runCode

    +
  • Defined in src/Chuck.ts:207

    • replaceCode

    +
  • Defined in src/Chuck.ts:237

    • removeLastCode

    +
  • Defined in src/Chuck.ts:276

    • runFile

    +
  • Defined in src/Chuck.ts:296

    • runFileWithArgs

    +
  • Defined in src/Chuck.ts:331

    • replaceFile

    +
  • Defined in src/Chuck.ts:371

    • replaceFileWithArgs

    +
  • Defined in src/Chuck.ts:414

    • removeShred

    +
  • Defined in src/Chuck.ts:463

    • isShredActive

    +
  • Defined in src/Chuck.ts:477

    • signalEvent

    +
  • Defined in src/Chuck.ts:491

    • broadcastEvent

    +
  • Defined in src/Chuck.ts:499

    • listenForEventOnce

    +
  • Defined in src/Chuck.ts:510

    • startListeningForEvent

    +
  • Defined in src/Chuck.ts:528

    • stopListeningForEvent

    +
  • Defined in src/Chuck.ts:544

    • setInt

    +
  • Defined in src/Chuck.ts:558

    • getInt

    +
  • Defined in src/Chuck.ts:568

    • setFloat

    +
  • Defined in src/Chuck.ts:582

    • getFloat

    +
  • Defined in src/Chuck.ts:591

    • setString

    +
  • Defined in src/Chuck.ts:605

    • getString

    +
  • Defined in src/Chuck.ts:614

    • setIntArray

    +
  • Defined in src/Chuck.ts:629

    • getIntArray

    +
  • Defined in src/Chuck.ts:638

    • setIntArrayValue

    +
  • Defined in src/Chuck.ts:653

    • getIntArrayValue

    +
  • Defined in src/Chuck.ts:667

    • setAssociativeIntArrayValue

    +
  • Defined in src/Chuck.ts:685

    • getAssociativeIntArrayValue

    +
  • Defined in src/Chuck.ts:700

    • setFloatArray

    +
  • Defined in src/Chuck.ts:716

    • getFloatArray

    +
  • Defined in src/Chuck.ts:726

    • setFloatArrayValue

    +
  • Defined in src/Chuck.ts:741

    • getFloatArrayValue

    +
  • Defined in src/Chuck.ts:756

    • setAssociativeFloatArrayValue

    +
  • Defined in src/Chuck.ts:774

    • getAssociativeFloatArrayValue

    +
  • Defined in src/Chuck.ts:789

    • setParamInt

    +
  • Defined in src/Chuck.ts:806

    • getParamInt

    +
  • Defined in src/Chuck.ts:815

    • setParamFloat

    +
  • Defined in src/Chuck.ts:829

    • getParamFloat

    +
  • Defined in src/Chuck.ts:837

    • setParamString

    +
  • Defined in src/Chuck.ts:851

    • getParamString

    +
  • Defined in src/Chuck.ts:860

    • now

    +
  • Defined in src/Chuck.ts:874

    • clearChuckInstance

    +
  • Defined in src/Chuck.ts:884

    • clearGlobals

    +
  • Defined in src/Chuck.ts:891

    • chuckPrint

    +
  • Defined in src/Chuck.ts:912

    • addEventListener

      diff --git a/docs/classes/HID.html b/docs/classes/HID.html index e6ad8e5..9fdf922 100644 --- a/docs/classes/HID.html +++ b/docs/classes/HID.html @@ -15,12 +15,23 @@
    • webchuck
    • HID

    Class HID

    +
    +

    Introducing HID (Human Interface Device) support for WebChucK. HID wraps +JavaScript mouse/keyboard event listeners enabling mouse and keyboard +communication with the native HID +class in ChucK.

    +

    To get started with HID:

    +
    +
    +

    Example

    import { Chuck, HID } from "webchuck";

    const theChuck = await Chuck.init([]);
    const hid = await HID.init(theChuck); // Initialize HID with mouse and keyboard
+
    +

    Hierarchy

    • HID
    +
  • Defined in src/Hid.ts:27
    • @@ -30,9 +41,6 @@
    theChuck keymap -keysPressed -mousePos -lastPos _mouseActive _kbdActive boundHandleMouseMove @@ -56,51 +64,22 @@

    Properties

    Private theChuck

    theChuck: Chuck
    +
  • Defined in src/Hid.ts:29

    • Private keymap

    keymap: boolean[]
    -
    -

    Private keysPressed

    -
    keysPressed: number = 0
    -
    -

    Private mousePos

    -
    mousePos: {
        x: number;
        y: number;
    }
    -
    -

    Type declaration

    -
      -
    • -
      x: number
      • -
    • -
      y: number
    -
    -

    Private lastPos

    -
    lastPos: {
        x: number;
        y: number;
    }
    -
    -

    Type declaration

    -
      -
    • -
      x: number
      • -
    • -
      y: number
    +
  • Defined in src/Hid.ts:30

    • Private _mouseActive

    _mouseActive: boolean = false
    +
  • Defined in src/Hid.ts:31

    • Private _kbdActive

    _kbdActive: boolean = false
    +
  • Defined in src/Hid.ts:32

    • Private boundHandleMouseMove

    boundHandleMouseMove: {}
    @@ -110,7 +89,7 @@

    Type declaration

      • +
    • Defined in src/Hid.ts:35

      • Private boundHandleMouseDown

      boundHandleMouseDown: {}
      @@ -120,7 +99,7 @@

      Type declaration

        • +
      • Defined in src/Hid.ts:36

        • Private boundHandleMouseUp

        boundHandleMouseUp: {}
        @@ -130,7 +109,7 @@

        Type declaration

          • +
        • Defined in src/Hid.ts:37

          • Private boundHandleMouseWheel

          boundHandleMouseWheel: {}
          @@ -140,7 +119,7 @@

          Type declaration

            • +
          • Defined in src/Hid.ts:38

            • Private boundHandleKeyDown

            boundHandleKeyDown: {}
            @@ -150,7 +129,7 @@

            Type declaration

              • +
            • Defined in src/Hid.ts:39

              • Private boundHandleKeyUp

              boundHandleKeyUp: {}
              @@ -160,7 +139,7 @@

              Type declaration

                • +
              • Defined in src/Hid.ts:40

                • Methods

                @@ -168,7 +147,7 @@

                Static
              • -

                Initialize HID functionality in your WebChucK instance. +

                Initialize HID functionality in your WebChucK instance. This adds a Hid and HidMsg class to the ChucK Virtual Machine (VM). Mouse and keyboard event listeners are added if enableMouse and enableKeyboard are true (default).

                @@ -192,21 +171,22 @@
                enableKeyboard:

                • Returns Promise<HID>

                -

                Example

                theChuck = await Chuck.init(); // Initialize WebChucK
                hid = await HID.init(theChuck); // Initialize HID with mouse and keyboard
+
                Example
                theChuck = await Chuck.init([]);
                hid = await HID.init(theChuck); // Initialize HID with mouse and keyboard
 
                
 
-
                Example
                theChuck = await Chuck.init(); // Initialize WebChucK
                hid = await HID.init(theChuck, false, true); // Initialize HID, no mouse, only keyboard
+
                Example
                theChuck = await Chuck.init([]);
                hid = await HID.init(theChuck, false, true); // Initialize HID, no mouse, only keyboard

                +
              • Defined in src/Hid.ts:75

                • enableMouse

                • -

                  Enable Mouse HID Javascript event listeners to communicate with ChucK -Adds a mousemove, mousedown, mouseup, and wheel listener to the document.

                  +

                  Enable Mouse HID Javascript event listeners for HID. +Adds a mousemove, mousedown, mouseup, and wheel listener to the document. +This will also disable the context menu on right click.

                  Returns void

                  @@ -214,7 +194,7 @@

                  Example

                  // If mouse HI
                +
              • Defined in src/Hid.ts:136

                • disableMouse

                  @@ -228,13 +208,13 @@

                  Example

                  // If mouse HI
                +
              • Defined in src/Hid.ts:152

                • enableKeyboard

                • -

                  Enable keyboard HID Javascript event listeners to communicate with ChucK. +

                  Enable keyboard HID Javascript event listeners for HID. Adds a keydown and keyup listener to the document.

                  Returns void

                  @@ -243,7 +223,7 @@

                  Example

                  // If keyboard
                +
              • Defined in src/Hid.ts:169

                • disableKeyboard

                  @@ -257,7 +237,7 @@

                  Example

                  // If keyboard
                +
              • Defined in src/Hid.ts:182
                • @@ -277,9 +257,6 @@

                theChuck
              • keymap
                • -
              • keysPressed
                • -
              • mousePos
                • -
              • lastPos
              • _mouseActive
              • _kbdActive
              • boundHandleMouseMove
                • diff --git a/src/Hid.ck b/src/Hid.ck deleted file mode 100644 index e0b2553..0000000 --- a/src/Hid.ck +++ /dev/null @@ -1,105 +0,0 @@ -global Event _msg; - -global Event _hid; -global int _hidMultiple; -global int _cursorX; -global int _cursorY; - -global float _deltaX; -global float _deltaY; - -global int _type; -global string _key; -global int _isDown; -global int _isUp; -global int _isMouseDown; -global int _isMouseUp; -global int _isScroll; -global int _ascii; -global int _which; -global int _mouseActive; -global int _kbdActive; -global int _mouseMotion; -global float _scaledCursorX; -global float _scaledCursorY; - -public class Hid extends Event { - - 0 => int isMouseOpen; - 0 => int isKBDOpen; - 0 => int active; - - string deviceName; - int deviceType; // mouse = 2, keyboard = 3 - - // HidMsg Queue - HidMsg _hidMsgQueue[0]; - - function string name() { - return deviceName; - } - - function int openMouse(int num) { - if (num <= 0) { - false => active; - } else { - "virtualJS mouse/trackpad" => deviceName; - 2 => deviceType; - true => active; - } - active => isMouseOpen => _mouseActive; - return active; - } - - function int openKeyboard(int num) { - if (num <= 0) { - false => active; - } else { - "virtualJS keyboard" => deviceName; - 3 => deviceType; - true => active; - } - active => isKBDOpen => _kbdActive; - return active; - } - - // Pop the first HidMsg from the queue - // Write it to msg and return 1 - function int recv(HidMsg msg) { - // is empty - if (_hidMsgQueue.size() <= 0) { - return 0; - } - - // pop the first HidMsg to msg, return true - _hidMsgQueue[0] @=> msg; - _hidMsgQueue.erase(0); // TODO: update this to popFront(); - return 1; - } - - // Hid Listener - // Get variables from JS and write to the HidMsg - function void _HidListener() { - HidMsg @ msg; - while(true){ - new HidMsg @=> msg; - deviceType => msg.deviceType; - _hid => now; - - _type => msg.type; - _cursorX => msg.cursorX; - _cursorY => msg.cursorY; - _deltaX => msg.deltaX; - _deltaY => msg.deltaY; - _scaledCursorX => msg.scaledCursorX; - _scaledCursorY => msg.scaledCursorY; - _which => msg.which; - _ascii => msg.ascii; - _key => msg.key; - - _hidMsgQueue << msg; - this.broadcast(); - } - } - spork ~ _HidListener(); -} \ No newline at end of file diff --git a/src/Hid.ts b/src/Hid.ts index 0738422..04372d4 100644 --- a/src/Hid.ts +++ b/src/Hid.ts @@ -1,12 +1,33 @@ import Chuck from "./Chuck"; import { Hid_ck, HidMsg_ck } from "./hidCk"; +enum HidMsgType { + BUTTON_DOWN = 1, + BUTTON_UP = 2, + MOUSE_MOTION = 5, + WHEEL_MOTION = 6, +} + +//TODO: Update the latest mouse.ck and kb.ck files +/** + * Introducing HID (Human Interface Device) support for WebChucK. HID wraps + * JavaScript mouse/keyboard event listeners enabling mouse and keyboard + * communication with the native {@link https://chuck.stanford.edu/doc/reference/io.html#Hid | HID} + * class in ChucK. + * + * To get started with HID: + * @example + * ```ts + * import { Chuck, HID } from "webchuck"; + * + * const theChuck = await Chuck.init([]); + * const hid = await HID.init(theChuck); // Initialize HID with mouse and keyboard + * ``` + */ export default class HID { // Private members private theChuck: Chuck; private keymap: Array; - private mousePos: { x: number; y: number }; - private lastPos: { x: number; y: number }; private _mouseActive: boolean = false; private _kbdActive: boolean = false; @@ -23,8 +44,6 @@ export default class HID { // Initialize members this.theChuck = theChuck; this.keymap = new Array(256).fill(false); - this.mousePos = { x: 0, y: 0 }; - this.lastPos = { x: 0, y: 0 }; // Bind handlers this.boundHandleMouseMove = this.handleMouseMove.bind(this); @@ -34,18 +53,19 @@ export default class HID { this.boundHandleKeyDown = this.handleKeyDown.bind(this); this.boundHandleKeyUp = this.handleKeyUp.bind(this); } + /** - * Initialize HID functionality in your WebChucK instance. + * Initialize HID functionality in your WebChucK instance. * This adds a `Hid` and `HidMsg` class to the ChucK Virtual Machine (VM). * Mouse and keyboard event listeners are added if `enableMouse` and `enableKeyboard` are true (default). * @example * ```ts - * theChuck = await Chuck.init(); // Initialize WebChucK + * theChuck = await Chuck.init([]); * hid = await HID.init(theChuck); // Initialize HID with mouse and keyboard * ``` * @example * ```ts - * theChuck = await Chuck.init(); // Initialize WebChucK + * theChuck = await Chuck.init([]); * hid = await HID.init(theChuck, false, true); // Initialize HID, no mouse, only keyboard * ``` * @param theChuck WebChucK instance @@ -96,7 +116,7 @@ export default class HID { * @param mouseEvent Mouse event * @returns mouse position */ - getMousePos(mouseEvent: MouseEvent) { + getMousePos(mouseEvent: MouseEvent): { x: number; y: number } { return { x: mouseEvent.clientX, y: mouseEvent.clientY, @@ -104,8 +124,9 @@ export default class HID { } /** - * Enable Mouse HID Javascript event listeners to communicate with ChucK + * Enable Mouse HID Javascript event listeners for HID. * Adds a mousemove, mousedown, mouseup, and wheel listener to the document. + * This will also disable the context menu on right click. * @example * ```ts * // If mouse HID is not yet enabled @@ -117,6 +138,7 @@ export default class HID { document.addEventListener("mousedown", this.boundHandleMouseDown); document.addEventListener("mouseup", this.boundHandleMouseUp); document.addEventListener("wheel", this.boundHandleMouseWheel); + document.addEventListener("contextmenu", HID.handleContextMenu); } /** @@ -132,10 +154,11 @@ export default class HID { document.removeEventListener("mousedown", this.boundHandleMouseDown); document.removeEventListener("mouseup", this.boundHandleMouseUp); document.removeEventListener("wheel", this.boundHandleMouseWheel); + document.removeEventListener("contextmenu", HID.handleContextMenu); } /** - * Enable keyboard HID Javascript event listeners to communicate with ChucK. + * Enable keyboard HID Javascript event listeners for HID. * Adds a keydown and keyup listener to the document. * @example * ```ts @@ -168,73 +191,59 @@ export default class HID { //----------- MOUSE --------- // /** @internal */ - handleMouseMove(e: MouseEvent) { + private handleMouseMove(e: MouseEvent) { this.mouseActive(); if (this._mouseActive) { - this.mousePos = this.getMousePos(e); - this.theChuck.setInt("_mouseMotion", 1); - this.theChuck.broadcastEvent("_hid"); - this.theChuck.setInt("_mouseX", this.mousePos.x); - this.theChuck.setInt("_mouseY", this.mousePos.y); + const mousePos = this.getMousePos(e); this.theChuck.setFloat("_deltaX", e.movementX); this.theChuck.setFloat("_deltaY", e.movementY); - this.theChuck.setFloat( - "_scaledCursorX", - this.mousePos.x / document.documentElement.clientWidth, - ); - this.theChuck.setFloat( - "_scaledCursorY", - this.mousePos.y / document.documentElement.clientHeight, - ); - this.theChuck.broadcastEvent("_msg"); + this.theChuck.setFloat("_scaledCursorX", mousePos.x / document.documentElement.clientWidth); + this.theChuck.setFloat("_scaledCursorY", mousePos.y / document.documentElement.clientHeight); + this.theChuck.setInt("_type", HidMsgType.MOUSE_MOTION); + this.theChuck.broadcastEvent("_hid"); } - this.lastPos = this.mousePos; } /** @internal */ - handleMouseDown(e: MouseEvent) { + private handleMouseDown(e: MouseEvent) { this.mouseActive(); if (this._mouseActive) { - this.theChuck.setInt("_mouseMotion", 0); - - this.theChuck.setInt("_mouseDown", 1); - this.theChuck.broadcastEvent("_hid"); - this.theChuck.setInt("_hidMouse", 1); this.theChuck.setInt("_which", e.which); - this.theChuck.broadcastEvent("_msg"); + this.theChuck.setInt("_type", HidMsgType.BUTTON_DOWN); + this.theChuck.broadcastEvent("_hid"); } } /** @internal */ - handleMouseUp(e: MouseEvent) { + private handleMouseUp(e: MouseEvent) { this.mouseActive(); if (this._mouseActive) { - this.theChuck.setInt("_mouseMotion", 0); - this.theChuck.setInt("_mouseUp", 1); - this.theChuck.broadcastEvent("_hid"); - this.theChuck.setInt("_hidMouse", 1); this.theChuck.setInt("_which", e.which); - this.theChuck.broadcastEvent("_msg"); + this.theChuck.setInt("_type", HidMsgType.BUTTON_UP); + this.theChuck.broadcastEvent("_hid"); } } /** @internal */ - handleMouseWheel(e: WheelEvent) { + private handleMouseWheel(e: WheelEvent) { this.mouseActive(); if (this._mouseActive) { - this.theChuck.setInt("_mouseMotion", 0); - this.theChuck.setInt("_isScroll", 1); - this.theChuck.setInt("_deltaX", clamp(e.deltaX, -1, 1)); - this.theChuck.setInt("_deltaY", clamp(e.deltaY, -1, 1)); + this.theChuck.setFloat("_deltaX", clamp(e.deltaX, -1, 1)); + this.theChuck.setFloat("_deltaY", clamp(e.deltaY, -1, 1)); + this.theChuck.setInt("_type", HidMsgType.WHEEL_MOTION); this.theChuck.broadcastEvent("_hid"); - this.theChuck.broadcastEvent("_msg"); } } + /** @internal */ + private static handleContextMenu(e: MouseEvent) { + e.preventDefault(); + } + //----------- KEYBOARD --------- // /** @internal */ - handleKeyDown(e: KeyboardEvent) { + private handleKeyDown(e: KeyboardEvent) { this.kbdActive(); if (this._kbdActive && !this.keymap[e.keyCode]) { this.keymap[e.keyCode] = true; @@ -243,7 +252,7 @@ export default class HID { } /** @internal */ - handleKeyUp(e: KeyboardEvent) { + private handleKeyUp(e: KeyboardEvent) { this.kbdActive(); if (this._kbdActive) { this.keymap[e.keyCode] = false; @@ -257,11 +266,11 @@ export default class HID { * @param e Keyboard event * @param isDown Is key down */ - keyPressManager(e: KeyboardEvent, isDown: boolean): void { + private keyPressManager(e: KeyboardEvent, isDown: boolean): void { this.theChuck.setString("_key", e.key); this.theChuck.setInt("_which", e.which); this.theChuck.setInt("_ascii", e.keyCode); - this.theChuck.setInt("_type", isDown ? 1 : 2); + this.theChuck.setInt("_type", isDown ? HidMsgType.BUTTON_DOWN : HidMsgType.BUTTON_UP); this.theChuck.broadcastEvent("_hid"); } } @@ -274,7 +283,7 @@ export default class HID { * @param val value to clamp * @param min min value * @param max max value - * @returns clamp value + * @returns clamped value */ function clamp(val: number, min: number, max: number): number { return Math.min(Math.max(val, min), max); diff --git a/src/HidMsg.ck b/src/HidMsg.ck deleted file mode 100644 index cffcff7..0000000 --- a/src/HidMsg.ck +++ /dev/null @@ -1,71 +0,0 @@ -global Event _msg; - -global Event _hid; -global int _hidMultiple; -0 => global int _cursorX; -0 => global int _cursorY; - -0 => global float _deltaX; -0 => global float _deltaY; - -global string _key; -global int _isDown; -global int _isUp; -global int _isMouseDown; -global int _isMouseUp; -global int _isScroll; -global int _ascii; -global int _which; -global int _mouseActive; -global int _kbdActive; -global int _mouseMotion; -global float _scaledCursorX; -global float _scaledCursorY; - -public class HidMsg { - int type; - int deviceType; - int cursorX; - int cursorY; - float deltaX; - float deltaY; - float scaledCursorX; - float scaledCursorY; - int which; - int ascii; - string key; - - // type 1 message - function int isButtonDown() { - return type == 1; - } - - // type 2 message - function int isButtonUp() { - return type == 2; - } - - // type 5 message - function int isMouseMotion(){ - return type == 5; - } - - // type 6 message - function int isWheelMotion(){ - return type == 6; - } - - function void _copy(HidMsg localMsg) { - localMsg.type => type; - localMsg.deviceType => deviceType; - localMsg.cursorX => cursorX; - localMsg.cursorY => cursorY; - localMsg.deltaX => deltaX; - localMsg.deltaY => deltaY; - localMsg.scaledCursorX => scaledCursorX; - localMsg.scaledCursorY => scaledCursorY; - localMsg.which => which; - localMsg.ascii => ascii; - localMsg.key => key; - } -} \ No newline at end of file diff --git a/src/hidCk.ts b/src/hidCk.ts index ac75a92..1a36c95 100644 --- a/src/hidCk.ts +++ b/src/hidCk.ts @@ -1,28 +1,4 @@ const HidMsg_ck = ` -global Event _msg; - -global Event _hid; -global int _hidMultiple; -0 => global int _cursorX; -0 => global int _cursorY; - -0 => global float _deltaX; -0 => global float _deltaY; - -global string _key; -global int _isDown; -global int _isUp; -global int _isMouseDown; -global int _isMouseUp; -global int _isScroll; -global int _ascii; -global int _which; -global int _mouseActive; -global int _kbdActive; -global int _mouseMotion; -global float _scaledCursorX; -global float _scaledCursorY; - public class HidMsg { int type; int deviceType; @@ -38,26 +14,22 @@ public class HidMsg { // type 1 message function int isButtonDown() { - if (type == 1) { return 1; } - return 0; + return type == 1; } // type 2 message function int isButtonUp() { - if (type == 2) { return 1; } - return 0; + return type == 2; } // type 5 message function int isMouseMotion(){ - if (type == 5) { return 1; } - return 0; + return type == 5; } // type 6 message function int isWheelMotion(){ - if (type == 6) { return 1; } - return 0; + return type == 6; } function void _copy(HidMsg localMsg) { @@ -77,29 +49,21 @@ public class HidMsg { `; const Hid_ck = ` -global Event _msg; - global Event _hid; +global int _type; +global int _mouseActive; +global int _kbdActive; + global int _cursorX; global int _cursorY; - global float _deltaX; global float _deltaY; +global float _scaledCursorX; +global float _scaledCursorY; -global int _type; -global string _key; -global int _isDown; -global int _isUp; -global int _isMouseDown; -global int _isMouseUp; -global int _isScroll; global int _ascii; global int _which; -global int _mouseActive; -global int _kbdActive; -global int _mouseMotion; -global float _scaledCursorX; -global float _scaledCursorY; +global string _key; public class Hid extends Event { @@ -178,6 +142,9 @@ public class Hid extends Event { _hidMsgQueue << msg; this.broadcast(); + + // Clear message type + 0 => _type; } } spork ~ _HidListener(); diff --git a/src/wc-bundle.js b/src/wc-bundle.js index a9295c6..69952b0 100644 --- a/src/wc-bundle.js +++ b/src/wc-bundle.js @@ -1068,30 +1068,6 @@ class Chuck extends window.AudioWorkletNode { Chuck.chuckID = 1; const HidMsg_ck = ` -global Event _msg; - -global Event _hid; -global int _hidMultiple; -0 => global int _cursorX; -0 => global int _cursorY; - -0 => global float _deltaX; -0 => global float _deltaY; - -global string _key; -global int _isDown; -global int _isUp; -global int _isMouseDown; -global int _isMouseUp; -global int _isScroll; -global int _ascii; -global int _which; -global int _mouseActive; -global int _kbdActive; -global int _mouseMotion; -global float _scaledCursorX; -global float _scaledCursorY; - public class HidMsg { int type; int deviceType; @@ -1107,26 +1083,22 @@ public class HidMsg { // type 1 message function int isButtonDown() { - if (type == 1) { return 1; } - return 0; + return type == 1; } // type 2 message function int isButtonUp() { - if (type == 2) { return 1; } - return 0; + return type == 2; } // type 5 message function int isMouseMotion(){ - if (type == 5) { return 1; } - return 0; + return type == 5; } // type 6 message function int isWheelMotion(){ - if (type == 6) { return 1; } - return 0; + return type == 6; } function void _copy(HidMsg localMsg) { @@ -1145,29 +1117,21 @@ public class HidMsg { } `; const Hid_ck = ` -global Event _msg; - global Event _hid; +global int _type; +global int _mouseActive; +global int _kbdActive; + global int _cursorX; global int _cursorY; - global float _deltaX; global float _deltaY; +global float _scaledCursorX; +global float _scaledCursorY; -global int _type; -global string _key; -global int _isDown; -global int _isUp; -global int _isMouseDown; -global int _isMouseUp; -global int _isScroll; global int _ascii; global int _which; -global int _mouseActive; -global int _kbdActive; -global int _mouseMotion; -global float _scaledCursorX; -global float _scaledCursorY; +global string _key; public class Hid extends Event { @@ -1246,12 +1210,35 @@ public class Hid extends Event { _hidMsgQueue << msg; this.broadcast(); + + // Clear message type + 0 => _type; } } spork ~ _HidListener(); } `; +var HidMsgType; +(function (HidMsgType) { + HidMsgType[HidMsgType["BUTTON_DOWN"] = 1] = "BUTTON_DOWN"; + HidMsgType[HidMsgType["BUTTON_UP"] = 2] = "BUTTON_UP"; + HidMsgType[HidMsgType["MOUSE_MOTION"] = 5] = "MOUSE_MOTION"; + HidMsgType[HidMsgType["WHEEL_MOTION"] = 6] = "WHEEL_MOTION"; +})(HidMsgType || (HidMsgType = {})); +/** + * Introducing HID (Human Interface Device) support for WebChucK. WebChucK HID + * brings mouse and keyboard support to work with the native {@link https://chuck.stanford.edu/doc/reference/io.html#Hid | Hid} + * class in ChucK. WebChucK HID wraps JavaScript mouse and keyboard event + * listeners. To get started with HID: + * @example + * ```ts + * import { Chuck, HID } from "webchuck"; + * + * const theChuck = await Chuck.init([]); + * const hid = await HID.init(theChuck); + * ``` + */ class HID { /** @internal */ constructor(theChuck) { @@ -1260,8 +1247,6 @@ class HID { // Initialize members this.theChuck = theChuck; this.keymap = new Array(256).fill(false); - this.mousePos = { x: 0, y: 0 }; - this.lastPos = { x: 0, y: 0 }; // Bind handlers this.boundHandleMouseMove = this.handleMouseMove.bind(this); this.boundHandleMouseDown = this.handleMouseDown.bind(this); @@ -1276,12 +1261,12 @@ class HID { * Mouse and keyboard event listeners are added if `enableMouse` and `enableKeyboard` are true (default). * @example * ```ts - * theChuck = await Chuck.init(); // Initialize WebChucK + * theChuck = await Chuck.init([]); * hid = await HID.init(theChuck); // Initialize HID with mouse and keyboard * ``` * @example * ```ts - * theChuck = await Chuck.init(); // Initialize WebChucK + * theChuck = await Chuck.init([]); * hid = await HID.init(theChuck, false, true); // Initialize HID, no mouse, only keyboard * ``` * @param theChuck WebChucK instance @@ -1331,7 +1316,7 @@ class HID { }; } /** - * Enable Mouse HID Javascript event listeners to communicate with ChucK + * Enable Mouse HID Javascript event listeners for Chuck HID * Adds a mousemove, mousedown, mouseup, and wheel listener to the document. * @example * ```ts @@ -1344,6 +1329,7 @@ class HID { document.addEventListener("mousedown", this.boundHandleMouseDown); document.addEventListener("mouseup", this.boundHandleMouseUp); document.addEventListener("wheel", this.boundHandleMouseWheel); + document.addEventListener("contextmenu", HID.handleContextMenu); } /** * Disable Mouse HID Javascript event listeners @@ -1358,9 +1344,10 @@ class HID { document.removeEventListener("mousedown", this.boundHandleMouseDown); document.removeEventListener("mouseup", this.boundHandleMouseUp); document.removeEventListener("wheel", this.boundHandleMouseWheel); + document.removeEventListener("contextmenu", HID.handleContextMenu); } /** - * Enable keyboard HID Javascript event listeners to communicate with ChucK. + * Enable keyboard HID Javascript event listeners for Chuck HID * Adds a keydown and keyup listener to the document. * @example * ```ts @@ -1392,55 +1379,47 @@ class HID { handleMouseMove(e) { this.mouseActive(); if (this._mouseActive) { - this.mousePos = this.getMousePos(e); - this.theChuck.setInt("_mouseMotion", 1); - this.theChuck.broadcastEvent("_hid"); - this.theChuck.setInt("_mouseX", this.mousePos.x); - this.theChuck.setInt("_mouseY", this.mousePos.y); + const mousePos = this.getMousePos(e); this.theChuck.setFloat("_deltaX", e.movementX); this.theChuck.setFloat("_deltaY", e.movementY); - this.theChuck.setFloat("_scaledCursorX", this.mousePos.x / document.documentElement.clientWidth); - this.theChuck.setFloat("_scaledCursorY", this.mousePos.y / document.documentElement.clientHeight); - this.theChuck.broadcastEvent("_msg"); + this.theChuck.setFloat("_scaledCursorX", mousePos.x / document.documentElement.clientWidth); + this.theChuck.setFloat("_scaledCursorY", mousePos.y / document.documentElement.clientHeight); + this.theChuck.setInt("_type", HidMsgType.MOUSE_MOTION); + this.theChuck.broadcastEvent("_hid"); } - this.lastPos = this.mousePos; } /** @internal */ handleMouseDown(e) { this.mouseActive(); if (this._mouseActive) { - this.theChuck.setInt("_mouseMotion", 0); - this.theChuck.setInt("_mouseDown", 1); - this.theChuck.broadcastEvent("_hid"); - this.theChuck.setInt("_hidMouse", 1); this.theChuck.setInt("_which", e.which); - this.theChuck.broadcastEvent("_msg"); + this.theChuck.setInt("_type", HidMsgType.BUTTON_DOWN); + this.theChuck.broadcastEvent("_hid"); } } /** @internal */ handleMouseUp(e) { this.mouseActive(); if (this._mouseActive) { - this.theChuck.setInt("_mouseMotion", 0); - this.theChuck.setInt("_mouseUp", 1); - this.theChuck.broadcastEvent("_hid"); - this.theChuck.setInt("_hidMouse", 1); this.theChuck.setInt("_which", e.which); - this.theChuck.broadcastEvent("_msg"); + this.theChuck.setInt("_type", HidMsgType.BUTTON_UP); + this.theChuck.broadcastEvent("_hid"); } } /** @internal */ handleMouseWheel(e) { this.mouseActive(); if (this._mouseActive) { - this.theChuck.setInt("_mouseMotion", 0); - this.theChuck.setInt("_isScroll", 1); - this.theChuck.setInt("_deltaX", clamp(e.deltaX, -1, 1)); - this.theChuck.setInt("_deltaY", clamp(e.deltaY, -1, 1)); + this.theChuck.setFloat("_deltaX", clamp(e.deltaX, -1, 1)); + this.theChuck.setFloat("_deltaY", clamp(e.deltaY, -1, 1)); + this.theChuck.setInt("_type", HidMsgType.WHEEL_MOTION); this.theChuck.broadcastEvent("_hid"); - this.theChuck.broadcastEvent("_msg"); } } + /** @internal */ + static handleContextMenu(e) { + e.preventDefault(); + } //----------- KEYBOARD --------- // /** @internal */ handleKeyDown(e) { @@ -1468,7 +1447,7 @@ class HID { this.theChuck.setString("_key", e.key); this.theChuck.setInt("_which", e.which); this.theChuck.setInt("_ascii", e.keyCode); - this.theChuck.setInt("_type", isDown ? 1 : 2); + this.theChuck.setInt("_type", isDown ? HidMsgType.BUTTON_DOWN : HidMsgType.BUTTON_UP); this.theChuck.broadcastEvent("_hid"); } } @@ -1480,7 +1459,7 @@ class HID { * @param val value to clamp * @param min min value * @param max max value - * @returns clamp value + * @returns clamped value */ function clamp(val, min, max) { return Math.min(Math.max(val, min), max); diff --git a/test/chuckTest.js b/test/chuckTest.js index 69f668a..d1fba57 100644 --- a/test/chuckTest.js +++ b/test/chuckTest.js @@ -81,7 +81,6 @@ import('../src/wc-bundle.js').then(async (module) => { // DEFINE ALL TESTS!!! const testSuite = [ - /* new Test(1, "[sound] Define a ChucK and runCode 220hz 0.5 second", async () => { var aChuck = await Chuck.init([], undefined, undefined, "../src/"); var outputBox = document.getElementById("output-" + 1); @@ -323,14 +322,12 @@ const testSuite = [ console.log(outputBox.innerText); return outputBox.innerText == "I am in! \nPASSED"; }), - */ new Test(12, "HID - mouse", async () => { var aChuck = await Chuck.init([], undefined, undefined, "../src/"); var outputBox = document.getElementById("output-" + 12); print = (output) => { outputBox.innerHTML = output + "
                "; - console.log(output); } aChuck.chuckPrint = print; @@ -349,7 +346,7 @@ const testSuite = [ } aChuck.chuckPrint = print; - window.hid = await HID.init(aChuck); + var hid = await HID.init(aChuck); await aChuck.loadFile("./testFiles/kb.ck") aChuck.runFile("kb.ck")