@vived/app 4.26.2 → 4.27.1

package/lib/Entities/Babylon.d.ts

@@ -0,0 +1,48 @@
+import { ParametricLine, Vector2, Vector3 } from "../ValueObjects";
+export declare type OnBabylonChange = () => void;
+export interface ScenePick {
+    mouseRay: ParametricLine;
+    hit: boolean;
+    worldPickPoint?: Vector3;
+    objectPickMeta?: object;
+    normal?: Vector3;
+}
+export interface IScreenshotSize {
+    /**
+     * number in pixels for canvas height
+     */
+    height?: number;
+    /**
+     * multiplier allowing render at a higher or lower resolution
+     * If value is defined then height and width will be ignored and taken from camera
+     */
+    precision?: number;
+    /**
+     * number in pixels for canvas width
+     */
+    width?: number;
+}
+export interface Babylon {
+    engine: unknown;
+    scene: unknown;
+    workingCanvas?: HTMLCanvasElement;
+    showInspector: boolean;
+    renderCanvas?: HTMLCanvasElement;
+    isRendering: boolean;
+    pixelToSceneRay: (pixelPos: Vector2) => ParametricLine;
+    sceneRayPick: (ray: ParametricLine) => ScenePick | undefined;
+    scenePixelPick: (pixelPos: Vector2) => ScenePick | undefined;
+    sceneObjectRayPick: (ray: ParametricLine) => string | undefined;
+    sceneObjectPixelPick: (pixelPos: Vector2) => string | undefined;
+    captureScreenshot: (size: IScreenshotSize | number) => Promise<Blob>;
+    makeSceneObjectMeta: (id: string) => object;
+    updateCanvasSize: () => void;
+    submitRenderCanvas: (canvas: HTMLCanvasElement) => void;
+    clearRenderCanvas: () => void;
+    registerResizeEnging: (resizeEngine: () => void) => void;
+    registerStartRendering: (startRendering: (canvas: HTMLCanvasElement) => void) => void;
+    registerStopRendering: (stopRendering: (canvas: HTMLCanvasElement) => void) => void;
+    addObserver: (observer: OnBabylonChange) => void;
+    removeObserver: (observer: OnBabylonChange) => void;
+}
+export declare function makeBabylon(): Babylon;

package/lib/Entities/Babylon.js

@@ -0,0 +1,146 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeBabylon = void 0;
+const ValueObjects_1 = require("../ValueObjects");
+const MemoizedBoolean_1 = require("./Memoized/MemoizedBoolean");
+const MemoizedVector2_1 = require("./Memoized/MemoizedVector2");
+const ObserverList_1 = require("./ObserverList");
+function makeBabylon() {
+    return new BabylonImp();
+}
+exports.makeBabylon = makeBabylon;
+class BabylonImp {
+    constructor() {
+        this.observers = new ObserverList_1.ObserverList();
+        this.updateCanvasSize = () => {
+            if (!this.workingCanvas)
+                return;
+            if (!this._renderCanvas)
+                return;
+            if (this.workingCanvas.height === this._renderCanvas.height &&
+                this.workingCanvas.width === this._renderCanvas.width) {
+                return;
+            }
+            if (this.resizeEngine) {
+                this.resizeEngine();
+            }
+            this.workingCanvas.height = this._renderCanvas.height;
+            this.workingCanvas.width = this._renderCanvas.width;
+            this.observers.notify();
+        };
+        this.submitRenderCanvas = (canvas) => {
+            if (canvas === this._renderCanvas)
+                return;
+            if (this._renderCanvas && this.stopRendering) {
+                this.stopRendering(this._renderCanvas);
+            }
+            this._renderCanvas = canvas;
+            this.updateCanvasSize();
+            if (this.startRendering) {
+                this.startRendering(canvas);
+            }
+            this.observers.notify();
+        };
+        this.clearRenderCanvas = () => {
+            if (!this._renderCanvas)
+                return;
+            if (this.stopRendering) {
+                this.stopRendering(this._renderCanvas);
+            }
+            this._renderCanvas = undefined;
+            this.observers.notify();
+        };
+        this.registerResizeEnging = (resizeEngine) => {
+            this.resizeEngine = resizeEngine;
+        };
+        this.registerStartRendering = (startRendering) => {
+            this.startRendering = startRendering;
+        };
+        this.registerStopRendering = (stopRendering) => {
+            this.stopRendering = stopRendering;
+        };
+        this.addObserver = (observer) => {
+            this.observers.add(observer);
+        };
+        this.removeObserver = (observer) => {
+            this.observers.remove(observer);
+        };
+        this.makeSceneObjectMeta = (id) => {
+            return { sceneObjectID: id };
+        };
+        this.getSceneObjectIDFromMeta = (meta) => {
+            if (meta === null || meta === void 0 ? void 0 : meta.hasOwnProperty("sceneObjectID")) {
+                return meta.sceneObjectID;
+            }
+            else {
+                return;
+            }
+        };
+        this.memoizedIsRendering = new MemoizedBoolean_1.MemoizedBoolean(false, this.observers.notify);
+        this.sceneRayPick = (ray) => {
+            throw new Error("Scene ray pick has not been injected");
+        };
+        this.captureScreenshot = (size = 512) => {
+            throw new Error("CaptureScreenshot has not been injected");
+        };
+        this.sceneObjectRayPick = (ray) => {
+            try {
+                const pick = this.sceneRayPick(ray);
+                if (pick === undefined)
+                    return;
+                const sceneObjectId = this.getSceneObjectIDFromMeta(pick.objectPickMeta);
+                return sceneObjectId;
+            }
+            catch (e) {
+                console.warn(e);
+                return;
+            }
+        };
+        this.sceneObjectPixelPick = (pixelPos) => {
+            try {
+                const ray = this.pixelToSceneRay(pixelPos);
+                return this.sceneObjectRayPick(ray);
+            }
+            catch (e) {
+                console.warn(e);
+                return;
+            }
+        };
+        this.scenePixelPick = (pixelPos) => {
+            try {
+                const ray = this.pixelToSceneRay(pixelPos);
+                return this.sceneRayPick(ray);
+            }
+            catch (e) {
+                console.warn(e);
+                return;
+            }
+        };
+        this.pixelToSceneRay = (pixelPos) => {
+            throw new Error("Pixel to scene ray has not been injected");
+        };
+        this.memoizedShowInspector = new MemoizedBoolean_1.MemoizedBoolean(false, this.observers.notify);
+        this.memoizedCanvasSize = new MemoizedVector2_1.MemoizedVector2(ValueObjects_1.Vector2.One(), this.observers.notify);
+    }
+    get showInspector() {
+        return this.memoizedShowInspector.val;
+    }
+    set showInspector(val) {
+        this.memoizedShowInspector.val = val;
+    }
+    get renderCanvas() {
+        return this._renderCanvas;
+    }
+    get canvasSize() {
+        return this.memoizedCanvasSize.val;
+    }
+    set canvasSize(val) {
+        this.memoizedCanvasSize.val = val;
+    }
+    get isRendering() {
+        return this.memoizedIsRendering.val;
+    }
+    set isRendering(val) {
+        this.memoizedIsRendering.val = val;
+    }
+}

package/lib/Entities/BaseApp.d.ts

@@ -0,0 +1,9 @@
+import { ObservableEntity } from "./ObservableEntity";
+export declare type OnBaseAppChange = () => void;
+export declare abstract class BaseApp extends ObservableEntity {
+    abstract get isAuthoring(): boolean;
+    abstract set isAuthoring(val: boolean);
+    abstract startRendering: (container: HTMLElement) => void;
+    abstract stopRendering: () => void;
+}
+export declare function makeBaseApp(): BaseApp;

package/lib/Entities/BaseApp.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeBaseApp = exports.BaseApp = void 0;
+const MemoizedBoolean_1 = require("./Memoized/MemoizedBoolean");
+const ObservableEntity_1 = require("./ObservableEntity");
+class BaseApp extends ObservableEntity_1.ObservableEntity {
+}
+exports.BaseApp = BaseApp;
+function makeBaseApp() {
+    return new BaseAppImp();
+}
+exports.makeBaseApp = makeBaseApp;
+class BaseAppImp extends BaseApp {
+    constructor() {
+        super(...arguments);
+        this.startRendering = (container) => {
+            throw new Error("[Base App] Start rendering function has not been injected");
+        };
+        this.stopRendering = () => {
+            throw new Error("[Base App] Stop rendering function has not been injected");
+        };
+        this.memoizedIsAuthoring = new MemoizedBoolean_1.MemoizedBoolean(false, this.notify);
+    }
+    get isAuthoring() {
+        return this.memoizedIsAuthoring.val;
+    }
+    set isAuthoring(val) {
+        this.memoizedIsAuthoring.val = val;
+    }
+}

package/lib/Entities/DevicePreview.d.ts

@@ -0,0 +1,11 @@
+import { Vector2 } from "../ValueObjects";
+export declare type OnDevicePreviewChange = () => void;
+export interface DevicePreview {
+    useDevicePreview: boolean;
+    previewSize: Vector2;
+    setDevicePreview(x: number, y: number): void;
+    clearDevicePreview(): void;
+    addObserver(observer: OnDevicePreviewChange): void;
+    removeObserver(observer: OnDevicePreviewChange): void;
+}
+export declare function makeDevicePreview(): DevicePreview;

package/lib/Entities/DevicePreview.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeDevicePreview = void 0;
+const _1 = require(".");
+const ValueObjects_1 = require("../ValueObjects");
+function makeDevicePreview() {
+    return new DevicePreviewImp();
+}
+exports.makeDevicePreview = makeDevicePreview;
+class DevicePreviewImp {
+    constructor() {
+        this.observers = new _1.ObserverList();
+        this._usePreview = false;
+        this._previewSize = ValueObjects_1.Vector2.Zero();
+        this.setDevicePreview = (x, y) => {
+            if (this._previewSize.x === x &&
+                this._previewSize.y === y)
+                return;
+            this._usePreview = true;
+            this._previewSize = new ValueObjects_1.Vector2(x, y);
+            if (x > 0 && y > 0) {
+                this._usePreview = true;
+            }
+            else {
+                this._usePreview = false;
+            }
+            this.observers.notify();
+        };
+        this.clearDevicePreview = () => {
+            if (!this._usePreview)
+                return;
+            this._previewSize = ValueObjects_1.Vector2.Zero();
+            this._usePreview = false;
+            this.observers.notify();
+        };
+        this.addObserver = (observer) => {
+            this.observers.add(observer);
+        };
+        this.removeObserver = (observer) => {
+            this.observers.remove(observer);
+        };
+    }
+    get useDevicePreview() {
+        return this._usePreview;
+    }
+    get previewSize() {
+        return this._previewSize;
+    }
+}

package/lib/Entities/FocusCamera.d.ts

@@ -0,0 +1,70 @@
+import { Vector3 } from "../ValueObjects";
+export declare type OnFocusCameraChange = () => void;
+export interface FocusCameraLerper {
+    cancelLerp: () => void;
+}
+export interface FocusCameraData {
+    defaultAlpha?: number;
+    defaultBeta?: number;
+    defaultRadius?: number;
+    defaultTarget?: {
+        x: number;
+        y: number;
+        z: number;
+    };
+    nearClip?: number;
+    farClip?: number;
+    alphaLimit?: {
+        min: number;
+        max: number;
+    };
+    betaLimit?: {
+        min: number;
+        max: number;
+    };
+    radiusLimit?: {
+        min: number;
+        max: number;
+    };
+    targetLimit?: {
+        min: {
+            x: number;
+            y: number;
+            z: number;
+        };
+        max: {
+            x: number;
+            y: number;
+            z: number;
+        };
+    };
+}
+export interface FocusCamera {
+    alpha: number;
+    beta: number;
+    radius: number;
+    target: Vector3;
+    direction: Vector3;
+    cameraPosition: Vector3;
+    nearClip: number;
+    farClip: number;
+    defaultAlpha: number;
+    defaultBeta: number;
+    defaultRadius: number;
+    defaultTarget: Vector3;
+    setAlphaLimits: (min: number, max: number) => void;
+    clearAlphaLimits: () => void;
+    setBetaLimits: (min: number, max: number) => void;
+    clearBetaLimits: () => void;
+    setRadiusLimits: (min: number, max: number) => void;
+    clearRadiusLimits: () => void;
+    setTargetLimits: (min: Vector3, max: Vector3) => void;
+    clearTargetLimits: () => void;
+    registerLerp: (lerper: FocusCameraLerper) => void;
+    lerpCompleted: () => void;
+    cancelLerp: () => void;
+    applyData: (data: FocusCameraData) => void;
+    addObserver: (observer: OnFocusCameraChange) => void;
+    removeObserver: (observer: OnFocusCameraChange) => void;
+}
+export declare function makeFocusCamera(): FocusCamera;

package/lib/Entities/FocusCamera.js

@@ -0,0 +1,272 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeFocusCamera = void 0;
+const _1 = require(".");
+const ValueObjects_1 = require("../ValueObjects");
+function makeFocusCamera() {
+    return new FocusCameraImp();
+}
+exports.makeFocusCamera = makeFocusCamera;
+class FocusCameraImp {
+    constructor() {
+        this.farClip = 100;
+        this.nearClip = 0.01;
+        this.defaultAlpha = 0;
+        this.defaultBeta = 30;
+        this.defaultRadius = 8;
+        this.defaultTarget = ValueObjects_1.Vector3.Zero();
+        this.limitRadius = false;
+        this.minRadius = 0;
+        this.maxRadius = 0;
+        this.limitAlpha = false;
+        this.minAlpha = 0;
+        this.maxAlpha = 0;
+        this.limitBeta = false;
+        this.minBeta = 0;
+        this.maxBeta = 0;
+        this.limitTarget = false;
+        this.maxTargetPosition = ValueObjects_1.Vector3.Zero();
+        this.minTargetPosition = ValueObjects_1.Vector3.Zero();
+        this.observers = new _1.ObserverList();
+        this.memoizedAlpha = new _1.MemoizedNumber(0, this.observers.notify);
+        this.memoizedBeta = new _1.MemoizedNumber(0, this.observers.notify);
+        this.memoizedRadius = new _1.MemoizedNumber(1, this.observers.notify);
+        this.memoizedTarget = new _1.MemoizedVector3(ValueObjects_1.Vector3.Zero(), this.observers.notify);
+        this.setRadiusLimits = (min, max) => {
+            let minToUse = min;
+            let maxToUse = max;
+            if (min < 0) {
+                console.warn("[Orbit Camera Entity] Mininum Radius must be greater >= 0, forcing to 0");
+                minToUse = 0;
+            }
+            if (max < minToUse) {
+                console.warn(`[Orbit Camera] Max radius must be >= min radius. Forcing to ${minToUse}`);
+                maxToUse = minToUse;
+            }
+            this.maxRadius = maxToUse;
+            this.minRadius = minToUse;
+            this.limitRadius = true;
+            this.radius = this.radius;
+        };
+        this.clearRadiusLimits = () => {
+            this.maxRadius = 0;
+            this.minRadius = 0;
+            this.limitRadius = false;
+        };
+        this.setAlphaLimits = (min, max) => {
+            let minToUse = min;
+            let maxToUse = max;
+            if (min < -180) {
+                minToUse = -180;
+                console.warn("[Orbit Camera] Min alpha must be >= -180. Forcing to -180");
+            }
+            if (max > 180) {
+                maxToUse = 180;
+                console.warn("[Orbit Camera] Max alpha must be <= 180. Forcing to 180");
+            }
+            if (minToUse > maxToUse) {
+                const absMin = Math.abs(minToUse);
+                const absMax = Math.abs(maxToUse);
+                const closestToZero = absMin < absMax ? minToUse : maxToUse;
+                minToUse = closestToZero;
+                maxToUse = closestToZero;
+                console.warn(`[Orbit Camera] Max alpha must be <= Min Alpha. Forcing to ${closestToZero}`);
+            }
+            this.maxAlpha = maxToUse;
+            this.minAlpha = minToUse;
+            this.limitAlpha = true;
+            this.alpha = this.alpha;
+        };
+        this.clearAlphaLimits = () => {
+            this.maxAlpha = 0;
+            this.minAlpha = 0;
+            this.limitAlpha = false;
+        };
+        this.setBetaLimits = (min, max) => {
+            let minToUse = min;
+            let maxToUse = max;
+            if (min < -180) {
+                minToUse = -180;
+                console.warn("[Orbit Camera] Min beta must be >= -180. Forcing to -180");
+            }
+            if (max > 180) {
+                maxToUse = 180;
+                console.warn("[Orbit Camera] Max beta must be <= 180. Forcing to 180");
+            }
+            if (minToUse > maxToUse) {
+                const absMin = Math.abs(minToUse);
+                const absMax = Math.abs(maxToUse);
+                const closestToZero = absMin < absMax ? minToUse : maxToUse;
+                minToUse = closestToZero;
+                maxToUse = closestToZero;
+                console.warn(`[Orbit Camera] Max beta must be <= Min beta. Forcing to ${closestToZero}`);
+            }
+            this.maxBeta = maxToUse;
+            this.minBeta = minToUse;
+            this.limitBeta = true;
+            this.beta = this.beta;
+        };
+        this.clearBetaLimits = () => {
+            this.maxBeta = 0;
+            this.minBeta = 0;
+            this.limitBeta = false;
+        };
+        this.setTargetLimits = (min, max) => {
+            const minArray = min.array;
+            const maxArray = max.array;
+            for (let i = 0; i < 3; i++) {
+                if (minArray[i] > maxArray[i]) {
+                    console.warn("[Orbit Camera] Target limit min's components must all be <= the max. Limits not set");
+                    return;
+                }
+            }
+            this.maxTargetPosition = max;
+            this.minTargetPosition = min;
+            this.limitTarget = true;
+            this.target = this.target;
+        };
+        this.clearTargetLimits = () => {
+            this.maxTargetPosition = ValueObjects_1.Vector3.Zero();
+            this.minTargetPosition = ValueObjects_1.Vector3.Zero();
+            this.limitTarget = false;
+        };
+        this.registerLerp = (lerper) => {
+            if (this.currentLerp) {
+                this.currentLerp.cancelLerp();
+            }
+            this.currentLerp = lerper;
+        };
+        this.lerpCompleted = () => {
+            this.currentLerp = undefined;
+        };
+        this.cancelLerp = () => {
+            var _a;
+            (_a = this.currentLerp) === null || _a === void 0 ? void 0 : _a.cancelLerp();
+            this.currentLerp = undefined;
+        };
+        this.applyData = (data) => {
+            if (data.defaultAlpha !== undefined) {
+                this.defaultAlpha = data.defaultAlpha;
+            }
+            if (data.defaultBeta !== undefined) {
+                this.defaultBeta = data.defaultBeta;
+            }
+            if (data.defaultRadius !== undefined) {
+                this.defaultRadius = data.defaultRadius;
+            }
+            if (data.defaultTarget !== undefined) {
+                const { x, y, z } = data.defaultTarget;
+                this.defaultTarget = new ValueObjects_1.Vector3(x, y, z);
+            }
+            if (data.nearClip !== undefined) {
+                this.nearClip = data.nearClip;
+            }
+            if (data.farClip !== undefined) {
+                this.farClip = data.farClip;
+            }
+            if (data.alphaLimit !== undefined) {
+                this.setAlphaLimits(data.alphaLimit.min, data.alphaLimit.max);
+            }
+            if (data.betaLimit !== undefined) {
+                this.setBetaLimits(data.betaLimit.min, data.betaLimit.max);
+            }
+            if (data.radiusLimit !== undefined) {
+                this.setRadiusLimits(data.radiusLimit.min, data.radiusLimit.max);
+            }
+            if (data.targetLimit !== undefined) {
+                const { max, min } = data.targetLimit;
+                this.setTargetLimits(new ValueObjects_1.Vector3(min.x, min.y, min.z), new ValueObjects_1.Vector3(max.x, max.y, max.z));
+            }
+        };
+        this.addObserver = (observer) => {
+            this.observers.add(observer);
+        };
+        this.removeObserver = (observer) => {
+            this.observers.remove(observer);
+        };
+    }
+    get alpha() {
+        return this.memoizedAlpha.val;
+    }
+    set alpha(val) {
+        let valToUse = val;
+        if (this.limitAlpha) {
+            valToUse = Math.min(valToUse, this.maxAlpha);
+            valToUse = Math.max(valToUse, this.minAlpha);
+        }
+        else {
+            valToUse = this.clampAngle(val);
+        }
+        this.memoizedAlpha.val = valToUse;
+    }
+    get beta() {
+        return this.memoizedBeta.val;
+    }
+    set beta(val) {
+        let valToUse = val;
+        if (this.limitBeta) {
+            valToUse = Math.min(valToUse, this.maxBeta);
+            valToUse = Math.max(valToUse, this.minBeta);
+        }
+        else {
+            valToUse = this.clampAngle(val);
+        }
+        this.memoizedBeta.val = valToUse;
+    }
+    get radius() {
+        return this.memoizedRadius.val;
+    }
+    set radius(val) {
+        let clampedVal = Math.max(val, 0);
+        if (this.limitRadius) {
+            clampedVal = Math.min(clampedVal, this.maxRadius);
+            clampedVal = Math.max(clampedVal, this.minRadius);
+        }
+        this.memoizedRadius.val = clampedVal;
+    }
+    get target() {
+        return this.memoizedTarget.val;
+    }
+    set target(val) {
+        const targetVals = val.array;
+        if (this.limitTarget) {
+            const maxVals = this.maxTargetPosition.array;
+            const minVals = this.minTargetPosition.array;
+            for (let i = 0; i < 3; i++) {
+                let v = targetVals[i];
+                v = Math.min(v, maxVals[i]);
+                v = Math.max(v, minVals[i]);
+                targetVals[i] = v;
+            }
+        }
+        this.memoizedTarget.val = ValueObjects_1.Vector3.FromArray(targetVals);
+    }
+    get direction() {
+        const yLength = -Math.sin(this.degToRad(this.beta));
+        const horizontalLenght = Math.cos(this.degToRad(this.beta));
+        const alphaRadians = this.degToRad(this.alpha);
+        const xLength = horizontalLenght * Math.sin(alphaRadians);
+        const zLength = horizontalLenght * Math.cos(alphaRadians);
+        return new ValueObjects_1.Vector3(xLength, yLength, zLength);
+    }
+    get cameraPosition() {
+        const localOffset = ValueObjects_1.Vector3.NewVectorOfLength(this.direction, -this.radius);
+        return ValueObjects_1.Vector3.Add(this.target, localOffset);
+    }
+    degToRad(degrees) {
+        return (degrees * Math.PI) / 180;
+    }
+    clampAngle(angle) {
+        const isNegative = angle < 0 ? true : false;
+        const absAngle = Math.abs(angle);
+        const revolutions = Math.floor(absAngle / 360);
+        let angleWithoutRevolutions = absAngle - revolutions * 360;
+        if (angleWithoutRevolutions > 180) {
+            angleWithoutRevolutions = angleWithoutRevolutions - 360;
+        }
+        if (isNegative) {
+            angleWithoutRevolutions *= -1;
+        }
+        return angleWithoutRevolutions;
+    }
+}

package/lib/Entities/FramedScreen.d.ts

@@ -0,0 +1,15 @@
+import { FramedScreenContainer } from "./FramedScreenContainer";
+import { ObservableEntity } from "./ObservableEntity";
+export declare abstract class FramedScreen extends ObservableEntity {
+    abstract get containers(): FramedScreenContainer[];
+    abstract addContainer(container: FramedScreenContainer): void;
+    abstract addContainerByID(id: string): FramedScreenContainer;
+    abstract removeContainer(id: string): void;
+    abstract hasContainer(id: string): boolean;
+    abstract getContainerByID(id: string): FramedScreenContainer | undefined;
+    abstract get screenWidth(): number;
+    abstract set screenWidth(width: number);
+    abstract get screenHeight(): number;
+    abstract set screenHeight(height: number);
+}
+export declare function makeFramedScreen(): FramedScreen;