@shapediver/viewer.session-engine.session-engine 2.9.10 → 2.10.0

package/src/implementation/SessionEngine.ts

@@ -5,7 +5,7 @@ import { OutputLoader, OutputLoaderTaskEventInfo } from './OutputLoader'
 import { SessionTreeNode } from './SessionTreeNode'
 import { ISessionEngine, ISettingsSections, PARAMETER_TYPE } from '../interfaces/ISessionEngine'
 import { SessionData } from './SessionData'
-import { create, ShapeDiverError as ShapeDiverBackendError, ShapeDiverResponseErrorType, ShapeDiverRequestGltfUploadQueryConversion, ShapeDiverResponseDto, ShapeDiverResponseError, ShapeDiverResponseExport, ShapeDiverResponseExportDefinitionType, ShapeDiverResponseOutput, ShapeDiverResponseParameter, ShapeDiverSdk, ShapeDiverSdkConfigType, ShapeDiverResponseModelComputationStatus, ShapeDiverRequestError } from '@shapediver/sdk.geometry-api-sdk-v2'
+import { create, ShapeDiverError as ShapeDiverBackendError, ShapeDiverResponseErrorType, ShapeDiverRequestGltfUploadQueryConversion, ShapeDiverResponseDto, ShapeDiverResponseError, ShapeDiverResponseExport, ShapeDiverResponseExportDefinitionType, ShapeDiverResponseOutput, ShapeDiverResponseParameter, ShapeDiverSdk, ShapeDiverSdkConfigType, ShapeDiverResponseModelComputationStatus, ShapeDiverRequestError, isGBResponseError } from '@shapediver/sdk.geometry-api-sdk-v2'
 import { ISessionTreeNode } from '../interfaces/ISessionTreeNode'
 import { ITree, ITreeNode, Tree, TreeNode } from '@shapediver/viewer.shared.node-tree'
 import { ITaskEvent, TASK_TYPE } from '@shapediver/viewer.shared.types'
@@ -18,13 +18,14 @@ import { Parameter } from './dto/Parameter'
 import { vec3 } from 'gl-matrix'
 import { Export } from './dto/Export'
 import { Output } from './dto/Output'
-import { convert, ISettingsV3_4, latestVersion, validate, versions } from '@shapediver/viewer.settings'
+import { convert, ISettings, latestVersion, validate, versions } from '@shapediver/viewer.settings'
 
 export class SessionEngine implements ISessionEngine {
     // #region Properties (43)
 
     private readonly _eventEngine = EventEngine.instance;
     private readonly _exports: { [key: string]: IExport; } = {};
+    private readonly _guid?: string;
     private readonly _httpClient: HttpClient = HttpClient.instance;
     private readonly _id: string;
     private readonly _logger: Logger = Logger.instance;
@@ -39,7 +40,7 @@ export class SessionEngine implements ISessionEngine {
     private readonly _sessionEngineId = (UuidGenerator.instance).create();
     private readonly _settingsEngine: SettingsEngine = new SettingsEngine();
     private readonly _stateEngine: StateEngine = StateEngine.instance;
-    private readonly _ticket: string;
+    private readonly _ticket?: string;
     private readonly _uuidGenerator = UuidGenerator.instance;
 
     #customizationProcess!: string;
@@ -89,12 +90,13 @@ export class SessionEngine implements ISessionEngine {
     // #region Constructors (1)
 
     /**
-     * Can be use to initialize a session with the ticket and modelViewUrl and returns a scene graph node with the result.
+     * Can be use to initialize a session with the ticket/guid and modelViewUrl and returns a scene graph node with the result.
      * Can be use to customize the session with updated parameters to get the updated scene graph node.
      */
-    constructor(properties: { id: string, ticket: string, modelViewUrl: string, buildVersion: string, buildDate: string, jwtToken?: string, excludeViewports?: string[] }) {
+    constructor(properties: { id: string, ticket?: string, guid?: string, modelViewUrl: string, buildVersion: string, buildDate: string, jwtToken?: string, excludeViewports?: string[] }) {
         this._id = properties.id;
         this._node = new TreeNode(properties.id);
+        this._guid = properties.guid;
         this._ticket = properties.ticket;
         this._modelViewUrl = properties.modelViewUrl;
         this._excludeViewports = properties.excludeViewports || [];
@@ -154,6 +156,10 @@ export class SessionEngine implements ISessionEngine {
         return this._exports;
     }
 
+    public get guid(): string | undefined {
+        return this._guid;
+    }
+
     public get id(): string {
         return this._id;
     }
@@ -202,7 +208,7 @@ export class SessionEngine implements ISessionEngine {
         return this._settingsEngine;
     }
 
-    public get ticket(): string {
+    public get ticket(): string | undefined {
         return this._ticket;
     }
 
@@ -235,7 +241,7 @@ export class SessionEngine implements ISessionEngine {
             if (sections.session.export === undefined)
                 sections.session.export = { displayname: false, order: false, hidden: false };
             if (sections.viewport === undefined)
-                sections.viewport = { ar: false, scene: false, camera: false, light: false, environment: false, general: false };
+                sections.viewport = { ar: false, scene: false, camera: false, light: false, environment: false, general: false, postprocessing: false };
 
             let config: object;
             if ((<ShapeDiverResponseDto>response).viewer !== undefined) {
@@ -250,7 +256,7 @@ export class SessionEngine implements ISessionEngine {
                 throw new ShapeDiverViewerSettingsError('Session.applySettings: Was not able to validate config object.');
             }
 
-            const settings = <ISettingsV3_4>convert(config, latestVersion);
+            const settings = <ISettings>convert(config, latestVersion);
 
             const exportMappingUid: { [key: string]: string | undefined } = {};
             if (sections.session.export.displayname || sections.session.export.order || sections.session.export.hidden)
@@ -320,7 +326,7 @@ export class SessionEngine implements ISessionEngine {
                 currentSettings.environmentGeometry.groundPlaneShadowVisibility = settings.environmentGeometry.groundPlaneShadowVisibility;
             
                 currentSettings.rendering.shadows = settings.rendering.shadows;
-                currentSettings.rendering.ambientOcclusion = settings.rendering.ambientOcclusion;
+                currentSettings.rendering.softShadows = settings.rendering.softShadows;
 
                 currentSettings.rendering.automaticColorAdjustment = settings.rendering.automaticColorAdjustment;
                 currentSettings.rendering.textureEncoding = settings.rendering.textureEncoding;
@@ -336,6 +342,10 @@ export class SessionEngine implements ISessionEngine {
                 currentSettings.general.pointSize = settings.general.pointSize;
             }
 
+            // apply postprocessing settings
+            if (sections.viewport.postprocessing) 
+                currentSettings.postprocessing = settings.postprocessing;
+
             // apply environment settings
             if (sections.viewport.environment) {
                 currentSettings.environment.clearAlpha = settings.environment.clearAlpha;
@@ -402,7 +412,8 @@ export class SessionEngine implements ISessionEngine {
             this._logger.debugLow(`Session(${this.id}).customize: Customizing session.`);
 
             for (let r in this._stateEngine.renderingEngines)
-                this._stateEngine.renderingEngines[r].busy.push(customizationId);
+                if(!this.excludeViewports.includes(r))
+                    this._stateEngine.renderingEngines[r].busy.push(customizationId);
 
             const eventFileUpload: ITaskEvent = { type: TASK_TYPE.SESSION_CUSTOMIZATION, id: eventId, progress: 0.1, data: { sessionId: this.id }, status: 'Uploading file parameters' };
             this._eventEngine.emitEvent(EVENTTYPE.TASK.TASK_PROCESS, eventFileUpload);
@@ -537,8 +548,6 @@ export class SessionEngine implements ISessionEngine {
             // set the session values to the current ones in all parameters
             for (const parameterId in this.parameters)
                 (<any>this.parameters[parameterId].sessionValue) = parameterSet[parameterId].value;
-
-            if (this._updateCallback) this._updateCallback(newNode, oldNode);
                 
             // set the output content to what has been updated
             for (const outputId in this.outputs)
@@ -566,6 +575,21 @@ export class SessionEngine implements ISessionEngine {
             const eventEnd: ITaskEvent = { type: TASK_TYPE.SESSION_CUSTOMIZATION, id: eventId, progress: 1, data: { sessionId: this.id }, status: 'Session customized' };
             this._eventEngine.emitEvent(EVENTTYPE.TASK.TASK_END, eventEnd);
 
+            // update the viewports
+            for (let r in this._stateEngine.renderingEngines)
+                if(!this.excludeViewports.includes(this._stateEngine.renderingEngines[r].id))
+                    this._stateEngine.renderingEngines[r].update(`SessionEngine(${this.id}).customize`);
+
+            // call the update callback function on the session
+            if (this._updateCallback) this._updateCallback(newNode, oldNode);
+
+            // call the update callback functions on the outputs
+            for (const outputId in this.outputs)
+                this.outputs[outputId].triggerUpdateCallback(
+                    newNode.children.find(c => c.name === outputId)!,
+                    oldNode.children.find(c => c.name === outputId)!
+                );
+
             return this.node;
         } catch (e) {
             const eventCancel: ITaskEvent = { type: TASK_TYPE.SESSION_CUSTOMIZATION, id: eventId, progress: 1, data: { sessionId: this.id }, status: 'Session customization failed' };
@@ -671,7 +695,14 @@ export class SessionEngine implements ISessionEngine {
             for (const parameterNameOrId in parameterValues)
                 parameterSet[parameterNameOrId] = (' ' + parameterValues[parameterNameOrId]).slice(1);
 
-            this._responseDto = await this._sdk.session.init(this._ticket, parameterSet);
+            if(this._ticket) {
+                this._responseDto = await this._sdk.session.init(this._ticket, parameterSet);
+            } else if(this._guid) {
+                this._responseDto = await this._sdk.session.initForModel(this._guid, parameterSet);
+            } else {
+                // we should never get here
+                throw new ShapeDiverViewerSessionError(`Session.init: Initialization of session failed. Neither a ticket nor a guid are available.`)
+            }
             this._performanceEvaluator.endSection('sessionResponse');
 
             this._viewerSettings = this._responseDto.viewer?.config;
@@ -863,7 +894,7 @@ export class SessionEngine implements ISessionEngine {
             if (sections.session.export === undefined)
                 sections.session.export = { displayname: true, order: true, hidden: true };
             if (sections.viewport === undefined)
-                sections.viewport = { ar: true, scene: true, camera: true, light: true, environment: true, general: true };
+                sections.viewport = { ar: true, scene: true, camera: true, light: true, environment: true, general: true, postprocessing: true };
 
             return this.applySettings(this._responseDto, sections);
     }
@@ -1072,7 +1103,8 @@ export class SessionEngine implements ISessionEngine {
         this._logger.debugLow(`Session(${this.id}).updateOutputs: Updating Outputs.`);
 
         for (let r in this._stateEngine.renderingEngines)
-            this._stateEngine.renderingEngines[r].busy.push(customizationId);
+            if(!this.excludeViewports.includes(r))
+                this._stateEngine.renderingEngines[r].busy.push(customizationId);
 
         const eventRequest: ITaskEvent = { type: eventType, id: eventId, progress: taskEventInfo ? (taskEventInfo.progressRange.max - taskEventInfo.progressRange.min) * 0.1 + taskEventInfo.progressRange.min : 0.1, data: eventData, status: 'Loading outputs' };
         this._eventEngine.emitEvent(EVENTTYPE.TASK.TASK_PROCESS, eventRequest);
@@ -1118,8 +1150,6 @@ export class SessionEngine implements ISessionEngine {
 
         this._logger.debug(`Session(${this.id}).updateOutputs: Updating outputs finished, updating geometry.`);
         
-        if (this._updateCallback) this._updateCallback(newNode, oldNode);
-
         // set the output content to what has been updated
         for (const outputId in this.outputs) {
             this.outputs[outputId].updateOutput(
@@ -1146,6 +1176,21 @@ export class SessionEngine implements ISessionEngine {
             this._eventEngine.emitEvent(EVENTTYPE.TASK.TASK_END, eventEnd);
         }
 
+        // update the viewports
+        for (let r in this._stateEngine.renderingEngines)
+            if (!this.excludeViewports.includes(this._stateEngine.renderingEngines[r].id))
+                this._stateEngine.renderingEngines[r].update(`SessionEngine(${this.id}).customize`);
+
+        // call the update callback function on the session
+        if (this._updateCallback) this._updateCallback(newNode, oldNode);
+
+        // call the update callback functions on the outputs
+        for (const outputId in this.outputs)
+            this.outputs[outputId].triggerUpdateCallback(
+                newNode.children.find(c => c.name === outputId)!,
+                oldNode.children.find(c => c.name === outputId)!
+            );
+
         return this.node;
     }
 
@@ -1300,7 +1345,7 @@ export class SessionEngine implements ISessionEngine {
     }
 
     private async handleError(e: ShapeDiverBackendError | ShapeDiverViewerError | Error | unknown, retry = false) {
-        if (e instanceof ShapeDiverResponseError) {
+        if (isGBResponseError(e)) {
             if (e.error === ShapeDiverResponseErrorType.SESSION_GONE_ERROR) {
                 // case 1: the session is no longer available
                 // we try to re-initialize the session 3 times, if that does not work, we close it

package/src/implementation/dto/Output.ts

@@ -185,7 +185,9 @@ export class Output implements IOutput {
         }
       }
     }
+  }
 
+  public triggerUpdateCallback(newNode?: TreeNode, oldNode?: TreeNode) {
     if (this.#updateCallback) this.#updateCallback(newNode, oldNode);
   }
 

package/src/interfaces/ISessionEngine.ts

@@ -95,6 +95,8 @@ export interface ISettingsSections {
       environment?: boolean
       /** Option to update the general settings (default: false) */
       general?: boolean
+      /** Option to update the postprocessing settings (default: false) */
+      postprocessing?: boolean
   }
 };
 
@@ -104,6 +106,7 @@ export interface ISessionEngine {
   readonly jwtToken?: string;
   canUploadGLTF: boolean;
   exports: { [key: string]: IExport };
+  guid?: string;
   id: string;
   initialized: boolean;
   modelViewUrl: string;
@@ -111,7 +114,7 @@ export interface ISessionEngine {
   parameters: { [key: string]: IParameter<any> };
   refreshJwtToken: (() => Promise<string>) | undefined;
   settingsEngine: SettingsEngine;
-  ticket: string;
+  ticket?: string;
   updateCallback: ((newNode: ITreeNode, oldNode: ITreeNode) => void) | null;
 
   // #endregion Properties (11)

package/src/interfaces/dto/IOutput.ts

@@ -37,6 +37,7 @@ export interface IOutput extends ShapeDiverResponseOutput {
 
     // #region Public Methods (1)
     
+    triggerUpdateCallback(newNode?: ITreeNode, oldNode?: ITreeNode): void;
     updateOutput(newNode?: ITreeNode, oldNode?: ITreeNode): void;
     updateOutputContent(content: ShapeDiverResponseOutputContent[], preventUpdate?: boolean): Promise<ITreeNode | undefined>;
     updateOutputDefinition(outputDef: ShapeDiverResponseOutput): void;