@shapediver/viewer.creation-control-center.viewport 3.3.4 → 3.3.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shapediver/viewer.creation-control-center.viewport",
-  "version": "3.3.4",
+  "version": "3.3.6",
   "description": "",
   "keywords": [],
   "author": "Michael Oppitz <michael@shapediver.com>",
@@ -10,11 +10,10 @@
     "test": "__tests__"
   },
   "files": [
-    "dist",
-    "src",
     "package.json",
+    "dist/",
     "README.md",
-    "tsconfig.json"
+    "LICENSE"
   ],
   "publishConfig": {
     "access": "public"
@@ -39,13 +38,13 @@
     "testEnvironment": "node"
   },
   "dependencies": {
-    "@shapediver/viewer.rendering-engine.rendering-engine": "3.3.4",
-    "@shapediver/viewer.rendering-engine.rendering-engine-threejs": "3.3.4",
+    "@shapediver/viewer.rendering-engine.rendering-engine": "3.3.6",
+    "@shapediver/viewer.rendering-engine.rendering-engine-threejs": "3.3.6",
     "@shapediver/viewer.settings": "1.0.2",
-    "@shapediver/viewer.shared.math": "3.3.4",
-    "@shapediver/viewer.shared.node-tree": "3.3.4",
-    "@shapediver/viewer.shared.services": "3.3.4",
-    "@shapediver/viewer.shared.types": "3.3.4"
+    "@shapediver/viewer.shared.math": "3.3.6",
+    "@shapediver/viewer.shared.node-tree": "3.3.6",
+    "@shapediver/viewer.shared.services": "3.3.6",
+    "@shapediver/viewer.shared.types": "3.3.6"
   },
-  "gitHead": "8193da527b4e3fc4d90181018bd60d6ac70be3e8"
+  "gitHead": "13aea937b128a001e6e93be300674c4a04624c29"
 }

package/src/implementation/CreationControlCenterViewport.ts

@@ -1,233 +0,0 @@
-import { Box } from '@shapediver/viewer.shared.math';
-import {
-    EventEngine,
-    EVENTTYPE,
-    Logger,
-    SESSION_SETTINGS_MODE,
-    SettingsEngine,
-    ShapeDiverViewerViewportError,
-    StateEngine,
-    UuidGenerator
-} from '@shapediver/viewer.shared.services';
-import { ICreationControlCenterViewport, ViewportCreationDefinition } from '../interfaces/ICreationControlCenterViewport';
-import {
-    ISceneEvent,
-    ITaskEvent,
-    IViewportSettingsSections,
-    TASK_TYPE
-} from '@shapediver/viewer.shared.types';
-import { ISettings } from '@shapediver/viewer.settings';
-import { ITree, Tree } from '@shapediver/viewer.shared.node-tree';
-import { RenderingEngine as RenderingEngineThreeJs } from '@shapediver/viewer.rendering-engine.rendering-engine-threejs';
-import { ViewportGlobalAccessObject } from './ViewportGlobalAccessObject';
-import { VISIBILITY_MODE } from '@shapediver/viewer.rendering-engine.rendering-engine';
-
-export class CreationControlCenterViewport implements ICreationControlCenterViewport {
-    // #region Properties (8)
-
-    readonly #eventEngine: EventEngine = EventEngine.instance;
-    readonly #logger: Logger = Logger.instance;
-    readonly #sceneTree: ITree = Tree.instance;
-    readonly #stateEngine: StateEngine = StateEngine.instance;
-    readonly #uuidGenerator: UuidGenerator = UuidGenerator.instance;
-
-    private static _instance: CreationControlCenterViewport;
-
-    public readonly viewportEngines: { [key: string]: RenderingEngineThreeJs } = {};
-
-    public updateViewports?: (
-        viewportEngines: { [key: string]: RenderingEngineThreeJs; },
-    ) => void;
-
-    // #endregion Properties (8)
-
-    // #region Public Static Getters And Setters (1)
-
-    public static get instance() {
-        return this._instance || (this._instance = new this());
-    }
-
-    // #endregion Public Static Getters And Setters (1)
-
-    // #region Public Methods (4)
-
-    public applyViewportSettings(viewportId: string, settings: ISettings, sections: IViewportSettingsSections = { ar: false, scene: false, camera: false, light: false, environment: false, general: false }): Promise<void> {
-        sections = sections || {};
-
-        const settingsEngine: SettingsEngine = new SettingsEngine();
-        settingsEngine.loadSettings(settings);
-
-        const promises: Promise<unknown>[] = [];
-        this.#stateEngine.viewportEngines[viewportId]?.settingsAssigned.reset();
-        promises.push(new Promise<void>(resolve => {
-            this.#stateEngine.viewportEngines[viewportId]?.settingsAssigned.then(() => {
-                resolve();
-            });
-        }));
-
-        this.viewportEngines[viewportId].applySettings(sections, settingsEngine);
-        return new Promise(resolve => Promise.all(promises).then(() => resolve()));
-    }
-
-    public async closeViewportEngine(id: string): Promise<void> {
-        if (!this.viewportEngines[id]) return;
-
-        this.#logger.debugLow(`CreationControlCenter.closeViewportEngine: Closing viewport ${id}.`);
-        if (this.#stateEngine.viewportEngines[id]?.initialized.resolved === false)
-            await new Promise<void>(resolve => { this.#stateEngine.viewportEngines[id]?.initialized.then(() => resolve()); });
-
-        this.#stateEngine.viewportEngines[id]?.settingsAssigned.reset();
-        this.#stateEngine.viewportEngines[id]?.environmentMapLoaded.reset();
-        this.#stateEngine.viewportEngines[id]?.initialized.reset();
-
-        await this.viewportEngines[id].close();
-
-        (<unknown>this.viewportEngines[id]) = undefined;
-        delete this.viewportEngines[id];
-        delete this.#stateEngine.viewportEngines[id];
-
-        this.#logger.debug('CreationControlCenter.closeViewportEngine: Viewport closed.');
-        if (this.updateViewports) this.updateViewports(this.viewportEngines);
-
-        this.#eventEngine.emitEvent(EVENTTYPE.VIEWPORT.VIEWPORT_CLOSED, { viewportId: id });
-    }
-
-    public async createViewportEngine(properties: ViewportCreationDefinition): Promise<RenderingEngineThreeJs> {
-        const eventId = this.#uuidGenerator.create();
-        const viewportEngineId = properties.id || this.#uuidGenerator.create();
-        properties.id = viewportEngineId;
-        try {
-            const eventStart: ITaskEvent = { type: TASK_TYPE.VIEWPORT_CREATION, id: eventId, progress: 0, status: 'Creating viewport', data: { viewportId: viewportEngineId } };
-            this.#eventEngine.emitEvent(EVENTTYPE.TASK.TASK_START, eventStart);
-
-            // check if the given id is valid
-            if (this.viewportEngines[viewportEngineId]) {
-                const eventClose: ITaskEvent = { type: TASK_TYPE.VIEWPORT_CREATION, id: eventId, progress: 0.1, status: 'Closing viewport with same id', data: { viewportId: viewportEngineId } };
-                this.#eventEngine.emitEvent(EVENTTYPE.TASK.TASK_PROCESS, eventClose);
-
-                this.#logger.warn(`CreationControlCenter.createViewport: Viewer with this id (${viewportEngineId}) already exists. Closing initial instance.`);
-                await this.closeViewportEngine(viewportEngineId);
-            }
-
-            const viewportEngine = new RenderingEngineThreeJs(properties);
-            this.#stateEngine.viewportEngines[viewportEngineId] = new ViewportGlobalAccessObject(viewportEngine);
-            this.viewportEngines[viewportEngineId] = viewportEngine;
-            viewportEngine.start();
-
-            viewportEngine.cameraEngine.createDefaultCameras();
-
-            if (properties.sessionSettingsMode === SESSION_SETTINGS_MODE.MANUAL) {
-                if (!properties.sessionSettingsId)
-                    throw new ShapeDiverViewerViewportError('Session with sessionSettingsMode MANUAL needs to have a sessionSettingsId.');
-                const sessionSettingsId = properties.sessionSettingsId;
-                if (this.#stateEngine.sessionEngines[sessionSettingsId]) {
-                    await this.assignSettings(viewportEngine.id, sessionSettingsId, true);
-                } else {
-                    // in createSession
-                }
-            } else if (properties.sessionSettingsMode === SESSION_SETTINGS_MODE.FIRST) {
-                const firstSessionEngine = Object.values(this.#stateEngine.sessionEngines).find(sessionEngine => sessionEngine && sessionEngine.isFirstSession === true);
-                if (firstSessionEngine) {
-                    await this.assignSettings(viewportEngine.id, firstSessionEngine.id, true);
-                } else {
-                    // in createSession
-                }
-            }
-
-            if (viewportEngine.sessionSettingsMode === SESSION_SETTINGS_MODE.NONE &&
-                viewportEngine.visibility === VISIBILITY_MODE.SESSION) {
-                viewportEngine.show = true;
-            } else if (viewportEngine.visibility === VISIBILITY_MODE.INSTANT) {
-                viewportEngine.show = true;
-            } else if (viewportEngine.visibility === VISIBILITY_MODE.SESSION) {
-                // wait for settings to load before showing the scene
-                if (this.#sceneTree.root.boundingBox.isEmpty()) {
-                    this.#eventEngine.addListener(EVENTTYPE.SCENE.SCENE_BOUNDING_BOX_CHANGE, (e) => {
-                        const event = e as ISceneEvent;
-                        if (event.viewportId === viewportEngine.id) {
-                            const boundingBox = new Box(event.boundingBox!.min, event.boundingBox!.max);
-                            if (boundingBox.isEmpty()) {
-                                viewportEngine.show = false;
-                            } else {
-                                if (this.#stateEngine.viewportEngines[viewportEngineId]?.settingsAssigned.resolved) {
-                                    viewportEngine.show = true;
-                                } else {
-                                    this.#stateEngine.viewportEngines[viewportEngineId]?.settingsAssigned.then(() => {
-                                        viewportEngine.show = true;
-                                    });
-                                }
-                            }
-                        }
-                    });
-                } else {
-                    if (this.#stateEngine.viewportEngines[viewportEngineId]?.settingsAssigned.resolved) {
-                        viewportEngine.show = true;
-                    } else {
-                        this.#stateEngine.viewportEngines[viewportEngineId]?.settingsAssigned.then(() => {
-                            viewportEngine.show = true;
-                        });
-                    }
-                }
-            }
-
-            this.#stateEngine.viewportEngines[viewportEngineId]?.initialized.resolve(true);
-
-            this.#logger.debug(`CreationControlCenter.createViewport: Viewport(${viewportEngineId}) created.`);
-
-            const eventEnd: ITaskEvent = { type: TASK_TYPE.VIEWPORT_CREATION, id: eventId, progress: 1, status: 'Viewport created', data: { viewportId: viewportEngineId } };
-
-            if (this.updateViewports) this.updateViewports(this.viewportEngines);
-
-            this.#eventEngine.emitEvent(EVENTTYPE.VIEWPORT.VIEWPORT_CREATED, { viewportId: viewportEngineId });
-            this.#eventEngine.emitEvent(EVENTTYPE.TASK.TASK_END, eventEnd);
-            return <RenderingEngineThreeJs>this.viewportEngines[viewportEngineId];
-        } catch (e) {
-            const eventCancel1: ITaskEvent = { type: TASK_TYPE.VIEWPORT_CREATION, id: eventId, progress: 0.9, status: 'Viewport created failed, closing viewport', data: { viewportId: viewportEngineId } };
-            this.#eventEngine.emitEvent(EVENTTYPE.TASK.TASK_PROCESS, eventCancel1);
-
-            try { await this.closeViewportEngine(viewportEngineId); } catch { /* empty */ }
-
-            const eventCancel2: ITaskEvent = { type: TASK_TYPE.VIEWPORT_CREATION, id: eventId, progress: 1, status: 'Viewport created failed, exiting', data: { viewportId: viewportEngineId } };
-            this.#eventEngine.emitEvent(EVENTTYPE.TASK.TASK_CANCEL, eventCancel2);
-
-            throw e;
-        }
-    }
-
-    public getViewportSettings(viewportId: string): ISettings {
-        const viewportEngine = this.viewportEngines[viewportId];
-        if (!viewportEngine)
-            throw new ShapeDiverViewerViewportError('Viewport with id ' + viewportId + ' could not be found.');
-
-        const settingsEngine: SettingsEngine = new SettingsEngine();
-        viewportEngine.saveSettings(settingsEngine);
-        return settingsEngine.settings;
-    }
-
-    // #endregion Public Methods (4)
-
-    // #region Private Methods (1)
-
-    private async assignSettings(viewportEngineId: string, sessionEngineId: string, updateViewports: boolean = false) {
-        const viewportEngine = this.#stateEngine.viewportEngines[viewportEngineId];
-        if (!viewportEngine) return;
-
-        if (this.#stateEngine.sessionEngines[sessionEngineId] && this.#stateEngine.sessionEngines[sessionEngineId]!.initialized.resolved === true) {
-            // immediate
-            viewportEngine.assignSettingsEngine(this.#stateEngine.sessionEngines[sessionEngineId]!.settingsEngine);
-            await viewportEngine.applySettings(undefined, undefined, updateViewports);
-        } else {
-            await new Promise<void>(resolve => {
-                this.#stateEngine.sessionEngines[sessionEngineId]?.initialized.then(async () => {
-                    if(this.#stateEngine.sessionEngines[sessionEngineId]) {
-                        viewportEngine.assignSettingsEngine(this.#stateEngine.sessionEngines[sessionEngineId]!.settingsEngine);
-                        await viewportEngine.applySettings(undefined, undefined, updateViewports);
-                    }
-                    resolve();
-                });
-            });
-        }
-    }
-
-    // #endregion Private Methods (1)
-}

package/src/implementation/ViewportGlobalAccessObject.ts

@@ -1,92 +0,0 @@
-import { RenderingEngine } from '@shapediver/viewer.rendering-engine.rendering-engine-threejs';
-import { IViewportGlobalAccessObjectDefinition, SettingsEngine, StatePromise } from '@shapediver/viewer.shared.services';
-
-export class ViewportGlobalAccessObject implements IViewportGlobalAccessObjectDefinition {
-    // #region Properties (6)
-
-    readonly #boundingBoxCreated: StatePromise<boolean> = new StatePromise();
-    readonly #initialized: StatePromise<boolean> = new StatePromise();
-    readonly #settingsAssigned: StatePromise<boolean> = new StatePromise();
-    readonly #viewportEngine: RenderingEngine;
-
-    #busy: string[] = [];
-    #environmentMapLoaded: StatePromise<boolean> = new StatePromise();
-
-    // #endregion Properties (6)
-
-    // #region Constructors (1)
-
-    constructor(viewportEngine: RenderingEngine) {
-        this.#viewportEngine = viewportEngine;
-    }
-
-    // #endregion Constructors (1)
-
-    // #region Public Getters And Setters (9)
-
-    public get boundingBoxCreated(): StatePromise<boolean> {
-        return this.#boundingBoxCreated;
-    }
-
-    public get busy(): string[] {
-        return this.#busy;
-    }
-
-    public get environmentMapLoaded(): StatePromise<boolean> {
-        return this.#environmentMapLoaded;
-    }
-
-    public set environmentMapLoaded(value: StatePromise<boolean>) {
-        this.#environmentMapLoaded = value;
-    }
-
-    public get id(): string {
-        return this.#viewportEngine.id;
-    }
-
-    public get initialized(): StatePromise<boolean> {
-        return this.#initialized;
-    }
-
-    public get sessionSettingsId(): string | undefined {
-        return this.#viewportEngine.sessionSettingsId;
-    }
-
-    public get sessionSettingsMode() {
-        return this.#viewportEngine.sessionSettingsMode;
-    }
-
-    public get settingsAssigned(): StatePromise<boolean> {
-        return this.#settingsAssigned;
-    }
-
-    // #endregion Public Getters And Setters (9)
-
-    // #region Public Methods (6)
-
-    public applySettings(sections?: { ar?: boolean | undefined; scene?: boolean | undefined; camera?: boolean | undefined; light?: boolean | undefined; environment?: boolean | undefined; general?: boolean | undefined; postprocessing?: boolean | undefined; } | undefined, settingsEngine?: SettingsEngine | undefined, updateViewport?: boolean | undefined): Promise<void> {
-        return this.#viewportEngine.applySettings(sections, settingsEngine, updateViewport);
-    }
-
-    public assignSettingsEngine(settingsEngine: SettingsEngine): void {
-        this.#viewportEngine.assignSettingsEngine(settingsEngine);
-    }
-
-    public displayErrorMessage(message: string): void {
-        this.#viewportEngine.displayErrorMessage(message);
-    }
-
-    public reset(): void {
-        this.#viewportEngine.reset();
-    }
-
-    public saveSettings(): void {
-        this.#viewportEngine.saveSettings();
-    }
-
-    public update(id: string): void {
-        this.#viewportEngine.update(id);
-    }
-
-    // #endregion Public Methods (6)
-}

package/src/index.ts

@@ -1,7 +0,0 @@
-import { CreationControlCenterViewport } from './implementation/CreationControlCenterViewport';
-import { ICreationControlCenterViewport, ViewportCreationDefinition } from './interfaces/ICreationControlCenterViewport';
-
-export {
-    ICreationControlCenterViewport, CreationControlCenterViewport,
-    ViewportCreationDefinition
-};

package/src/interfaces/ICreationControlCenterViewport.ts

@@ -1,74 +0,0 @@
-import { BUSY_MODE_DISPLAY, SPINNER_POSITIONING, VISIBILITY_MODE } from '@shapediver/viewer.rendering-engine.rendering-engine';
-import { ISettings } from '@shapediver/viewer.settings';
-import { IViewportSettingsSections } from '@shapediver/viewer.shared.types';
-import { RenderingEngine as RenderingEngineThreeJs } from '@shapediver/viewer.rendering-engine.rendering-engine-threejs';
-import { SESSION_SETTINGS_MODE } from '@shapediver/viewer.shared.services';
-
-// #region Type aliases (1)
-
-export type ViewportCreationDefinition = {
-    /** The canvas element in which the viewport should be created, it is encourage to provide one. If none was provided, a canvas will be created. */
-    canvas?: HTMLCanvasElement,
-    /** The unique identifier of the session that was specified or automatically chosen on creation of the viewport. */
-    id?: string,
-    /** The branding options of the viewport. */
-    branding?: {
-        /** 
-         * Optional URL to a logo to be displayed while the viewport is hidden. 
-         * A default logo will be used if none is provided. 
-         * Supply null to display no logo at all.
-         */
-        logo?: string | null,
-        /** 
-         * Optional background color to show while the viewport is hidden, can include alpha channel. 
-         * A default color will be used if none is provided.
-         */
-        backgroundColor?: string,
-        /** 
-         * Optional URL to a logo to be displayed while the viewport is in busy mode. 
-         * A default logo will be used if none is provided. 
-         * The positioning of the spinner can be influenced via {@link SPINNER_POSITIONING}.
-         */
-        busyModeSpinner?: string,
-        /**
-         * The mode used to indicate that the viewport is busy. (default: BUSY_MODE_DISPLAY.SPINNER)
-         * Whenever the busy mode gets toggled, the events {@link EVENTTYPE_VIEWPORT.BUSY_MODE_ON} and {@link EVENTTYPE_VIEWPORT.BUSY_MODE_OFF} will be emitted.
-         */
-        busyModeDisplay?: BUSY_MODE_DISPLAY,
-        /**
-         * Where the spinner that is specified by {@link BUSY_MODE_DISPLAY} is displayed on the screen. (default: BUSY_MODE_DISPLAY.BOTTOM_RIGHT)
-         */
-        spinnerPositioning?: SPINNER_POSITIONING
-
-    },
-    /** The id of the session of which the settings should be used. Only works when {@link sessionSettingsMode} is set to {@link SESSION_SETTINGS_MODE.SESSION}. */
-    sessionSettingsId?: string,
-    /** The mode in which settings should be applied. (default: SESSION_SETTINGS_MODE.FIRST) */
-    sessionSettingsMode?: SESSION_SETTINGS_MODE,
-    /** The initial visibility of the viewport. (default: VISIBILITY_MODE.SESSION) */
-    visibility?: VISIBILITY_MODE,
-}
-
-// #endregion Type aliases (1)
-
-// #region Interfaces (1)
-
-export interface ICreationControlCenterViewport {
-    // #region Properties (2)
-
-    updateViewports?: (viewportEngines: { [key: string]: RenderingEngineThreeJs; }) => void;
-    viewportEngines: { [key: string]: RenderingEngineThreeJs; };
-
-    // #endregion Properties (2)
-
-    // #region Public Methods (4)
-
-    applyViewportSettings(viewportId: string, settings: ISettings, sections?: IViewportSettingsSections): Promise<void>;
-    closeViewportEngine(id: string): Promise<void>;
-    createViewportEngine(properties: ViewportCreationDefinition): Promise<RenderingEngineThreeJs>;
-    getViewportSettings(viewportId: string): ISettings;
-
-    // #endregion Public Methods (4)
-}
-
-// #endregion Interfaces (1)

package/tsconfig.json

@@ -1,17 +0,0 @@
-{
-    "extends": "../../tsconfig.json",
-    "include": [
-        "./**/*.ts"
-    ],
-    "compilerOptions": {
-        "rootDir": "src",
-        "outDir": "dist"
-    },
-    "exclude": [
-        "__tests__",
-        "node_modules",
-        "dist",
-        "dist-dev",
-        "dist-prod"
-    ]
-}