plotboilerplate 1.27.0 → 1.28.0

package/src/_esm/src/ts/KeyHandler.js

@@ -0,0 +1,430 @@
+/**
+ * @author   Ikaros Kappler
+ * @date     2018-11-11 (Alaaf)
+ * @modified 2020-03-28 Ported this class from vanilla-JS to Typescript.
+ * @modified 2020-07-28 Changed the `delete` key code from 8 to 46.
+ * @modified 2020-10-04 Changed `window` to `globalThis`.
+ * @modified 2020-10-04 Added extended JSDoc.
+ * @modified 2022-02-02 Added the `destroy` method.
+ * @version  1.1.0
+ *
+ * @file KeyHandler
+ * @public
+ **/
+/**
+ * @classdesc A generic key handler.
+ *
+ * Example
+ * =======
+ * @example
+ *      // Javascript
+ *	new KeyHandler( { trackAll : true } )
+ *	    .down('enter',function() { console.log('ENTER was hit.'); } )
+ *	    .press('enter',function() { console.log('ENTER was pressed.'); } )
+ *	    .up('enter',function() { console.log('ENTER was released.'); } )
+ *
+ *          .down('e',function() { console.log('e was hit. shift is pressed?',keyHandler.isDown('shift')); } )
+ *
+ *	    .up('windows',function() { console.log('windows was released.'); } )
+ *	;
+ */
+export class KeyHandler {
+    /**
+     * The constructor.
+     *
+     * @constructor
+     * @instance
+     * @memberof KeyHandler
+     * @param {HTMLElement} options.element (optional) The HTML element to listen on; if null then 'window' will be used.
+     * @param {boolean} options.trackAll (optional) Set to true if you want to keep track of _all_ keys (keyStatus).
+     **/
+    constructor(options) {
+        this.downListeners = [];
+        this.pressListeners = [];
+        this.upListeners = [];
+        this.keyStates = {};
+        options = options || {};
+        this.element = options.element ? options.element : globalThis;
+        this.downListeners = [];
+        this.pressListeners = [];
+        this.upListeners = [];
+        this.keyStates = [];
+        // This could be made configurable in a later version. It allows to
+        // keep track of the key status no matter if there are any listeners
+        // on the key or not.
+        this.trackAllKeys = options.trackAll || false;
+        // Install the listeners
+        this.installListeners();
+    }
+    /**
+     * A helper function to fire key events from this KeyHandler.
+     *
+     * @param {KeyboardEvent} event - The key event to fire.
+     * @param {Array<XKeyListener>} listener - The listeners to fire to.
+     */
+    fireEvent(event, listeners) {
+        let hasListener = false;
+        for (var i in listeners) {
+            var lis = listeners[i];
+            if (lis.keyCode != event.keyCode)
+                continue;
+            lis.listener(event);
+            hasListener = true;
+        }
+        return hasListener;
+    }
+    /**
+     * Internal function to fire a new keydown event to all listeners.
+     * You should not call this function on your own unless you know what you do.
+     *
+     * @name fireDownEvent
+     * @memberof KeyHandler
+     * @instance
+     * @private
+     * @param {KeyboardEvent} e
+     * @param {KeyHandler} handler
+     * @return {void}
+     */
+    fireDownEvent(e, handler) {
+        if (handler.fireEvent(e, handler.downListeners) || handler.trackAllKeys) {
+            // Down event has listeners. Update key state.
+            handler.keyStates[e.keyCode] = "down";
+        }
+    }
+    /**
+     * Internal function to fire a new keypress event to all listeners.
+     * You should not call this function on your own unless you know what you do.
+     *
+     * @name firePressEvent
+     * @memberof KeyHandler
+     * @instance
+     * @private
+     * @param {KeyboardEvent} e
+     * @param {KeyHandler} handler
+     * @return void
+     */
+    firePressEvent(e, handler) {
+        handler.fireEvent(e, handler.pressListeners);
+    }
+    /**
+     * Internal function to fire a new keyup event to all listeners.
+     * You should not call this function on your own unless you know what you do.
+     *
+     * @name fireUpEvent
+     * @memberof KeyHandler
+     * @instance
+     * @private
+     * @param {KeyboardEvent} e
+     * @param {KeyHandler} handler
+     * @return {void}
+     */
+    fireUpEvent(e, handler) {
+        if (handler.fireEvent(e, handler.upListeners) || handler.trackAllKeys) {
+            // Up event has listeners. Clear key state.
+            delete handler.keyStates[e.keyCode];
+        }
+    }
+    /**
+     * Resolve the key/name code.
+     */
+    static key2code(key) {
+        if (typeof key == "number")
+            return key;
+        if (typeof key != "string")
+            throw "Unknown key name or key type (should be a string or integer): " + key;
+        if (KeyHandler.KEY_CODES[key])
+            return KeyHandler.KEY_CODES[key];
+        throw "Unknown key (cannot resolve key code): " + key;
+    }
+    /**
+     * Install the required listeners into the initially passed element.
+     *
+     * By default the listeners are installed into the root element specified on
+     * construction (or 'window').
+     */
+    installListeners() {
+        var _self = this;
+        this.element.addEventListener("keydown", (this._keyDownListener = (e) => {
+            _self.fireDownEvent(e, _self);
+        }));
+        this.element.addEventListener("keypress", (this._keyPressListener = (e) => {
+            _self.firePressEvent(e, _self);
+        }));
+        this.element.addEventListener("keyup", (this._keyUpListener = (e) => {
+            _self.fireUpEvent(e, _self);
+        }));
+    }
+    /**
+     *  Remove all installed event listeners from the underlying element.
+     */
+    releaseListeners() {
+        this.element.removeEventListener("keydown", this._keyDownListener);
+        this.element.removeEventListener("keypress", this._keyPressListener);
+        this.element.removeEventListener("keyup", this._keyUpListener);
+    }
+    /**
+     * Listen for key down. This function allows chaining.
+     *
+     * Example: new KeyHandler().down('enter',function() {console.log('Enter hit.')});
+     *
+     * @name down
+     * @memberof KeyHandler
+     * @instance
+     * @param {string|number} key -  Any key identifier, key code or one from the KEY_CODES list.
+     * @param {(e:KeyboardEvent)=>void} e -  The callback to be triggered.
+     * @return {KeyHandler} this
+     */
+    down(key, listener) {
+        this.downListeners.push({ key: key, keyCode: KeyHandler.key2code(key), listener: listener });
+        return this;
+    }
+    /**
+     * Listen for key press.
+     *
+     * Example: new KeyHandler().press('enter',function() {console.log('Enter pressed.')});
+     *
+     * @name press
+     * @memberof KeyHandler
+     * @instance
+     * @param {string|number} key - Any key identifier, key code or one from the KEY_CODES list.
+     * @param {(e:KeyboardEvent)=>void} listener - The callback to be triggered.
+     * @return {KeyHandler} this
+     */
+    press(key, listener) {
+        this.pressListeners.push({ key: key, keyCode: KeyHandler.key2code(key), listener: listener });
+        return this;
+    }
+    /**
+     * Listen for key up.
+     *
+     * Example: new KeyHandler().up('enter',function() {console.log('Enter released.')});
+     *
+     * @name up
+     * @memberof KeyHandler
+     * @instance
+     * @param {string} key - Any key identifier, key code or one from the KEY_CODES list.
+     * @param {(e:KeyboardEvent)=>void)} e - The callback to be triggered.
+     * @return {KeyHandler} this
+     */
+    up(key, listener) {
+        this.upListeners.push({ key: key, keyCode: KeyHandler.key2code(key), listener: listener });
+        return this;
+    }
+    /**
+     * Check if a specific key is currently held pressed.
+     *
+     * @param {string|number} key - Any key identifier, key code or one from the KEY_CODES list.
+     */
+    isDown(key) {
+        if (typeof key == "number")
+            return this.keyStates[key] ? true : false;
+        else
+            return this.keyStates[KeyHandler.key2code(key)] ? true : false;
+    }
+    /**
+     * This function should invalidate any installed listeners and invalidate this object.
+     * After calling this function the object might not hold valid data any more and
+     * should not be used any more.
+     */
+    destroy() {
+        this.releaseListeners();
+    }
+}
+/**
+ * Source:
+ * https://keycode.info/
+ */
+// prettier-ignore
+KeyHandler.KEY_CODES = {
+    'break': 3, // alternate: 19
+    'backspace': 8,
+    // 'delete'	 : 8, // alternate: 46
+    'tab': 9,
+    'clear': 12,
+    'enter': 13,
+    'shift': 16,
+    'ctrl': 17,
+    'alt': 18,
+    'pause': 19,
+    // 'break'	         : 19,
+    'capslock': 20,
+    'hangul': 21,
+    'hanja': 25,
+    'escape': 27,
+    'conversion': 28,
+    'non-conversion': 29, // alternate: 235?
+    'spacebar': 32,
+    'pageup': 33,
+    'pagedown': 34,
+    'end': 35,
+    'home': 36, // alternate: 172?
+    'leftarrow': 37,
+    'uparrow': 38,
+    'rightarrow': 39,
+    'downarrow': 40,
+    'select': 41,
+    'print': 42,
+    'execute': 43,
+    'printscreen': 44,
+    'insert': 45,
+    'delete': 46, // alternate: 8
+    'help': 47,
+    '0': 48,
+    '1': 49,
+    '2': 50,
+    '3': 51,
+    '4': 52,
+    '5': 53,
+    '6': 54,
+    '7': 55,
+    '8': 56,
+    '9': 57,
+    ':': 58,
+    'semicolon (firefox)': 59,
+    'equals': 59,
+    '<': 60,
+    'equals (firefox)': 61,
+    'ß': 63,
+    '@ (firefox)': 64,
+    'a': 65,
+    'b': 66,
+    'c': 67,
+    'd': 68,
+    'e': 69,
+    'f': 70,
+    'g': 71,
+    'h': 72,
+    'i': 73,
+    'j': 74,
+    'k': 75,
+    'l': 76,
+    'm': 77,
+    'n': 78,
+    'o': 79,
+    'p': 80,
+    'q': 81,
+    'r': 82,
+    's': 83,
+    't': 84,
+    'u': 85,
+    'v': 86,
+    'w': 87,
+    'x': 88,
+    'y': 89,
+    'z': 90,
+    'windows': 91,
+    'leftcommand': 91, // left ⌘
+    'chromebooksearch': 91,
+    'rightwindowkey': 92,
+    'windowsmenu': 93,
+    'rightcommant': 93, // right ⌘
+    'sleep': 95,
+    'numpad0': 96,
+    'numpad1': 97,
+    'numpad2': 98,
+    'numpad3': 99,
+    'numpad4': 100,
+    'numpad5': 101,
+    'numpad6': 102,
+    'numpad7': 103,
+    'numpad8': 104,
+    'numpad9': 105,
+    'multiply': 106,
+    'add': 107,
+    'numpadperiod': 108, // firefox, 194 on chrome
+    'subtract': 109,
+    'decimalpoint': 110,
+    'divide': 111,
+    'f1': 112,
+    'f2': 113,
+    'f3': 114,
+    'f4': 115,
+    'f5': 116,
+    'f6': 117,
+    'f7': 118,
+    'f8': 119,
+    'f9': 120,
+    'f10': 121,
+    'f11': 122,
+    'f12': 123,
+    'f13': 124,
+    'f14': 125,
+    'f15': 126,
+    'f16': 127,
+    'f17': 128,
+    'f18': 129,
+    'f19': 130,
+    'f20': 131,
+    'f21': 132,
+    'f22': 133,
+    'f23': 134,
+    'f24': 135,
+    'numlock': 144,
+    'scrolllock': 145,
+    '^': 160,
+    '!': 161,
+    // '؛' 	 : 162 // (arabic semicolon)
+    '#': 163,
+    '$': 164,
+    'ù': 165,
+    'pagebackward': 166,
+    'pageforward': 167,
+    'refresh': 168,
+    'closingparen': 169, // (AZERTY)
+    '*': 170,
+    '~+*': 171,
+    // 'home'	         : 172,
+    'minus': 173, // firefox
+    // 'mute'           : 173,
+    // 'unmute'	 : 173,
+    'decreasevolumelevel': 174,
+    'increasevolumelevel': 175,
+    'next': 176,
+    'previous': 177,
+    'stop': 178,
+    'play/pause': 179,
+    'email': 180,
+    'mute': 181, // firefox, alternate: 173
+    'unmute': 181, // alternate: 173?
+    //'decreasevolumelevel'	182 // firefox
+    //'increasevolumelevel'	183 // firefox
+    'semicolon': 186,
+    'ñ': 186,
+    'equal': 187,
+    'comma': 188,
+    'dash': 189,
+    'period': 190,
+    'forwardslash': 191,
+    'ç': 191, // 231 alternate?
+    'grave accent': 192,
+    //'ñ' 192,
+    'æ': 192,
+    'ö': 192,
+    '?': 193,
+    '/': 193,
+    '°': 193,
+    // 'numpadperiod'	 : 194, // chrome
+    'openbracket': 219,
+    'backslash': 220,
+    'closebracket': 221,
+    'å': 221,
+    'singlequote': 222,
+    'ø': 222,
+    'ä': 222,
+    '`': 223,
+    // 'left or right ⌘ key (firefox)'	224
+    'altgr': 225,
+    // '< /git >, left back slash'	226
+    'GNOME Compose Key': 230,
+    'XF86Forward': 233,
+    'XF86Back': 234,
+    'alphanumeric': 240,
+    'hiragana': 242,
+    'katakana': 242,
+    'half-width': 243,
+    'full-width': 243,
+    'kanji': 244,
+    'unlocktrackpad': 251, // Chrome/Edge
+    'toggletouchpad': 255
+};
+//# sourceMappingURL=KeyHandler.js.map

package/src/_esm/src/ts/KeyHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeyHandler.js","sourceRoot":"","sources":["../../../ts/KeyHandler.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;IAYI;AAEJ;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,OAAO,UAAU;IAarB;;;;;;;;QAQI;IACJ,YAAY,OAAmF;QApBvF,kBAAa,GAAe,EAAE,CAAC;QAC/B,mBAAc,GAAe,EAAE,CAAC;QAChC,gBAAW,GAAe,EAAE,CAAC;QAC7B,cAAS,GAAuC,EAAE,CAAC;QAkBzD,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;QACxB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC;QAC9D,IAAI,CAAC,aAAa,GAAG,EAAE,CAAC;QACxB,IAAI,CAAC,cAAc,GAAG,EAAE,CAAC;QACzB,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;QACtB,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QACpB,mEAAmE;QACnE,oEAAoE;QACpE,qBAAqB;QACrB,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,QAAQ,IAAI,KAAK,CAAC;QAC9C,wBAAwB;QACxB,IAAI,CAAC,gBAAgB,EAAE,CAAC;IAC1B,CAAC;IAED;;;;;OAKG;IACK,SAAS,CAAC,KAAoB,EAAE,SAA8B;QACpE,IAAI,WAAW,GAAY,KAAK,CAAC;QACjC,KAAK,IAAI,CAAC,IAAI,SAAS,EAAE,CAAC;YACxB,IAAI,GAAG,GAAiB,SAAS,CAAC,CAAC,CAAC,CAAC;YACrC,IAAI,GAAG,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO;gBAAE,SAAS;YAC3C,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YACpB,WAAW,GAAG,IAAI,CAAC;QACrB,CAAC;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;;;;;;;;OAWG;IACK,aAAa,CAAC,CAAgB,EAAE,OAAmB;QACzD,IAAI,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;YACxE,8CAA8C;YAC9C,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC;QACxC,CAAC;IACH,CAAC;IAED;;;;;;;;;;;OAWG;IACK,cAAc,CAAC,CAAgB,EAAE,OAAmB;QAC1D,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;;;;;OAWG;IACK,WAAW,CAAC,CAAgB,EAAE,OAAmB;QACvD,IAAI,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;YACtE,2CAA2C;YAC3C,OAAO,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QACtC,CAAC;IACH,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,GAAoB;QAClC,IAAI,OAAO,GAAG,IAAI,QAAQ;YAAE,OAAO,GAAG,CAAC;QACvC,IAAI,OAAO,GAAG,IAAI,QAAQ;YAAE,MAAM,gEAAgE,GAAG,GAAG,CAAC;QACzG,IAAI,UAAU,CAAC,SAAS,CAAC,GAAG,CAAC;YAAE,OAAO,UAAU,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAChE,MAAM,yCAAyC,GAAG,GAAG,CAAC;IACxD,CAAC;IAwMD;;;;;OAKG;IACH,gBAAgB;QACd,IAAI,KAAK,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAC3B,SAAS,EACT,CAAC,IAAI,CAAC,gBAAgB,GAAG,CAAC,CAAgB,EAAE,EAAE;YAC5C,KAAK,CAAC,aAAa,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;QAChC,CAAC,CAAkB,CACpB,CAAC;QACF,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAC3B,UAAU,EACV,CAAC,IAAI,CAAC,iBAAiB,GAAG,CAAC,CAAgB,EAAE,EAAE;YAC7C,KAAK,CAAC,cAAc,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;QACjC,CAAC,CAAkB,CACpB,CAAC;QACF,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAC3B,OAAO,EACP,CAAC,IAAI,CAAC,cAAc,GAAG,CAAC,CAAgB,EAAE,EAAE;YAC1C,KAAK,CAAC,WAAW,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;QAC9B,CAAC,CAAkB,CACpB,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,gBAAgB;QACd,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,SAAS,EAAE,IAAI,CAAC,gBAAiC,CAAC,CAAC;QACpF,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,UAAU,EAAE,IAAI,CAAC,iBAAkC,CAAC,CAAC;QACtF,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,OAAO,EAAE,IAAI,CAAC,cAA+B,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,GAAoB,EAAE,QAAsB;QAC/C,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAkB,CAAC,CAAC;QAC7G,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,GAAoB,EAAE,QAAsB;QAChD,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAkB,CAAC,CAAC;QAC9G,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;OAWG;IACH,EAAE,CAAC,GAAW,EAAE,QAAsB;QACpC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAkB,CAAC,CAAC;QAC3G,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,GAAoB;QACzB,IAAI,OAAO,GAAG,IAAI,QAAQ;YAAE,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;;YACjE,OAAO,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;IACtE,CAAC;IAED;;;;OAIG;IACH,OAAO;QACL,IAAI,CAAC,gBAAgB,EAAE,CAAC;IAC1B,CAAC;CACF;AAhTC;;;GAGG;AACH,kBAAkB;AACH,oBAAS,GAA0B;IACnD,OAAO,EAAY,CAAC,EAAE,gBAAgB;IACtC,WAAW,EAAQ,CAAC;IACpB,kCAAkC;IAClC,KAAK,EAAY,CAAC;IAClB,OAAO,EAAY,EAAE;IACrB,OAAO,EAAY,EAAE;IACrB,OAAO,EAAY,EAAE;IACrB,MAAM,EAAY,EAAE;IACpB,KAAK,EAAY,EAAE;IACnB,OAAO,EAAY,EAAE;IACrB,yBAAyB;IACzB,UAAU,EAAI,EAAE;IAChB,QAAQ,EAAI,EAAE;IACd,OAAO,EAAY,EAAE;IACrB,QAAQ,EAAI,EAAE;IACd,YAAY,EAAK,EAAE;IACnB,gBAAgB,EAAG,EAAE,EAAG,kBAAkB;IAC1C,UAAU,EAAI,EAAE;IAChB,QAAQ,EAAI,EAAE;IACd,UAAU,EAAI,EAAE;IAChB,KAAK,EAAY,EAAE;IACnB,MAAM,EAAY,EAAE,EAAE,kBAAkB;IACxC,WAAW,EAAI,EAAE;IACjB,SAAS,EAAI,EAAE;IACf,YAAY,EAAI,EAAE;IAClB,WAAW,EAAI,EAAE;IACjB,QAAQ,EAAI,EAAE;IACd,OAAO,EAAY,EAAE;IACrB,SAAS,EAAI,EAAE;IACf,aAAa,EAAI,EAAE;IACnB,QAAQ,EAAI,EAAE;IACd,QAAQ,EAAI,EAAE,EAAE,eAAe;IAC/B,MAAM,EAAY,EAAE;IACpB,GAAG,EAAgB,EAAE;IACrB,GAAG,EAAgB,EAAE;IACrB,GAAG,EAAgB,EAAE;IACrB,GAAG,EAAgB,EAAE;IACrB,GAAG,EAAgB,EAAE;IACrB,GAAG,EAAgB,EAAE;IACrB,GAAG,EAAgB,EAAE;IACrB,GAAG,EAAgB,EAAE;IACrB,GAAG,EAAgB,EAAE;IACrB,GAAG,EAAgB,EAAE;IACrB,GAAG,EAAgB,EAAE;IACrB,qBAAqB,EAAG,EAAE;IAC1B,QAAQ,EAAI,EAAE;IACd,GAAG,EAAY,EAAE;IACjB,kBAAkB,EAAG,EAAE;IACvB,GAAG,EAAY,EAAE;IACjB,aAAa,EAAI,EAAE;IACnB,GAAG,EAAY,EAAE;IACjB,GAAG,EAAY,EAAE;IACjB,GAAG,EAAY,EAAE;IACjB,GAAG,EAAY,EAAE;IACjB,GAAG,EAAY,EAAE;IACjB,GAAG,EAAY,EAAE;IACjB,GAAG,EAAY,EAAE;IACjB,GAAG,EAAY,EAAE;IACjB,GAAG,EAAY,EAAE;IACjB,GAAG,EAAY,EAAE;IACjB,GAAG,EAAY,EAAE;IACjB,GAAG,EAAY,EAAE;IACjB,GAAG,EAAY,EAAE;IACjB,GAAG,EAAY,EAAE;IACjB,GAAG,EAAY,EAAE;IACjB,GAAG,EAAY,EAAE;IACjB,GAAG,EAAY,EAAE;IACjB,GAAG,EAAY,EAAE;IACjB,GAAG,EAAY,EAAE;IACjB,GAAG,EAAY,EAAE;IACjB,GAAG,EAAY,EAAE;IACjB,GAAG,EAAY,EAAE;IACjB,GAAG,EAAY,EAAE;IACjB,GAAG,EAAY,EAAE;IACjB,GAAG,EAAY,EAAE;IACjB,GAAG,EAAY,EAAE;IACjB,SAAS,EAAU,EAAE;IACrB,aAAa,EAAI,EAAE,EAAE,SAAS;IAC9B,kBAAkB,EAAG,EAAE;IACvB,gBAAgB,EAAG,EAAE;IACrB,aAAa,EAAI,EAAE;IACnB,cAAc,EAAK,EAAE,EAAE,UAAU;IACjC,OAAO,EAAY,EAAE;IACrB,SAAS,EAAI,EAAE;IACf,SAAS,EAAI,EAAE;IACf,SAAS,EAAI,EAAE;IACf,SAAS,EAAI,EAAE;IACf,SAAS,EAAI,GAAG;IAChB,SAAS,EAAI,GAAG;IAChB,SAAS,EAAI,GAAG;IAChB,SAAS,EAAI,GAAG;IAChB,SAAS,EAAI,GAAG;IAChB,SAAS,EAAI,GAAG;IAChB,UAAU,EAAI,GAAG;IACjB,KAAK,EAAY,GAAG;IACpB,cAAc,EAAI,GAAG,EAAE,yBAAyB;IAChD,UAAU,EAAI,GAAG;IACjB,cAAc,EAAI,GAAG;IACrB,QAAQ,EAAI,GAAG;IACf,IAAI,EAAY,GAAG;IACnB,IAAI,EAAY,GAAG;IACnB,IAAI,EAAY,GAAG;IACnB,IAAI,EAAY,GAAG;IACnB,IAAI,EAAY,GAAG;IACnB,IAAI,EAAY,GAAG;IACnB,IAAI,EAAY,GAAG;IACnB,IAAI,EAAY,GAAG;IACnB,IAAI,EAAY,GAAG;IACnB,KAAK,EAAY,GAAG;IACpB,KAAK,EAAY,GAAG;IACpB,KAAK,EAAY,GAAG;IACpB,KAAK,EAAY,GAAG;IACpB,KAAK,EAAY,GAAG;IACpB,KAAK,EAAY,GAAG;IACpB,KAAK,EAAY,GAAG;IACpB,KAAK,EAAY,GAAG;IACpB,KAAK,EAAY,GAAG;IACpB,KAAK,EAAY,GAAG;IACpB,KAAK,EAAY,GAAG;IACpB,KAAK,EAAY,GAAG;IACpB,KAAK,EAAY,GAAG;IACpB,KAAK,EAAY,GAAG;IACpB,KAAK,EAAY,GAAG;IACpB,SAAS,EAAI,GAAG;IAChB,YAAY,EAAI,GAAG;IACnB,GAAG,EAAY,GAAG;IAClB,GAAG,EAAY,GAAG;IAClB,oCAAoC;IACpC,GAAG,EAAY,GAAG;IAClB,GAAG,EAAY,GAAG;IAClB,GAAG,EAAY,GAAG;IAClB,cAAc,EAAI,GAAG;IACrB,aAAa,EAAI,GAAG;IACpB,SAAS,EAAI,GAAG;IAChB,cAAc,EAAI,GAAG,EAAE,WAAW;IAClC,GAAG,EAAa,GAAG;IACnB,KAAK,EAAY,GAAG;IACpB,yBAAyB;IACzB,OAAO,EAAY,GAAG,EAAE,UAAU;IAClC,0BAA0B;IAC1B,mBAAmB;IACnB,qBAAqB,EAAG,GAAG;IAC3B,qBAAqB,EAAG,GAAG;IAC3B,MAAM,EAAY,GAAG;IACrB,UAAU,EAAI,GAAG;IACjB,MAAM,EAAY,GAAG;IACrB,YAAY,EAAI,GAAG;IACnB,OAAO,EAAY,GAAG;IACtB,MAAM,EAAY,GAAG,EAAE,0BAA0B;IACjD,QAAQ,EAAW,GAAG,EAAE,kBAAkB;IAC1C,sCAAsC;IACtC,sCAAsC;IACtC,WAAW,EAAQ,GAAG;IACtB,GAAG,EAAe,GAAG;IACrB,OAAO,EAAY,GAAG;IACtB,OAAO,EAAY,GAAG;IACtB,MAAM,EAAY,GAAG;IACrB,QAAQ,EAAI,GAAG;IACf,cAAc,EAAK,GAAG;IACtB,GAAG,EAAY,GAAG,EAAE,iBAAiB;IACrC,cAAc,EAAK,GAAG;IACtB,UAAU;IACV,GAAG,EAAgB,GAAG;IACtB,GAAG,EAAY,GAAG;IAClB,GAAG,EAAgB,GAAG;IACtB,GAAG,EAAgB,GAAG;IACtB,GAAG,EAAY,GAAG;IAClB,mCAAmC;IACnC,aAAa,EAAI,GAAG;IACpB,WAAW,EAAI,GAAG;IAClB,cAAc,EAAK,GAAG;IACtB,GAAG,EAAe,GAAG;IACrB,aAAa,EAAM,GAAG;IACtB,GAAG,EAAgB,GAAG;IACtB,GAAG,EAAY,GAAG;IAClB,GAAG,EAAY,GAAG;IAClB,sCAAsC;IACtC,OAAO,EAAY,GAAG;IACtB,kCAAkC;IAClC,mBAAmB,EAAG,GAAG;IACzB,aAAa,EAAI,GAAG;IACpB,UAAU,EAAI,GAAG;IACjB,cAAc,EAAI,GAAG;IACrB,UAAU,EAAS,GAAG;IACtB,UAAU,EAAI,GAAG;IACjB,YAAY,EAAO,GAAG;IACtB,YAAY,EAAI,GAAG;IACnB,OAAO,EAAY,GAAG;IACtB,gBAAgB,EAAG,GAAG,EAAE,cAAc;IACtC,gBAAgB,EAAG,GAAG;CAClB,AA/LqB,CA+LpB"}

package/src/_esm/src/ts/Line.d.ts

@@ -0,0 +1,134 @@
+/**
+ * @author   Ikaros Kappler
+ * @date     2016-03-12
+ * @modified 2018-12-05 Refactored the code from the morley-triangle script.
+ * @modified 2019-03-20 Added JSDoc tags.
+ * @modified 2019-04-28 Fixed a bug in the Line.sub( Vertex ) function (was not working).
+ * @modified 2019-09-02 Added the Line.add( Vertex ) function.
+ * @modified 2019-09-02 Added the Line.denominator( Line ) function.
+ * @modified 2019-09-02 Added the Line.colinear( Line ) function.
+ * @modified 2019-09-02 Fixed an error in the Line.intersection( Line ) function (class Point was renamed to Vertex).
+ * @modified 2019-12-15 Added the Line.moveTo(Vertex) function.
+ * @modified 2020-03-16 The Line.angle(Line) parameter is now optional. The baseline (x-axis) will be used if not defined.
+ * @modified 2020-03-23 Ported to Typescript from JS.
+ * @modified 2020-12-04 The `intersection` function returns undefined if both lines are parallel.
+ * @modified 2022-02-02 Added the `destroy` method.
+ * @modified 2022-10-09 Changed the actual return value of the `intersection` function to null (was undefined before).
+ * @modified 2022-10-17 Adding these methods from the `PathSegment` interface: getStartPoint, getEndPoint, revert.
+ * @modified 2023-09-25 Changed param type of `intersection()` from Line to VertTuple.
+ * @modified 2025-04-15 Class `Line` now implements interface `Intersectable`.
+ * @modified 2025-04-16 Class `Line` now implements interface `IBounded`.
+ * @version  2.4.0
+ *
+ * @file Line
+ * @public
+ **/
+import { Bounds } from "./Bounds";
+import { Vector } from "./Vector";
+import { VertTuple } from "./VertTuple";
+import { Vertex } from "./Vertex";
+import { IBounded, Intersectable, PathSegment, SVGSerializable } from "./interfaces";
+/**
+ * @classdesc A line consists of two vertices a and b.<br>
+ * <br>
+ * This is some refactored code from my 'Morley Triangle' test<br>
+ *   https://github.com/IkarosKappler/morleys-trisector-theorem
+ *
+ * @requires Vertex
+ */
+export declare class Line extends VertTuple<Line> implements IBounded, Intersectable, PathSegment, SVGSerializable {
+    /**
+     * Required to generate proper CSS classes and other class related IDs.
+     **/
+    readonly className: string;
+    /**
+     * Creates an instance of Line.
+     *
+     * @constructor
+     * @name Line
+     * @param {Vertex} a The line's first point.
+     * @param {Vertex} b The line's second point.
+     **/
+    constructor(a: Vertex, b: Vertex);
+    /**
+     * Get the intersection if this line and the specified line.
+     *
+     * @method intersection
+     * @param {Line} line The second line.
+     * @return {Vertex|undefined} The intersection (may lie outside the end-points) or `undefined` if both lines are parallel.
+     * @instance
+     * @memberof Line
+     **/
+    intersection(line: VertTuple<any>): Vertex | null;
+    /**
+     * Get the bounding box (bounds) of this Line.
+     *
+     * @method getBounds
+     * @instance
+     * @memberof Line
+     * @return {Bounds} The rectangular bounds of this Line.
+     **/
+    getBounds(): Bounds;
+    /**
+     * Get the start point of this path segment.
+     *
+     * @method getStartPoint
+     * @memberof PathSegment
+     * @return {Vertex} The start point of this path segment.
+     */
+    getStartPoint(): Vertex;
+    /**
+     * Get the end point of this path segment.
+     *
+     * @method getEndPoint
+     * @memberof PathSegment
+     * @return {Vertex} The end point of this path segment.
+     */
+    getEndPoint(): Vertex;
+    /**
+     * Get the tangent's end point at the start point of this segment.
+     *
+     * @method getStartTangent
+     * @memberof PathSegment
+     * @return {Vertex} The end point of the starting point's tangent.
+     */
+    getStartTangent(): Vertex;
+    /**
+     * Get the tangent's end point at the end point of this segment.
+     *
+     * @method getEndTangent
+     * @memberof PathSegment
+     * @return {Vertex} The end point of the ending point's tangent.
+     */
+    getEndTangent(): Vertex;
+    /**
+     * Inverse this path segment (in-place) and return this same instance (useful for chaining).
+     *
+     * @method reverse
+     * @memberof PathSegment
+     * @return {PathSegment} This path segment instance (for chaining).
+     */
+    reverse(): Line;
+    /**
+     * Get all line intersections with this polygon.
+     *
+     * This method returns all intersections (as vertices) with this shape. The returned array of vertices is in no specific order.
+     *
+     * See demo `47-closest-vector-projection-on-polygon` for how it works.
+     *
+     * @param {VertTuple} line - The line to find intersections with.
+     * @param {boolean} inVectorBoundsOnly - If set to true only intersecion points on the passed vector are returned (located strictly between start and end vertex).
+     * @returns {Array<Vertex>} - An array of all intersections within the polygon bounds.
+     */
+    lineIntersections(line: VertTuple<any>, inVectorBoundsOnly?: boolean): Array<Vertex>;
+    /**
+     * Get all line intersections of this polygon and their tangents along the shape.
+     *
+     * This method returns all intersection tangents (as vectors) with this shape. The returned array of vectors is in no specific order.
+     *
+     * @param line
+     * @param inVectorBoundsOnly
+     * @returns
+     */
+    lineIntersectionTangents(line: VertTuple<any>, inVectorBoundsOnly?: boolean): Array<Vector>;
+}