@vived/app 3.0.2 → 3.1.1

package/lib/AppObject/AppObjectPM.d.ts

@@ -7,9 +7,9 @@ export declare abstract class AppObjectPM<T> implements AppObjectComponent {
     private _lastVM?;
     get lastVM(): T | undefined;
     private observerList;
-    addView: (updateView: (vm: T) => void) => void;
-    removeView: (updateView: (vm: T) => void) => void;
-    doUpdateView: (vm: T) => void;
+    addView(updateView: (vm: T) => void): void;
+    removeView(updateView: (vm: T) => void): void;
+    doUpdateView(vm: T): void;
     dispose(): void;
     constructor(appObject: AppObject, type: string);
 }

package/lib/AppObject/AppObjectPM.js

@@ -5,22 +5,6 @@ const Entities_1 = require("../Entities");
 class AppObjectPM {
     constructor(appObject, type) {
         this.observerList = new Entities_1.ObserverList();
-        this.addView = (updateView) => {
-            this.observerList.add(updateView);
-            if (this._lastVM) {
-                updateView(this._lastVM);
-            }
-        };
-        this.removeView = (updateView) => {
-            this.observerList.remove(updateView);
-        };
-        this.doUpdateView = (vm) => {
-            if (this._lastVM && this.vmsAreEqual(this._lastVM, vm)) {
-                return;
-            }
-            this._lastVM = vm;
-            this.observerList.notify(vm);
-        };
         this.type = type;
         this.appObject = appObject;
         appObject.addComponent(this);
@@ -28,6 +12,25 @@ class AppObjectPM {
     get lastVM() {
         return this._lastVM;
     }
+    addView(updateView) {
+        this.observerList.add(updateView);
+        if (this._lastVM) {
+            updateView(this._lastVM);
+        }
+    }
+    ;
+    removeView(updateView) {
+        this.observerList.remove(updateView);
+    }
+    ;
+    doUpdateView(vm) {
+        if (this._lastVM && this.vmsAreEqual(this._lastVM, vm)) {
+            return;
+        }
+        this._lastVM = vm;
+        this.observerList.notify(vm);
+    }
+    ;
     dispose() {
         this.observerList.clear();
         if (this.appObject.getComponent(this.type) === this) {

package/lib/AppObjectComponents/Hideable/PresentationManagers/IsHiddenPM.js

@@ -13,6 +13,7 @@ class IsHiddenPM extends AppObjectPM_1.AppObjectPM {
         };
         this.dispose = () => {
             var _a, _b;
+            super.dispose();
             (_a = this.hideable) === null || _a === void 0 ? void 0 : _a.removeChangeObserver(this.onIsHiddenChange);
             (_b = this.hideable) === null || _b === void 0 ? void 0 : _b.removeOnDisposeObserver(this.dispose);
         };
@@ -23,7 +24,7 @@ class IsHiddenPM extends AppObjectPM_1.AppObjectPM {
         }
         else {
             this.hideable.addChangeObserver(this.onIsHiddenChange);
-            this.hideable.addOnDisposeObserver(() => this.dispose());
+            this.hideable.addOnDisposeObserver(this.dispose);
             this.onIsHiddenChange();
         }
     }

package/lib/AppObjectComponents/Label/PresentationManagers/LabelPM.js

@@ -28,7 +28,7 @@ class LabelPM extends AppObject_1.AppObjectPM {
         this.label = Label_1.Label.get(appObject);
         if (this.label) {
             this.label.addChangeObserver(this.onLabelChange);
-            this.label.addOnDisposeObserver(() => this.dispose());
+            this.label.addOnDisposeObserver(this.dispose);
             this.onLabelChange();
         }
         else {

package/lib/AppObjectComponents/OverlayColor/PresentationManagers/OverlayColorPM.js

@@ -13,6 +13,7 @@ class OverlayColorPM extends AppObjectPM_1.AppObjectPM {
         };
         this.dispose = () => {
             var _a, _b;
+            super.dispose();
             (_a = this.overlayColor) === null || _a === void 0 ? void 0 : _a.removeChangeObserver(this.onColorChange);
             (_b = this.overlayColor) === null || _b === void 0 ? void 0 : _b.removeOnDisposeObserver(this.dispose);
         };
@@ -23,7 +24,7 @@ class OverlayColorPM extends AppObjectPM_1.AppObjectPM {
         }
         else {
             this.overlayColor.addChangeObserver(this.onColorChange);
-            this.overlayColor.addOnDisposeObserver(() => this.dispose());
+            this.overlayColor.addOnDisposeObserver(this.dispose);
             this.onColorChange();
         }
     }

package/lib/AppObjectComponents/SceneRoot/Entities/SceneRoot.d.ts

@@ -0,0 +1,31 @@
+import { AppObject } from "../../../AppObject/AppObject";
+import { AppObjectEntity } from "../../../AppObject/AppObjectEntity";
+import { AppObjectRepo } from "../../../AppObject/AppObjectRepo";
+import { EaseFn } from "../../../Types";
+import { Quaternion, Vector3 } from "../../../ValueObjects";
+import { Transform3D } from "../../Transform3D";
+export interface DefaultSceneRootData {
+    position: [number, number, number];
+    rotation: [number, number, number, number];
+    scale: number;
+    minScale: number;
+    maxScale: number;
+}
+export declare abstract class SceneRoot extends AppObjectEntity {
+    static readonly type = "SCENE_ROOT";
+    abstract defaultPosition: Vector3;
+    abstract defaultRoation: Quaternion;
+    abstract defaultScale: number;
+    abstract minScale: number;
+    abstract maxScale: number;
+    abstract position: Vector3;
+    abstract rotation: Quaternion;
+    abstract scale: number;
+    abstract readonly transform: Transform3D;
+    abstract applyDefaultData: (data: DefaultSceneRootData) => void;
+    abstract centerOnPoint: (point: Vector3, durationMS: number, easeFn: EaseFn, onCompleted?: () => void) => void;
+    abstract lerpToDefault: (durationMS: number, easeFn: EaseFn, onCompleted?: () => void) => void;
+    abstract bumpScaleAboutPoint: (amount: number, worldPoint: Vector3) => void;
+    static get(appObjects: AppObjectRepo): SceneRoot | undefined;
+}
+export declare function makeSceneRoot(appObj: AppObject): SceneRoot;

package/lib/AppObjectComponents/SceneRoot/Entities/SceneRoot.js

@@ -0,0 +1,106 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeSceneRoot = exports.SceneRoot = void 0;
+const AppObjectEntity_1 = require("../../../AppObject/AppObjectEntity");
+const ValueObjects_1 = require("../../../ValueObjects");
+const Transform3D_1 = require("../../Transform3D");
+class SceneRoot extends AppObjectEntity_1.AppObjectEntity {
+    static get(appObjects) {
+        const repo = appObjects.getAllComponents(SceneRoot.type);
+        if (repo.length === 0) {
+            console.warn("[SceneRoot] Unable to find Scene Root Entity. Add one on Mount");
+            return undefined;
+        }
+        else if (repo.length > 1) {
+            console.warn("[SceneRoot] Multiple Scene Root Entity have been found. There should only be one. Using the first one");
+        }
+        return repo[0];
+    }
+}
+exports.SceneRoot = SceneRoot;
+SceneRoot.type = "SCENE_ROOT";
+function makeSceneRoot(appObj) {
+    Transform3D_1.Transform3D.addIfMissing(appObj);
+    return new SceneRootImp(appObj);
+}
+exports.makeSceneRoot = makeSceneRoot;
+class SceneRootImp extends SceneRoot {
+    constructor(appObject) {
+        super(appObject, SceneRoot.type);
+        this._defaultPosition = ValueObjects_1.Vector3.Zero();
+        this._defaultRoation = ValueObjects_1.Quaternion.Identity();
+        this._defaultScale = 1;
+        this._minScale = 0.01;
+        this._maxScale = 10;
+        this.applyDefaultData = (data) => {
+            this._defaultPosition = ValueObjects_1.Vector3.FromArray(data.position);
+            this._defaultRoation = ValueObjects_1.Quaternion.FromArray(data.rotation);
+            this._defaultScale = data.scale;
+            this._maxScale = data.maxScale;
+            this._minScale = data.minScale;
+        };
+        this.centerOnPoint = (point, durationMS, easeFn, onCompleted) => {
+            const finalPosition = ValueObjects_1.Vector3.Subtract(this.transform.worldPosition, point);
+            this.transform.lerp(durationMS, easeFn, finalPosition, undefined, undefined, onCompleted);
+        };
+        this.bumpScaleAboutPoint = (amount, worldPoint) => {
+            const localPickOffset = this.transform.worldPointToLocal(worldPoint);
+            const currentScale = this.transform.worldScale.x;
+            let newScale = currentScale + amount;
+            if (newScale < this.minScale) {
+                newScale = this.minScale;
+            }
+            else if (newScale > this.maxScale) {
+                newScale = this.maxScale;
+            }
+            this.transform.worldScale = new ValueObjects_1.Vector3(newScale, newScale, newScale);
+            const worldPickOffset = this.transform.localPointToWorld(localPickOffset);
+            const bump = ValueObjects_1.Vector3.Subtract(worldPoint, worldPickOffset);
+            this.transform.worldPosition = ValueObjects_1.Vector3.Add(bump, this.transform.worldPosition);
+        };
+        this.lerpToDefault = (durationMS, easeFn, onCompleted) => {
+            this.transform.lerp(durationMS, easeFn, this.defaultPosition, this.defaultRoation, new ValueObjects_1.Vector3(this.defaultScale, this.defaultScale, this.defaultScale), onCompleted);
+        };
+        const transform = Transform3D_1.Transform3D.get(appObject);
+        if (transform) {
+            this.transform = transform;
+            transform.addChangeObserver(this.notifyOnChange);
+        }
+        else {
+            throw Error("Scene Root does not have a Transform3D Component. Use the factory to make this");
+        }
+    }
+    get position() {
+        return this.transform.localPosition;
+    }
+    set position(p) {
+        this.transform.localPosition = p;
+    }
+    get rotation() {
+        return this.transform.localRotation;
+    }
+    set rotation(r) {
+        this.transform.localRotation = r;
+    }
+    get scale() {
+        return this.transform.localScale.x;
+    }
+    set scale(s) {
+        this.transform.localScale = new ValueObjects_1.Vector3(s, s, s);
+    }
+    get defaultPosition() {
+        return this._defaultPosition;
+    }
+    get defaultRoation() {
+        return this._defaultRoation;
+    }
+    get defaultScale() {
+        return this._defaultScale;
+    }
+    get minScale() {
+        return this._minScale;
+    }
+    get maxScale() {
+        return this._maxScale;
+    }
+}

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

@@ -0,0 +1,31 @@
+import { AppObject } from "../../../AppObject/AppObject";
+import { AppObjectUC } from "../../../AppObject/AppObjectUC";
+import { SerializedSystem, StateMachine } from "../../../Entities";
+export declare abstract class SerializeSceneRoot extends AppObjectUC implements SerializedSystem {
+    static readonly type = "SerializeSceneRoot";
+    name: string;
+    abstract seriliziationVersion: number;
+    abstract getSystemState(): object;
+    abstract applySystemState(state: object, version: number, transitionDuration: number): void;
+    abstract applyDefaultState(transitionDuration: number): void;
+}
+export declare function makeSerializeSceneRoot(appObject: AppObject, stateMachine: StateMachine): SerializeSceneRoot;
+export interface SceneRootDataV1 {
+    position: [number, number, number];
+    rotation: [number, number, number, number];
+    scale: [number, number, number];
+}
+export interface SceneRootDataV2 {
+    position: {
+        x: number;
+        y: number;
+        z: number;
+    };
+    rotation: {
+        x: number;
+        y: number;
+        z: number;
+        w: number;
+    };
+    scale: number;
+}

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

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeSerializeSceneRoot = exports.SerializeSceneRoot = void 0;
+const AppObjectUC_1 = require("../../../AppObject/AppObjectUC");
+const ValueObjects_1 = require("../../../ValueObjects");
+const SceneRoot_1 = require("../Entities/SceneRoot");
+class SerializeSceneRoot extends AppObjectUC_1.AppObjectUC {
+    constructor() {
+        super(...arguments);
+        this.name = "sceneRoot";
+    }
+}
+exports.SerializeSceneRoot = SerializeSceneRoot;
+SerializeSceneRoot.type = "SerializeSceneRoot";
+function makeSerializeSceneRoot(appObject, stateMachine) {
+    return new SerializeSceneRootImp(appObject, stateMachine);
+}
+exports.makeSerializeSceneRoot = makeSerializeSceneRoot;
+class SerializeSceneRootImp extends SerializeSceneRoot {
+    constructor(appObject, stateMachine) {
+        super(appObject, SerializeSceneRoot.type);
+        this.seriliziationVersion = 2;
+        this.stateMachine = stateMachine;
+        this.sceneRoot = appObject.getComponent(SceneRoot_1.SceneRoot.type);
+        if (!this.sceneRoot) {
+            console.warn("SerializeSceneRoot UC has been added to an App Object that does not have a SceneRoot Entity. Add one before adding the UC");
+            this.dispose();
+            return;
+        }
+        stateMachine.registerSerializedSystem(this);
+    }
+    getSystemState() {
+        if (!this.sceneRoot) {
+            console.warn("[SerializeSceneRoot] No scene root entity");
+            return {};
+        }
+        const data = {
+            position: this.sceneRoot.position.dto,
+            rotation: this.sceneRoot.rotation.dto,
+            scale: this.sceneRoot.scale,
+        };
+        return data;
+    }
+    applySystemState(serializedState, version, transitionTime) {
+        try {
+            if (version === 1) {
+                const castState = serializedState;
+                this.applyV1Data(castState, transitionTime);
+            }
+            else if (version === 2) {
+                const castState = serializedState;
+                this.applyV2Data(castState, transitionTime);
+            }
+            else {
+                console.warn(`[SerializeSceneRoot] Unsupported version number ${version}. Defaulting`);
+                this.applyDefaultState(transitionTime);
+            }
+        }
+        catch (e) {
+            console.warn(`[SerializeSceneRoot] Caught when deserializing ${e}. Defaulting`);
+            this.applyDefaultState(transitionTime);
+        }
+    }
+    applyDefaultState(transitionDuration) {
+        if (!this.sceneRoot) {
+            console.warn("[SerializeSceneRoot] No scene root entity");
+            return;
+        }
+        this.sceneRoot.lerpToDefault(transitionDuration * 1000, this.stateMachine.transitionEaseFunction);
+    }
+    applyV2Data(data, transitionTime) {
+        if (!this.sceneRoot) {
+            console.warn("[SerializeSceneRoot] No scene root entity");
+            return;
+        }
+        const pos = ValueObjects_1.Vector3.FromDTO(data.position);
+        const rot = ValueObjects_1.Quaternion.FromDTO(data.rotation);
+        const scale = new ValueObjects_1.Vector3(data.scale, data.scale, data.scale);
+        const rootTransform = this.sceneRoot.transform;
+        rootTransform.lerp(transitionTime * 1000, this.stateMachine.transitionEaseFunction, pos, rot, scale);
+    }
+    applyV1Data(data, transitionTime) {
+        if (!this.sceneRoot) {
+            console.warn("[SerializeSceneRoot] No scene root entity");
+            return;
+        }
+        const pos = ValueObjects_1.Vector3.FromArray(data.position);
+        const rot = ValueObjects_1.Quaternion.FromArray(data.rotation);
+        const scale = ValueObjects_1.Vector3.FromArray(data.scale);
+        const rootTransform = this.sceneRoot.transform;
+        rootTransform.lerp(transitionTime * 1000, this.stateMachine.transitionEaseFunction, pos, rot, scale);
+    }
+}

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

@@ -0,0 +1,2 @@
+export * from "./Entities/SceneRoot";
+export * from "./UC/SerializeSceneRoot";

package/lib/AppObjectComponents/SceneRoot/index.js

@@ -0,0 +1,14 @@
+"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/SceneRoot"), exports);
+__exportStar(require("./UC/SerializeSceneRoot"), exports);

package/lib/AppObjectComponents/Transform3D/PresentationManagers/CanBeStuckPM.js

@@ -16,6 +16,7 @@ class CanBeStuckPM extends AppObjectPM_1.AppObjectPM {
         };
         this.dispose = () => {
             var _a, _b;
+            super.dispose();
             (_a = this.transform) === null || _a === void 0 ? void 0 : _a.removeChangeObserver(this.onTransformChange);
             (_b = this.transform) === null || _b === void 0 ? void 0 : _b.removeOnDisposeObserver(this.dispose);
         };
@@ -26,7 +27,7 @@ class CanBeStuckPM extends AppObjectPM_1.AppObjectPM {
         }
         else {
             this.transform.addChangeObserver(this.onTransformChange);
-            this.transform.addOnDisposeObserver(() => this.dispose());
+            this.transform.addOnDisposeObserver(this.dispose);
             this.onTransformChange();
         }
     }

package/lib/AppObjectComponents/Transform3D/PresentationManagers/Transform3DPM.js

@@ -19,6 +19,7 @@ class Transform3DPM extends AppObjectPM_1.AppObjectPM {
         };
         this.dispose = () => {
             var _a, _b;
+            super.dispose();
             (_a = this.transform) === null || _a === void 0 ? void 0 : _a.removeChangeObserver(this.onTransformChange);
             (_b = this.transform) === null || _b === void 0 ? void 0 : _b.removeOnDisposeObserver(this.dispose);
         };
@@ -29,7 +30,7 @@ class Transform3DPM extends AppObjectPM_1.AppObjectPM {
         }
         else {
             this.transform.addChangeObserver(this.onTransformChange);
-            this.transform.addOnDisposeObserver(() => this.dispose());
+            this.transform.addOnDisposeObserver(this.dispose);
             this.onTransformChange();
         }
     }

package/lib/AppObjectComponents/index.d.ts

@@ -3,4 +3,5 @@ export * from "./Hideable";
 export * from "./Label";
 export * from "./Mesh";
 export * from "./OverlayColor";
+export * from "./SceneRoot";
 export * from "./Transform3D";

package/lib/AppObjectComponents/index.js

@@ -15,4 +15,5 @@ __exportStar(require("./Hideable"), exports);
 __exportStar(require("./Label"), exports);
 __exportStar(require("./Mesh"), exports);
 __exportStar(require("./OverlayColor"), exports);
+__exportStar(require("./SceneRoot"), exports);
 __exportStar(require("./Transform3D"), exports);

package/lib/Entities/index.d.ts

@@ -20,7 +20,6 @@ export * from "./SceneModelMesh";
 export * from "./SceneModelRepo";
 export * from "./SceneObject";
 export * from "./SceneObjectsRepo";
-export * from "./SceneRoot";
 export * from "./StateMachine";
 export * from "./Tool";
 export * from "./ToolRepository";

package/lib/Entities/index.js

@@ -32,7 +32,6 @@ __exportStar(require("./SceneModelMesh"), exports);
 __exportStar(require("./SceneModelRepo"), exports);
 __exportStar(require("./SceneObject"), exports);
 __exportStar(require("./SceneObjectsRepo"), exports);
-__exportStar(require("./SceneRoot"), exports);
 __exportStar(require("./StateMachine"), exports);
 __exportStar(require("./Tool"), exports);
 __exportStar(require("./ToolRepository"), exports);

package/lib/UseCases/index.d.ts

@@ -1,9 +1,7 @@
 export * from "./setDevicePreview";
 export * from "./Handlers";
 export * from "./QuestionChallenge";
-export * from "./SceneModel";
 export * from "./LerpVector3";
-export * from "./SceneRoot";
 export * from "./HoverLabels/trySetHoverLabel";
 export * from "./HoverLabels/SerializeAllowHoverLabel";
 export * from "./setupStandardAppObjects";

package/lib/UseCases/index.js

@@ -13,9 +13,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./setDevicePreview"), exports);
 __exportStar(require("./Handlers"), exports);
 __exportStar(require("./QuestionChallenge"), exports);
-__exportStar(require("./SceneModel"), exports);
 __exportStar(require("./LerpVector3"), exports);
-__exportStar(require("./SceneRoot"), exports);
 __exportStar(require("./HoverLabels/trySetHoverLabel"), exports);
 __exportStar(require("./HoverLabels/SerializeAllowHoverLabel"), exports);
 __exportStar(require("./setupStandardAppObjects"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vived/app",
-  "version": "3.0.2",
+  "version": "3.1.1",
   "description": "Public package for the VIVED Learning App system",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",