@shapediver/viewer.session-engine.session-engine 3.1.2 → 3.2.0

package/src/implementation/SessionEngine.ts

@@ -20,6 +20,7 @@ import {
     ShapeDiverResponseFileInfo,
     ShapeDiverResponseModelComputationStatus,
     ShapeDiverResponseOutput,
+    ShapeDiverResponseParameter,
     ShapeDiverSdk,
     ShapeDiverSdkConfigType
 } from '@shapediver/sdk.geometry-api-sdk-v2';
@@ -40,16 +41,19 @@ import {
 } from '@shapediver/viewer.shared.services';
 import { Export } from './dto/Export';
 import { FileParameter } from './dto/FileParameter';
+import { GumballParameter } from './dto/interaction/GumballParameter';
 import { IExport } from '../interfaces/dto/IExport';
 import { IFileParameter } from '../interfaces/dto/IFileParameter';
-import { IOutput } from '../interfaces/dto/IOutput';
 import {
+    IInteractionParameterSettings,
     IOutputEvent,
     ISettingsSections,
     ITaskEvent,
     PARAMETER_TYPE,
-    TASK_TYPE
+    TASK_TYPE,
+    validateInteractionParameterSettings
 } from '@shapediver/viewer.shared.types';
+import { IOutput } from '../interfaces/dto/IOutput';
 import { IParameter } from '../interfaces/dto/IParameter';
 import { ISessionEngine } from '../interfaces/ISessionEngine';
 import { ISessionTreeNode } from '../interfaces/ISessionTreeNode';
@@ -63,6 +67,7 @@ import { Output } from './dto/Output';
 import { OutputDelayException } from './OutputDelayException';
 import { OutputLoader, OutputLoaderTaskEventInfo } from './OutputLoader';
 import { Parameter } from './dto/Parameter';
+import { SelectionParameter } from './dto/interaction/SelectionParameter';
 import { SessionData } from './SessionData';
 import { SessionTreeNode } from './SessionTreeNode';
 import { vec3 } from 'gl-matrix';
@@ -168,7 +173,7 @@ export class SessionEngine implements ISessionEngine {
 
     // #endregion Constructors (1)
 
-    // #region Public Getters And Setters (26)
+    // #region Public Getters And Setters (27)
 
     public get automaticSceneUpdate(): boolean {
         return this._automaticSceneUpdate;
@@ -231,7 +236,7 @@ export class SessionEngine implements ISessionEngine {
 
     public set loadSdtf(value: boolean) {
         this._loadSdtf = value;
-        if(this._initialized === true && this._loadSdtf === true) {
+        if (this._initialized === true && this._loadSdtf === true) {
             (async () => {
                 this._outputLoader.reloadSdtf = true;
                 await this.updateOutputs();
@@ -293,9 +298,9 @@ export class SessionEngine implements ISessionEngine {
         return this._viewerSettings;
     }
 
-    // #endregion Public Getters And Setters (26)
+    // #endregion Public Getters And Setters (27)
 
-    // #region Public Methods (30)
+    // #region Public Methods (29)
 
     public applySettings(response: ShapeDiverResponseDto, sections?: ISettingsSections) {
         sections = sections || {};
@@ -443,8 +448,8 @@ export class SessionEngine implements ISessionEngine {
 
         for (const busyId of this.#customizationBusyModes) {
             for (const r in this._stateEngine.viewportEngines) {
-                if (this._stateEngine.viewportEngines[r].busy.includes(busyId))
-                    this._stateEngine.viewportEngines[r].busy.splice(this._stateEngine.viewportEngines[r].busy.indexOf(busyId), 1);
+                if (this._stateEngine.viewportEngines[r] && this._stateEngine.viewportEngines[r]!.busy.includes(busyId))
+                    this._stateEngine.viewportEngines[r]!.busy.splice(this._stateEngine.viewportEngines[r]!.busy.indexOf(busyId), 1);
             }
         }
 
@@ -613,8 +618,8 @@ export class SessionEngine implements ISessionEngine {
             // update the viewports
             if (waitForViewportUpdate) {
                 for (const r in this._stateEngine.viewportEngines)
-                    if (!this.excludeViewports.includes(this._stateEngine.viewportEngines[r].id))
-                        this._stateEngine.viewportEngines[r].update(`SessionEngine(${this.id}).customize`);
+                    if (this._stateEngine.viewportEngines[r] && !this.excludeViewports.includes(this._stateEngine.viewportEngines[r]!.id))
+                        this._stateEngine.viewportEngines[r]!.update(`SessionEngine(${this.id}).customize`);
 
                 for (const outputId in this.outputs) {
                     if (oldOutputVersions[outputId] !== newOutputVersions[outputId]) {
@@ -637,8 +642,8 @@ export class SessionEngine implements ISessionEngine {
             if (!waitForViewportUpdate) {
                 setTimeout(() => {
                     for (const r in this._stateEngine.viewportEngines)
-                        if (!this.excludeViewports.includes(this._stateEngine.viewportEngines[r].id))
-                            this._stateEngine.viewportEngines[r].update(`SessionEngine(${this.id}).customize`);
+                        if (this._stateEngine.viewportEngines[r] && !this.excludeViewports.includes(this._stateEngine.viewportEngines[r]!.id))
+                            this._stateEngine.viewportEngines[r]!.update(`SessionEngine(${this.id}).customize`);
                 }, 0);
             }
 
@@ -972,7 +977,6 @@ export class SessionEngine implements ISessionEngine {
         let processId;
         this.checkAvailability('export');
         try {
-
             // activate the busy mode if outputs are loaded
             if (loadOutputs === true && this._allowOutputLoading === true &&
                 body.outputs && Object.keys(body.outputs).length > 0) {
@@ -1299,8 +1303,8 @@ export class SessionEngine implements ISessionEngine {
         // update the viewports
         if (waitForViewportUpdate) {
             for (const r in this._stateEngine.viewportEngines)
-                if (!this.excludeViewports.includes(this._stateEngine.viewportEngines[r].id))
-                    this._stateEngine.viewportEngines[r].update(`SessionEngine(${this.id}).updateOutputs`);
+                if (this._stateEngine.viewportEngines[r] && !this.excludeViewports.includes(this._stateEngine.viewportEngines[r]!.id))
+                    this._stateEngine.viewportEngines[r]!.update(`SessionEngine(${this.id}).updateOutputs`);
 
             for (const outputId in this.outputs) {
                 if (oldOutputVersions[outputId] !== newOutputVersions[outputId]) {
@@ -1364,9 +1368,9 @@ export class SessionEngine implements ISessionEngine {
                     parameterValues[parameterId] = fileParameterValues[parameterId];
 
                     // if the parameter value of the file parameter was used, set the value to the parameter
-                    if(parameterValues[parameterId] === undefined && this.parameters[parameterId].value !== fileParameterValues[parameterId]) 
+                    if (parameterValues[parameterId] === undefined && this.parameters[parameterId].value !== fileParameterValues[parameterId])
                         this.parameters[parameterId].value = fileParameterValues[parameterId];
-                } else if(this.parameters[parameterId].value !== fileParameterValues[parameterId]) {
+                } else if (this.parameters[parameterId].value !== fileParameterValues[parameterId]) {
                     this.parameters[parameterId].value = fileParameterValues[parameterId];
                 }
             }
@@ -1388,9 +1392,9 @@ export class SessionEngine implements ISessionEngine {
         }
     }
 
-    // #endregion Public Methods (30)
+    // #endregion Public Methods (29)
 
-    // #region Private Methods (16)
+    // #region Private Methods (17)
 
     private _saveSessionSettings() {
         const parameters = this.parameters;
@@ -1450,8 +1454,8 @@ export class SessionEngine implements ISessionEngine {
 
     private addBusyMode(busyId: string) {
         for (const r in this._stateEngine.viewportEngines) {
-            if (!this.excludeViewports.includes(r)) {
-                this._stateEngine.viewportEngines[r].busy.push(busyId);
+            if (this._stateEngine.viewportEngines[r] && !this.excludeViewports.includes(r)) {
+                this._stateEngine.viewportEngines[r]!.busy.push(busyId);
                 this.#customizationBusyModes.push(busyId);
             }
         }
@@ -1534,6 +1538,27 @@ export class SessionEngine implements ISessionEngine {
         return requestParameterSet;
     }
 
+    /**
+     * Create an interaction parameter based on the parameter definition.
+     * 
+     * @param parameter 
+     * @returns 
+     */
+    private createInteractionParameter(parameter: ShapeDiverResponseParameter): IParameter<unknown> {
+        const result = validateInteractionParameterSettings(parameter.settings);
+        if (result.success) {
+            switch ((parameter.settings as IInteractionParameterSettings).type) {
+                case 'selection':
+                    return new SelectionParameter(parameter, this);
+                case 'gumball':
+                    return new GumballParameter(parameter, this);
+            }
+        } else {
+            this._logger.warn(`SessionEngine.createInteractionParameter: The value ${parameter.settings} is not a valid InteractionParameter: ${result.error.message}`);
+        }
+        return new Parameter<string>(parameter, this);
+    }
+
     private async customizeInternal(cancelRequest: () => boolean, taskEventInfo: OutputLoaderTaskEventInfo): Promise<ISessionTreeNode> {
         return this.customizeSession(this._parameterValues, cancelRequest, taskEventInfo);
     }
@@ -1637,8 +1662,8 @@ export class SessionEngine implements ISessionEngine {
 
     private removeBusyMode(busyId: string) {
         for (const r in this._stateEngine.viewportEngines) {
-            if (this._stateEngine.viewportEngines[r].busy.includes(busyId))
-                this._stateEngine.viewportEngines[r].busy.splice(this._stateEngine.viewportEngines[r].busy.indexOf(busyId), 1);
+            if (this._stateEngine.viewportEngines[r] && this._stateEngine.viewportEngines[r]!.busy.includes(busyId))
+                this._stateEngine.viewportEngines[r]!.busy.splice(this._stateEngine.viewportEngines[r]!.busy.indexOf(busyId), 1);
 
             if (this.#customizationBusyModes.includes(busyId))
                 this.#customizationBusyModes.splice(this.#customizationBusyModes.indexOf(busyId), 1);
@@ -1705,6 +1730,42 @@ export class SessionEngine implements ISessionEngine {
             if (this.parameters[parameterId]) continue;
             this._responseDto.parameters[parameterId].id = parameterId;
 
+            /**
+             * 
+             * REMOVE THIS LOGIC - START
+             * 
+             */
+            const fakeSelectionParameterName = 'FAKE_SELECTION_PARAMETER';
+            const nameStartsWithFakeSelectionParameter = this._responseDto.parameters[parameterId].name.startsWith(fakeSelectionParameterName);
+            const displaynameStartsWithFakeSelectionParameter = this._responseDto.parameters[parameterId].displayname?.startsWith(fakeSelectionParameterName);
+
+            if (nameStartsWithFakeSelectionParameter || displaynameStartsWithFakeSelectionParameter) {
+                this._responseDto.parameters[parameterId].type = PARAMETER_TYPE.INTERACTION;
+                const name = nameStartsWithFakeSelectionParameter ? this._responseDto.parameters[parameterId].name : this._responseDto.parameters[parameterId].displayname!;
+                const urlParams = new URLSearchParams(name.replace(fakeSelectionParameterName + '?', ''));
+                const jsonString = urlParams.get('settings');
+                if (jsonString)
+                    this._responseDto.parameters[parameterId].settings = JSON.parse(jsonString);
+            }
+
+            const fakeGumballParameterName = 'FAKE_GUMBALL_PARAMETER';
+            const nameStartsWithFakeGumballParameter = this._responseDto.parameters[parameterId].name.startsWith(fakeGumballParameterName);
+            const displaynameStartsWithFakeGumballParameter = this._responseDto.parameters[parameterId].displayname?.startsWith(fakeGumballParameterName);
+
+            if (nameStartsWithFakeGumballParameter || displaynameStartsWithFakeGumballParameter) {
+                this._responseDto.parameters[parameterId].type = PARAMETER_TYPE.INTERACTION;
+                const name = nameStartsWithFakeGumballParameter ? this._responseDto.parameters[parameterId].name : this._responseDto.parameters[parameterId].displayname!;
+                const urlParams = new URLSearchParams(name.replace(fakeGumballParameterName + '?', ''));
+                const jsonString = urlParams.get('settings');
+                if (jsonString)
+                    this._responseDto.parameters[parameterId].settings = JSON.parse(jsonString);
+            }
+            /**
+             * 
+             * REMOVE THIS LOGIC - END
+             * 
+             */
+
             switch (true) {
                 case this._responseDto.parameters[parameterId].type === PARAMETER_TYPE.BOOL:
                     this.parameters[parameterId] = new Parameter<boolean>(this._responseDto.parameters[parameterId], this);
@@ -1718,6 +1779,9 @@ export class SessionEngine implements ISessionEngine {
                 case this._responseDto.parameters[parameterId].type === PARAMETER_TYPE.EVEN || this._responseDto.parameters[parameterId].type === PARAMETER_TYPE.FLOAT || this._responseDto.parameters[parameterId].type === PARAMETER_TYPE.INT || this._responseDto.parameters[parameterId].type === PARAMETER_TYPE.ODD:
                     this.parameters[parameterId] = new Parameter<number>(this._responseDto.parameters[parameterId], this);
                     break;
+                case this._responseDto.parameters[parameterId].type === PARAMETER_TYPE.INTERACTION:
+                    this.parameters[parameterId] = this.createInteractionParameter(this._responseDto.parameters[parameterId]);
+                    break;
                 default:
                     this.parameters[parameterId] = new Parameter<string>(this._responseDto.parameters[parameterId], this);
                     break;
@@ -1794,5 +1858,5 @@ export class SessionEngine implements ISessionEngine {
         await Promise.all(promises);
     }
 
-    // #endregion Private Methods (16)
+    // #endregion Private Methods (17)
 }

package/src/implementation/dto/Parameter.ts

@@ -32,6 +32,7 @@ export class Parameter<T> implements IParameter<T> {
     readonly #min?: number;
     readonly #name: string;
     readonly #sessionEngine: SessionEngine;
+    readonly #settings?: Record<string, unknown>;
     readonly #structure?: ShapeDiverResponseParameterStructure;
     readonly #type: PARAMETER_TYPE;
     readonly #visualization?: PARAMETER_VISUALIZATION;
@@ -67,6 +68,7 @@ export class Parameter<T> implements IParameter<T> {
         if (paramDef.visualization !== undefined) this.#visualization = <PARAMETER_VISUALIZATION>paramDef.visualization;
         if (paramDef.structure !== undefined) this.#structure = paramDef.structure;
         if (paramDef.group !== undefined) this.#group = paramDef.group;
+        if (paramDef.settings !== undefined) this.#settings = paramDef.settings;
         if (paramDef.tooltip !== undefined) this.#tooltip = paramDef.tooltip;
 
         if (paramDef.displayname !== undefined) this.#displayname = paramDef.displayname;
@@ -179,6 +181,10 @@ export class Parameter<T> implements IParameter<T> {
         });
     }
 
+    public get settings(): Record<string, unknown> | undefined {
+        return this.#settings;
+    }
+
     public get structure(): ShapeDiverResponseParameterStructure | undefined {
         return this.#structure;
     }

package/src/implementation/dto/interaction/GumballParameter.ts

@@ -0,0 +1,78 @@
+import {
+    IInteractionParameterSettings,
+    InteractionParameterSettingsType,
+    IGumballParameterSettings,
+    validateGumballParameterSettings
+} from '@shapediver/viewer.shared.types';
+import { IGumballParameter } from '../../../interfaces/dto/interaction/IGumballParameter';
+import { Parameter } from '../Parameter';
+import { SessionEngine } from '../../SessionEngine';
+import { ShapeDiverResponseParameter } from '@shapediver/sdk.geometry-api-sdk-v2';
+
+export class GumballParameter extends Parameter<string> implements IGumballParameter {
+    // #region Properties (1)
+
+    readonly #sessionEngine: SessionEngine;
+
+    // #endregion Properties (1)
+
+    // #region Constructors (1)
+
+    constructor(paramDef: ShapeDiverResponseParameter, sessionEngine: SessionEngine) {
+        super(paramDef, sessionEngine);
+        this.#sessionEngine = sessionEngine;
+    }
+
+    // #endregion Constructors (1)
+
+    // #region Public Getters And Setters (9)
+
+    public get enableRotation(): boolean | undefined {
+        return this.getGumballProperties()?.enableRotation;
+    }
+
+    public get enableScaling(): boolean | undefined {
+        return this.getGumballProperties()?.enableScaling;
+    }
+
+    public get enableTranslation(): boolean | undefined {
+        return this.getGumballProperties()?.enableTranslation;
+    }
+
+    public get hover(): boolean | undefined {
+        return this.getGumballProperties()?.hover;
+    }
+
+    public get interactionType(): InteractionParameterSettingsType {
+        return 'gumball';
+    }
+
+    public get nameFilter(): string[] | undefined {
+        return this.getGumballProperties()?.nameFilter;
+    }
+
+    public get scale(): number | undefined {
+        return this.getGumballProperties()?.scale;
+    }
+
+    public get selectionColor(): string | undefined {
+        return this.getGumballProperties()?.selectionColor;
+    }
+
+    public get space(): 'local' | 'world' | undefined {
+        return this.getGumballProperties()?.space;
+    }
+
+    // #endregion Public Getters And Setters (9)
+
+    // #region Private Methods (1)
+
+    private getGumballProperties(): IGumballParameterSettings | undefined {
+        const result = validateGumballParameterSettings((this.settings as unknown as IInteractionParameterSettings));
+        if (result.success) {
+            return (this.settings as unknown as IInteractionParameterSettings).props;
+        }
+    }
+
+    // #endregion Private Methods (1)
+}

package/src/implementation/dto/interaction/SelectionParameter.ts

@@ -0,0 +1,66 @@
+import {
+    IInteractionParameterSettings,
+    InteractionParameterSettingsType,
+    ISelectionParameterSettings,
+    validateSelectionParameterSettings
+} from '@shapediver/viewer.shared.types';
+import { ISelectionParameter } from '../../../interfaces/dto/interaction/ISelectionParameter';
+import { Parameter } from '../Parameter';
+import { SessionEngine } from '../../SessionEngine';
+import { ShapeDiverResponseParameter } from '@shapediver/sdk.geometry-api-sdk-v2';
+
+export class SelectionParameter extends Parameter<string> implements ISelectionParameter {
+    // #region Properties (1)
+
+    readonly #sessionEngine: SessionEngine;
+
+    // #endregion Properties (1)
+
+    // #region Constructors (1)
+
+    constructor(paramDef: ShapeDiverResponseParameter, sessionEngine: SessionEngine) {
+        super(paramDef, sessionEngine);
+        this.#sessionEngine = sessionEngine;
+    }
+
+    // #endregion Constructors (1)
+
+    // #region Public Getters And Setters (6)
+
+    public get hover(): boolean | undefined {
+        return this.getSelectionProperties()?.hover;
+    }
+
+    public get interactionType(): InteractionParameterSettingsType {
+        return 'selection';
+    }
+
+    public get maximumSelection(): number | undefined {
+        return this.getSelectionProperties()?.maximumSelection;
+    }
+
+    public get minimumSelection(): number | undefined {
+        return this.getSelectionProperties()?.minimumSelection;
+    }
+
+    public get nameFilter(): string[] | undefined {
+        return this.getSelectionProperties()?.nameFilter;
+    }
+
+    public get selectionColor(): string | undefined {
+        return this.getSelectionProperties()?.selectionColor;
+    }
+
+    // #endregion Public Getters And Setters (6)
+
+    // #region Private Methods (1)
+
+    private getSelectionProperties(): ISelectionParameterSettings | undefined {
+        const result = validateSelectionParameterSettings((this.settings as unknown as IInteractionParameterSettings));
+        if (result.success) {
+            return (this.settings as unknown as IInteractionParameterSettings).props;
+        }
+    }
+
+    // #endregion Private Methods (1)
+}

package/src/index.ts

@@ -1,14 +1,19 @@
 import { Export } from './implementation/dto/Export';
 import { FileParameter } from './implementation/dto/FileParameter';
+import { GumballParameter } from './implementation/dto/interaction/GumballParameter';
 import { IExport } from './interfaces/dto/IExport';
 import { IFileParameter } from './interfaces/dto/IFileParameter';
+import { IGumballParameter } from './interfaces/dto/interaction/IGumballParameter';
+import { IInteractionParameter } from './interfaces/dto/interaction/IInteractionParameter';
 import { IOutput, ShapeDiverResponseOutputChunk, ShapeDiverResponseOutputContent } from './interfaces/dto/IOutput';
 import { IParameter } from './interfaces/dto/IParameter';
+import { ISelectionParameter } from './interfaces/dto/interaction/ISelectionParameter';
 import { ISessionData } from './interfaces/ISessionData';
 import { ISessionEngine } from './interfaces/ISessionEngine';
 import { ISessionOutputData } from './interfaces/ISessionOutputData';
 import { Output } from './implementation/dto/Output';
 import { Parameter } from './implementation/dto/Parameter';
+import { SelectionParameter } from './implementation/dto/interaction/SelectionParameter';
 import { SessionData } from './implementation/SessionData';
 import { SessionEngine } from './implementation/SessionEngine';
 import { SessionOutputData } from './implementation/SessionOutputData';
@@ -18,5 +23,5 @@ export {
 };
 
 export {
-  ISessionEngine, SessionEngine, IOutput, Output, IParameter, Parameter, IFileParameter, FileParameter, IExport, Export, ShapeDiverResponseOutputContent, ShapeDiverResponseOutputChunk
+  ISessionEngine, SessionEngine, IOutput, Output, IParameter, Parameter, IFileParameter, FileParameter, IInteractionParameter, ISelectionParameter, SelectionParameter, IGumballParameter, GumballParameter, IExport, Export, ShapeDiverResponseOutputContent, ShapeDiverResponseOutputChunk
 };

package/src/interfaces/dto/interaction/IGumballParameter.ts

@@ -0,0 +1,5 @@
+import { IInteractionParameter } from './IInteractionParameter';
+import { IParameter } from '../IParameter';
+import { IGumballParameterSettings } from '@shapediver/viewer.shared.types';
+
+export interface IGumballParameter extends IParameter<string>, IInteractionParameter, IGumballParameterSettings { }

package/src/interfaces/dto/interaction/IInteractionParameter.ts

@@ -0,0 +1,10 @@
+import { InteractionParameterSettingsType } from '@shapediver/viewer.shared.types';
+import { IParameter } from '../IParameter';
+
+export interface IInteractionParameter extends IParameter<string> {
+    // #region Properties (1)
+
+    interactionType: InteractionParameterSettingsType;
+
+    // #endregion Properties (1)
+}

package/src/interfaces/dto/interaction/ISelectionParameter.ts

@@ -0,0 +1,5 @@
+import { IInteractionParameter } from './IInteractionParameter';
+import { IParameter } from '../IParameter';
+import { ISelectionParameterSettings } from '@shapediver/viewer.shared.types';
+
+export interface ISelectionParameter extends IParameter<string>, IInteractionParameter, ISelectionParameterSettings { }