@vived/app 3.8.0 → 3.9.0

package/lib/AppObjectComponents/SceneRoot/UC/PinchSceneRoot.js

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makePinchSceneRootUC = exports.PinchSceneRootUC = void 0;
+const AppObjectUC_1 = require("../../../AppObject/AppObjectUC");
+const ValueObjects_1 = require("../../../ValueObjects");
+const App_1 = require("../../App");
+const Babylon_1 = require("../../Babylon");
+const Dispatcher_1 = require("../../Dispatcher");
+const SceneRoot_1 = require("../Entities/SceneRoot");
+class PinchSceneRootUC extends AppObjectUC_1.AppObjectUC {
+    static get(appObjects) {
+        const components = appObjects.getAllComponents(PinchSceneRootUC.type);
+        if (components.length === 0) {
+            App_1.submitWarning(PinchSceneRootUC.type, `Unable to find component ${PinchSceneRootUC.type}. Add one on Mount`, appObjects);
+            return undefined;
+        }
+        else if (components.length > 1) {
+            App_1.submitWarning(PinchSceneRootUC.type, `Multiple ${PinchSceneRootUC.type} found. There should only be one. Using the first one`, appObjects);
+        }
+        return components[0];
+    }
+}
+exports.PinchSceneRootUC = PinchSceneRootUC;
+PinchSceneRootUC.type = "PinchSceneRootUC";
+function makePinchSceneRootUC(appObject) {
+    return new PinchSceneRootImp(appObject);
+}
+exports.makePinchSceneRootUC = makePinchSceneRootUC;
+class PinchSceneRootImp extends PinchSceneRootUC {
+    constructor(appObject) {
+        super(appObject, PinchSceneRootUC.type);
+        this.sensitivity = 0.01;
+        this.previousDistanceBetweenTouches = 0;
+        this.panPlane = ValueObjects_1.ParametricPlane.XY();
+        this.pickOffset = ValueObjects_1.Vector3.Zero();
+        this.initialScale = 0;
+        this.initializePinch = (touchPos1, touchPos2) => {
+            var _a, _b;
+            if (!this.sceneRoot)
+                return;
+            const transformNode = this.sceneRoot.transform;
+            this.previousDistanceBetweenTouches = this.getTouchDistance(touchPos1, touchPos2);
+            const touchCenter = this.getTouchCenter(touchPos1, touchPos2);
+            const scenePick = Babylon_1.scenePixelPick(touchCenter, this.appObjects);
+            const pickPoint = (_a = scenePick === null || scenePick === void 0 ? void 0 : scenePick.worldPickPoint) !== null && _a !== void 0 ? _a : ValueObjects_1.Vector3.Zero();
+            const pickPlaneDirection = ValueObjects_1.Vector3.Backward();
+            this.panPlane = ValueObjects_1.ParametricPlane.FromPointNormal(pickPoint, pickPlaneDirection);
+            const pickRay = Babylon_1.pixelToSceneRay(touchCenter, this.appObjects);
+            const planePick = (_b = this.panPlane.intersectLine(pickRay)) !== null && _b !== void 0 ? _b : ValueObjects_1.Vector3.Zero();
+            this.pickOffset = transformNode.worldPointToLocal(planePick);
+            this.initialScale = this.sceneRoot.scale;
+        };
+        this.doPinch = (touchPos1, touchPos2) => {
+            var _a;
+            if (!this.sceneRoot)
+                return;
+            const transformNode = this.sceneRoot.transform;
+            const currentTouchDist = this.getTouchDistance(touchPos1, touchPos2);
+            const touchDelta = currentTouchDist - this.previousDistanceBetweenTouches;
+            const currentScale = this.sceneRoot.scale;
+            const scaleDelta = touchDelta * this.sensitivity * currentScale;
+            let newScale = currentScale + scaleDelta;
+            if (newScale < this.sceneRoot.minScale) {
+                newScale = this.sceneRoot.minScale;
+            }
+            else if (newScale > this.sceneRoot.maxScale) {
+                newScale = this.sceneRoot.maxScale;
+            }
+            transformNode.worldScale = new ValueObjects_1.Vector3(newScale, newScale, newScale);
+            const touchCenter = this.getTouchCenter(touchPos1, touchPos2);
+            const pickRay = Babylon_1.pixelToSceneRay(touchCenter, this.appObjects);
+            const planePick = (_a = this.panPlane.intersectLine(pickRay)) !== null && _a !== void 0 ? _a : ValueObjects_1.Vector3.Zero();
+            const globalOffset = transformNode.localPointToWorld(this.pickOffset);
+            const delta = ValueObjects_1.Vector3.Subtract(planePick, globalOffset);
+            const currentWorldPos = transformNode.worldPosition;
+            const newWorldPos = ValueObjects_1.Vector3.Add(currentWorldPos, delta);
+            transformNode.worldPosition = newWorldPos;
+            this.previousDistanceBetweenTouches = currentTouchDist;
+        };
+        this.finishPinch = () => {
+            var _a;
+            if (this.initialScale === ((_a = this.sceneRoot) === null || _a === void 0 ? void 0 : _a.scale))
+                return;
+            Dispatcher_1.dispatchStateChange(this.appObjects);
+        };
+        this.appObjects = appObject.appObjectRepo;
+        this.sceneRoot = appObject.getComponent(SceneRoot_1.SceneRoot.type);
+        if (!this.sceneRoot) {
+            App_1.submitWarning("PinchSceneRootUC", "PinchSceneRootUC UC has been added to an App Object that does not have a SceneRoot Entity", this.appObjects);
+            return;
+        }
+    }
+    getTouchCenter(t1, t2) {
+        const delta = ValueObjects_1.Vector2.Subtract(t2, t1);
+        const halfDelta = ValueObjects_1.Vector2.NewVectorOfLength(delta.unit, 0.5 * delta.magnitued);
+        return ValueObjects_1.Vector2.Add(t1, halfDelta);
+    }
+    getTouchDistance(t1, t2) {
+        const delta = ValueObjects_1.Vector2.Subtract(t2, t1);
+        return delta.magnitued;
+    }
+}

package/lib/AppObjectComponents/SceneRoot/UC/ScaleSceneRootWithRay.d.ts

@@ -0,0 +1,14 @@
+import { AppObject } from "../../../AppObject/AppObject";
+import { AppObjectUC } from "../../../AppObject/AppObjectUC";
+import { ParametricLine, Vector3 } from "../../../ValueObjects";
+export declare class ScaleSceneRootWithRay extends AppObjectUC {
+    static readonly type = "ScaleSceneRootWithRay";
+    readonly sensitivity = 10;
+    private appObjects;
+    private sceneRoot?;
+    private pickPoint;
+    private lastDistance;
+    doScale: (pickRay: ParametricLine, rayStart: Vector3) => void;
+    initializeScale: (pickRay: ParametricLine, rayStart: Vector3) => void;
+    constructor(appObject: AppObject);
+}

package/lib/AppObjectComponents/SceneRoot/UC/ScaleSceneRootWithRay.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScaleSceneRootWithRay = void 0;
+const AppObjectUC_1 = require("../../../AppObject/AppObjectUC");
+const ValueObjects_1 = require("../../../ValueObjects");
+const Babylon_1 = require("../../Babylon");
+const SceneRoot_1 = require("../Entities/SceneRoot");
+class ScaleSceneRootWithRay extends AppObjectUC_1.AppObjectUC {
+    constructor(appObject) {
+        super(appObject, ScaleSceneRootWithRay.type);
+        this.sensitivity = 10;
+        this.pickPoint = ValueObjects_1.Vector3.Zero();
+        this.lastDistance = 0;
+        this.doScale = (pickRay, rayStart) => {
+            if (!this.sceneRoot)
+                return;
+            const newDistance = ValueObjects_1.Vector3.Subtract(rayStart, this.pickPoint).magnitued;
+            const distanceChange = newDistance - this.lastDistance;
+            const currentScale = this.sceneRoot.scale;
+            const scaleDelta = distanceChange * this.sensitivity * currentScale;
+            this.sceneRoot.bumpScaleAboutPoint(scaleDelta, this.pickPoint);
+            this.lastDistance = newDistance;
+        };
+        this.initializeScale = (pickRay, rayStart) => {
+            var _a;
+            const pick = Babylon_1.sceneRayPick(pickRay, this.appObjects);
+            this.pickPoint = (_a = pick === null || pick === void 0 ? void 0 : pick.worldPickPoint) !== null && _a !== void 0 ? _a : ValueObjects_1.Vector3.Zero();
+            this.lastDistance = ValueObjects_1.Vector3.Subtract(rayStart, this.pickPoint).magnitued;
+        };
+        this.appObjects = appObject.appObjectRepo;
+        this.sceneRoot = appObject.getComponent(SceneRoot_1.SceneRoot.type);
+        if (!this.sceneRoot) {
+            console.warn("ScaleSceneRootWithRay added to an app object that does not have a SceneRootEntity");
+        }
+    }
+}
+exports.ScaleSceneRootWithRay = ScaleSceneRootWithRay;
+ScaleSceneRootWithRay.type = "ScaleSceneRootWithRay";

package/lib/AppObjectComponents/StateMachine/Entities/StateMachineEntity.d.ts

@@ -0,0 +1,30 @@
+import { AppObject } from "../../../AppObject/AppObject";
+import { AppObjectEntity } from "../../../AppObject/AppObjectEntity";
+import { AppObjectRepo } from "../../../AppObject/AppObjectRepo";
+export interface SerializedStates {
+    version: number;
+    systems: SystemState[];
+}
+export interface SystemState {
+    name: string;
+    seriliziationVersion: number;
+    state: object;
+}
+export interface SerializedSystem {
+    name: string;
+    seriliziationVersion: number;
+    getSystemState(): object;
+    applySystemState(state: object, version: number, transitionDuration: number): void;
+    applyDefaultState(transitionDuration: number): void;
+}
+export declare abstract class StateMachineEntity extends AppObjectEntity {
+    static readonly type = "StateMachineEntity";
+    abstract transitionEaseFunction: (normalizedTime: number) => number;
+    abstract getSerializedStates(): SerializedStates;
+    abstract setSerializedStates(state: SerializedStates, transitionTime: number): void;
+    abstract applySerializedStatesString: (state: string, duration?: number) => void;
+    abstract setDefaultState(transitionTime: number): void;
+    abstract registerSerializedSystem(serializedSystem: SerializedSystem): void;
+    static get(appObjects: AppObjectRepo): StateMachineEntity | undefined;
+}
+export declare function makeStateMachineEntity(appObject: AppObject): StateMachineEntity;

package/lib/AppObjectComponents/StateMachine/Entities/StateMachineEntity.js

@@ -0,0 +1,105 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeStateMachineEntity = exports.StateMachineEntity = void 0;
+const AppObjectEntity_1 = require("../../../AppObject/AppObjectEntity");
+const App_1 = require("../../App");
+class StateMachineEntity extends AppObjectEntity_1.AppObjectEntity {
+    static get(appObjects) {
+        const components = appObjects.getAllComponents(StateMachineEntity.type);
+        if (components.length === 0) {
+            App_1.submitWarning("StateMachineEntity", `Unable to find component ${StateMachineEntity.type}. Add one on Mount`, appObjects);
+            return undefined;
+        }
+        else if (components.length > 1) {
+            App_1.submitWarning("StateMachineEntity", `Multiple ${StateMachineEntity.type} found. There should only be one. Using the first one`, appObjects);
+        }
+        return components[0];
+    }
+}
+exports.StateMachineEntity = StateMachineEntity;
+StateMachineEntity.type = "StateMachineEntity";
+function makeStateMachineEntity(appObject) {
+    return new StateMachineImp(appObject);
+}
+exports.makeStateMachineEntity = makeStateMachineEntity;
+class StateMachineImp extends StateMachineEntity {
+    constructor(appObject) {
+        super(appObject, StateMachineEntity.type);
+        this.serializedSystems = new Map();
+        this.serilizationVersion = 2;
+        this.transitionEaseFunction = (normalizedTime) => {
+            return normalizedTime; // default to a linear function
+        };
+        this.applySerializedStatesString = (state, duration = 0) => {
+            if (state === "") {
+                this.setDefaultState(duration);
+            }
+            else {
+                try {
+                    const stateObj = JSON.parse(state);
+                    this.setSerializedStates(stateObj, duration);
+                }
+                catch (e) {
+                    this.setDefaultState(duration);
+                    App_1.submitWarning("StateMachineEntity", `Failed to deserialize state string ${state} with Error ${e.message}`, this.appObject.appObjectRepo);
+                }
+            }
+        };
+        this.registerSerializedSystem = (serializedSystem) => {
+            if (this.serializedSystems.has(serializedSystem.name)) {
+                App_1.submitError("StateMachineEntity", `Duplicate stateable systems encountered: ${serializedSystem.name}`, this.appObject.appObjectRepo);
+                return;
+            }
+            this.serializedSystems.set(serializedSystem.name, serializedSystem);
+            return;
+        };
+        this.getSerializedStates = () => {
+            const systems = Array.from(this.serializedSystems.values());
+            const serializedStates = systems.map((system) => {
+                const state = system.getSystemState();
+                return {
+                    seriliziationVersion: system.seriliziationVersion,
+                    name: system.name,
+                    state,
+                };
+            });
+            return {
+                version: this.serilizationVersion,
+                systems: serializedStates,
+            };
+        };
+        this.setSerializedStates = (states, duration) => {
+            if (states.version === 2) {
+                const appliedToSystems = [];
+                states.systems.forEach((systemState) => {
+                    const seriliazableSystem = this.serializedSystems.get(systemState.name);
+                    if (seriliazableSystem) {
+                        seriliazableSystem.applySystemState(systemState.state, systemState.seriliziationVersion, duration);
+                    }
+                    else {
+                        App_1.submitWarning("StateMachineEntity", `Unable to find seriarializedSystem ${systemState.name}`, this.appObject.appObjectRepo);
+                    }
+                    appliedToSystems.push(systemState.name);
+                });
+                this.serializedSystems.forEach((system) => {
+                    if (!appliedToSystems.includes(system.name)) {
+                        system.applyDefaultState(duration);
+                    }
+                });
+                this.notifyOnChange();
+                return;
+            }
+            // Here is where we will add support for future versions
+            else {
+                App_1.submitError("StateMachineEntity", `Unsupported sereialized state encountered: ${states.version}`, this.appObject.appObjectRepo);
+                return;
+            }
+        };
+        this.setDefaultState = (duration) => {
+            this.serializedSystems.forEach((system) => {
+                system.applyDefaultState(duration);
+            });
+            this.notifyOnChange();
+        };
+    }
+}

package/lib/AppObjectComponents/StateMachine/index.d.ts

@@ -0,0 +1 @@
+export * from "./Entities/StateMachineEntity";

package/lib/AppObjectComponents/StateMachine/index.js

@@ -0,0 +1,13 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./Entities/StateMachineEntity"), exports);

package/lib/AppObjectComponents/Tools/Controller/ToolHotkeys.d.ts

@@ -0,0 +1,9 @@
+import { AppObject } from "../../../AppObject/AppObject";
+import { AppObjectController } from "../../../AppObject/AppObjectController";
+import { KeyboardController } from "../../KeyboardInput";
+export declare class ToolHotkeys<ToolTypes> extends AppObjectController implements KeyboardController {
+    static readonly type = "ToolHotkeys";
+    private toolRepo?;
+    onKeyDown: (e: KeyboardEvent) => void;
+    constructor(appObject: AppObject);
+}

package/lib/AppObjectComponents/Tools/Controller/ToolHotkeys.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ToolHotkeys = void 0;
+const __1 = require("../..");
+const AppObjectController_1 = require("../../../AppObject/AppObjectController");
+const KeyboardInput_1 = require("../../KeyboardInput");
+const ToolRepository_1 = require("../Entities/ToolRepository");
+class ToolHotkeys extends AppObjectController_1.AppObjectController {
+    constructor(appObject) {
+        super(appObject, ToolHotkeys.type);
+        this.onKeyDown = (e) => {
+            if (!this.toolRepo)
+                return;
+            if (e.repeat)
+                return;
+            const currentKey = {
+                keyCode: e.code,
+                alt: e.altKey,
+                control: e.ctrlKey,
+                meta: e.metaKey,
+                shift: e.shiftKey,
+            };
+            const tool = this.toolRepo.getToolForHotkey(currentKey);
+            if (!tool)
+                return;
+            this.toolRepo.triggerTool(tool.toolType);
+        };
+        this.toolRepo = appObject.getComponent(ToolRepository_1.ToolRepository.type);
+        if (!this.toolRepo) {
+            __1.submitWarning("ToolHotkeys", "Controller has been added to an App Object that does not have ToolRepository. Add one first.", appObject.appObjectRepo);
+            return;
+        }
+        const keyboardInput = KeyboardInput_1.KeyboardInputEntity.get(appObject.appObjectRepo);
+        if (keyboardInput) {
+            keyboardInput.registerController(this);
+        }
+        else {
+            __1.submitWarning("ToolHotkeys", "Unable to find KeyboardInputEntity", appObject.appObjectRepo);
+        }
+    }
+}
+exports.ToolHotkeys = ToolHotkeys;
+ToolHotkeys.type = "ToolHotkeys";

package/lib/AppObjectComponents/Tools/Controller/triggerTool.d.ts

@@ -0,0 +1,2 @@
+import { AppObjectRepo } from "../../../AppObject/AppObjectRepo";
+export declare function triggerTool<ToolTypes>(toolType: ToolTypes, appObjects: AppObjectRepo): void;

package/lib/AppObjectComponents/Tools/Controller/triggerTool.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.triggerTool = void 0;
+const App_1 = require("../../App");
+const ToolRepository_1 = require("../Entities/ToolRepository");
+function triggerTool(toolType, appObjects) {
+    const repo = ToolRepository_1.ToolRepository.get(appObjects);
+    if (!repo) {
+        App_1.submitWarning("triggerTool", "Unable to find ToolRepository", appObjects);
+        return;
+    }
+    repo.triggerTool(toolType);
+}
+exports.triggerTool = triggerTool;

package/lib/AppObjectComponents/Tools/Entities/ToolEntity.d.ts

@@ -0,0 +1,39 @@
+import { AppObject } from "../../../AppObject/AppObject";
+import { AppObjectEntity } from "../../../AppObject/AppObjectEntity";
+export declare enum ToolState {
+    HIDDEN = "HIDDEN",
+    DISABLED = "DISABLED",
+    ENABLED = "ENABLED",
+    ACTIVE = "ACTIVE"
+}
+export interface ToolData<ToolTypes> {
+    toolType: ToolTypes;
+    isDefault: boolean;
+    label: string;
+    shortcutLabel: string;
+    hotkeys: HotKey[];
+}
+export interface HotKey {
+    keyCode: string;
+    control?: boolean;
+    shift?: boolean;
+    meta?: boolean;
+    alt?: boolean;
+}
+export declare abstract class ToolEntity<ToolTypes> extends AppObjectEntity {
+    static readonly type = "TOOL";
+    abstract readonly toolType: ToolTypes;
+    abstract get label(): string;
+    abstract set label(toolLabel: string);
+    abstract readonly isDefault: boolean;
+    abstract get shortcutLabel(): string;
+    abstract set shortcutLabel(shorcut: string);
+    abstract get state(): ToolState;
+    abstract set state(val: ToolState);
+    abstract readonly hotkeys: HotKey[];
+    abstract get isAction(): boolean;
+    abstract triggerActions(): void;
+    abstract registerAction(action: () => void): void;
+    abstract isMyHotkey(hotkey: HotKey): boolean;
+}
+export declare function makeToolEntity<ToolTypes>(data: ToolData<ToolTypes>, appObject: AppObject): ToolEntity<ToolTypes>;

package/lib/AppObjectComponents/Tools/Entities/ToolEntity.js

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeToolEntity = exports.ToolEntity = exports.ToolState = void 0;
+const AppObjectEntity_1 = require("../../../AppObject/AppObjectEntity");
+const Entities_1 = require("../../../Entities");
+var ToolState;
+(function (ToolState) {
+    ToolState["HIDDEN"] = "HIDDEN";
+    ToolState["DISABLED"] = "DISABLED";
+    ToolState["ENABLED"] = "ENABLED";
+    ToolState["ACTIVE"] = "ACTIVE";
+})(ToolState = exports.ToolState || (exports.ToolState = {}));
+class ToolEntity extends AppObjectEntity_1.AppObjectEntity {
+}
+exports.ToolEntity = ToolEntity;
+ToolEntity.type = "TOOL";
+function makeToolEntity(data, appObject) {
+    return new ToolEntityImp(data, appObject);
+}
+exports.makeToolEntity = makeToolEntity;
+class ToolEntityImp extends ToolEntity {
+    constructor(data, appObject) {
+        super(appObject, ToolEntity.type);
+        this.memoizedState = new Entities_1.MemoizedString(ToolState.ENABLED, this.notifyOnChange);
+        this.actions = [];
+        this._isAction = false;
+        this.registerAction = (action) => {
+            this.actions.push(action);
+            this._isAction = true;
+        };
+        this.triggerActions = () => {
+            this.actions.forEach((action) => {
+                action();
+            });
+        };
+        this.isMyHotkey = (hotkey) => {
+            let isMine = false;
+            this.hotkeys.forEach((myHotkey) => {
+                if (this.hotkeysMatch(myHotkey, hotkey)) {
+                    isMine = true;
+                }
+            });
+            return isMine;
+        };
+        this.toolType = data.toolType;
+        this.memoizedLabel = new Entities_1.MemoizedString(data.label, this.notifyOnChange);
+        this.isDefault = data.isDefault;
+        this.memoizedShortcut = new Entities_1.MemoizedString(data.shortcutLabel, this.notifyOnChange);
+        this.hotkeys = data.hotkeys;
+    }
+    get label() {
+        return this.memoizedLabel.val;
+    }
+    set label(toolLabel) {
+        this.memoizedLabel.val = toolLabel;
+    }
+    get shortcutLabel() {
+        return this.memoizedShortcut.val;
+    }
+    set shortcutLabel(shorcut) {
+        this.memoizedShortcut.val = shorcut;
+    }
+    get state() {
+        return this.memoizedState.val;
+    }
+    set state(val) {
+        this.memoizedState.val = val;
+    }
+    get isAction() {
+        return this._isAction;
+    }
+    hotkeysMatch(a, b) {
+        if (a.keyCode !== b.keyCode)
+            return false;
+        const aComplete = this.fillInMissingModifiers(a);
+        const bComplete = this.fillInMissingModifiers(b);
+        if (aComplete.alt !== bComplete.alt)
+            return false;
+        if (aComplete.control !== bComplete.control)
+            return false;
+        if (aComplete.meta !== bComplete.meta)
+            return false;
+        if (aComplete.shift !== bComplete.shift)
+            return false;
+        return true;
+    }
+    fillInMissingModifiers(hotkey) {
+        const rVal = Object.assign({}, hotkey);
+        rVal.alt = hotkey.alt === undefined ? false : hotkey.alt;
+        rVal.control = hotkey.control === undefined ? false : hotkey.control;
+        rVal.meta = hotkey.meta === undefined ? false : hotkey.meta;
+        rVal.shift = hotkey.shift === undefined ? false : hotkey.shift;
+        return rVal;
+    }
+}

package/lib/AppObjectComponents/Tools/Entities/ToolRepository.d.ts

@@ -0,0 +1,17 @@
+import { AppObject } from "../../../AppObject/AppObject";
+import { AppObjectEntity } from "../../../AppObject/AppObjectEntity";
+import { AppObjectRepo } from "../../../AppObject/AppObjectRepo";
+import { HotKey, ToolData, ToolEntity } from "./ToolEntity";
+export declare abstract class ToolRepository<ToolTypes> extends AppObjectEntity {
+    static readonly type = "TOOL_REPOSITORY";
+    abstract get activeTool(): ToolEntity<ToolTypes> | undefined;
+    abstract get allTools(): ToolEntity<ToolTypes>[];
+    abstract setupToolsFromData(toolData: ToolData<ToolTypes>[]): void;
+    abstract getTool(toolType: ToolTypes): ToolEntity<ToolTypes> | undefined;
+    abstract getToolForHotkey(hotkey: HotKey): ToolEntity<ToolTypes> | undefined;
+    abstract setDefaultToolActive(): void;
+    abstract triggerTool(toolType: ToolTypes): void;
+    abstract toggleToolVisibility(toolType: ToolTypes): void;
+    static get<ToolTypes>(appObjects: AppObjectRepo): ToolRepository<ToolTypes> | undefined;
+}
+export declare function makeToolRepo<ToolTypes>(appObject: AppObject): ToolRepository<ToolTypes>;

package/lib/AppObjectComponents/Tools/Entities/ToolRepository.js

@@ -0,0 +1,132 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeToolRepo = exports.ToolRepository = void 0;
+const AppObjectEntity_1 = require("../../../AppObject/AppObjectEntity");
+const App_1 = require("../../App");
+const setupTool_1 = require("../Factories/setupTool");
+const ToolEntity_1 = require("./ToolEntity");
+class ToolRepository extends AppObjectEntity_1.AppObjectEntity {
+    static get(appObjects) {
+        const components = appObjects.getAllComponents(ToolRepository.type);
+        if (components.length === 0) {
+            App_1.submitWarning("ToolRepository", `Unable to find component ${ToolRepository.type}. Add one on Mount`, appObjects);
+            return undefined;
+        }
+        else if (components.length > 1) {
+            App_1.submitWarning("ToolRepository", `Multiple ${ToolRepository.type} found. There should only be one. Using the first one`, appObjects);
+        }
+        return components[0];
+    }
+}
+exports.ToolRepository = ToolRepository;
+ToolRepository.type = "TOOL_REPOSITORY";
+function makeToolRepo(appObject) {
+    return new ToolRepositoryImp(appObject);
+}
+exports.makeToolRepo = makeToolRepo;
+class ToolRepositoryImp extends ToolRepository {
+    constructor(appObject) {
+        super(appObject, ToolRepository.type);
+        this.toolLookup = new Map();
+    }
+    get allTools() {
+        return Array.from(this.toolLookup.values());
+    }
+    setDefaultToolActive() {
+        if (this._defaultToolType !== undefined) {
+            this.triggerTool(this._defaultToolType);
+        }
+        else {
+            console.warn(`[ToolRepository] No default tools has been specified`);
+        }
+    }
+    setupToolsFromData(toolDatas) {
+        toolDatas.forEach((toolData) => {
+            const toolType = toolData.toolType;
+            if (this.toolLookup.has(toolType)) {
+                console.warn(`[ToolRepository] A tool with the ID ${toolData.toolType} already exists. Replacing`);
+            }
+            const tool = setupTool_1.setupTool(toolData, this.appObject.appObjectRepo);
+            this.toolLookup.set(toolType, tool);
+            if (toolData.isDefault) {
+                if (this._defaultToolType) {
+                    console.warn(`[ToolRepository] More than one tools is marked as default. Replacing`);
+                }
+                this._defaultToolType = toolType;
+            }
+        });
+        if (!this._defaultToolType) {
+            console.warn(`[ToolRepository] No default tools was specified. Defaulting to the first tool in the list`);
+            this._defaultToolType = Array.from(this.toolLookup.keys())[0];
+        }
+        if (this._defaultToolType) {
+            this.triggerTool(this._defaultToolType);
+        }
+    }
+    getTool(type) {
+        return this.toolLookup.get(type);
+    }
+    getToolForHotkey(hotkey) {
+        let tool;
+        this.allTools.forEach((t) => {
+            if (t.isMyHotkey(hotkey)) {
+                tool = t;
+            }
+        });
+        return tool;
+    }
+    get activeTool() {
+        if (!this._activeToolType)
+            return undefined;
+        return this.getTool(this._activeToolType);
+    }
+    triggerTool(type) {
+        if (this._activeToolType === type)
+            return;
+        const newActiveTool = this.toolLookup.get(type);
+        if (!newActiveTool) {
+            console.warn(`[ToolRepository] Unable to find tool ${type}`);
+            return;
+        }
+        if (newActiveTool.isAction) {
+            newActiveTool.triggerActions();
+            return;
+        }
+        if (newActiveTool.state === ToolEntity_1.ToolState.DISABLED) {
+            return;
+        }
+        if (newActiveTool.state === ToolEntity_1.ToolState.HIDDEN) {
+            return;
+        }
+        this.toolLookup.forEach((tool) => {
+            if (tool.toolType === type) {
+                this._activeToolType = type;
+                tool.state = ToolEntity_1.ToolState.ACTIVE;
+            }
+            else if (tool.state === ToolEntity_1.ToolState.ACTIVE) {
+                tool.state = ToolEntity_1.ToolState.ENABLED;
+            }
+        });
+        this.notifyOnChange();
+    }
+    toggleToolVisibility(type) {
+        const tool = this.getTool(type);
+        if (!tool) {
+            console.warn(`[ToolRepository] Unable to find tool to toggle: ${type}`);
+            return;
+        }
+        if (tool.toolType === this._defaultToolType) {
+            console.warn(`[ToolRepository] The default tool's visibility cannot be toggled`);
+            return;
+        }
+        if (tool.state === ToolEntity_1.ToolState.HIDDEN) {
+            tool.state = ToolEntity_1.ToolState.ENABLED;
+        }
+        else {
+            if (tool.state === ToolEntity_1.ToolState.ACTIVE) {
+                this.setDefaultToolActive();
+            }
+            tool.state = ToolEntity_1.ToolState.HIDDEN;
+        }
+    }
+}