@shapediver/viewer.shared.types 2.12.7 → 3.0.0

package/src/interfaces/data/material/IMaterialMultiPointData.ts

@@ -0,0 +1,112 @@
+import { Color } from '../../../types';
+import { IMapData } from './IMapData';
+import { IMaterialAbstractData, IMaterialAbstractDataProperties } from './IMaterialAbstractData';
+
+// #region Interfaces (2)
+
+export interface IMaterialMultiPointData extends IMaterialAbstractData {
+    // #region Properties (20)
+
+    alphaMap_0?: IMapData;
+    alphaMap_1?: IMapData;
+    alphaMap_2?: IMapData;
+    alphaMap_3?: IMapData;
+    alphaMap_4?: IMapData;
+    alphaMap_5?: IMapData;
+    alphaMap_6?: IMapData;
+    alphaMap_7?: IMapData;
+    color_0?: Color;
+    color_1?: Color;
+    color_2?: Color;
+    color_3?: Color;
+    color_4?: Color;
+    color_5?: Color;
+    color_6?: Color;
+    color_7?: Color;
+    map_0?: IMapData;
+    map_1?: IMapData;
+    map_2?: IMapData;
+    map_3?: IMapData;
+    map_4?: IMapData;
+    map_5?: IMapData;
+    map_6?: IMapData;
+    map_7?: IMapData;
+    materialIndexDataMap?: IMapData;
+    materialIndexDataMapSize?: number;
+    sizeAttenuation_0?: boolean;
+    sizeAttenuation_1?: boolean;
+    sizeAttenuation_2?: boolean;
+    sizeAttenuation_3?: boolean;
+    sizeAttenuation_4?: boolean;
+    sizeAttenuation_5?: boolean;
+    sizeAttenuation_6?: boolean;
+    sizeAttenuation_7?: boolean;
+    size_0?: number;
+    size_1?: number;
+    size_2?: number;
+    size_3?: number;
+    size_4?: number;
+    size_5?: number;
+    size_6?: number;
+    size_7?: number;
+
+    // #endregion Properties (20)
+
+    // #region Public Methods (2)
+
+    clone(): IMaterialMultiPointData;
+    copy(source: IMaterialMultiPointData): void;
+
+    // #endregion Public Methods (2)
+}
+
+export interface IMaterialMultiPointDataProperties extends IMaterialAbstractDataProperties {
+    // #region Properties (20)
+
+    alphaMap_0?: IMapData;
+    alphaMap_1?: IMapData;
+    alphaMap_2?: IMapData;
+    alphaMap_3?: IMapData;
+    alphaMap_4?: IMapData;
+    alphaMap_5?: IMapData;
+    alphaMap_6?: IMapData;
+    alphaMap_7?: IMapData;
+    color_0?: Color;
+    color_1?: Color;
+    color_2?: Color;
+    color_3?: Color;
+    color_4?: Color;
+    color_5?: Color;
+    color_6?: Color;
+    color_7?: Color;
+    map_0?: IMapData;
+    map_1?: IMapData;
+    map_2?: IMapData;
+    map_3?: IMapData;
+    map_4?: IMapData;
+    map_5?: IMapData;
+    map_6?: IMapData;
+    map_7?: IMapData;
+    materialIndexDataMap?: IMapData;
+    materialIndexDataMapSize?: number;
+    sizeAttenuation_0?: boolean;
+    sizeAttenuation_1?: boolean;
+    sizeAttenuation_2?: boolean;
+    sizeAttenuation_3?: boolean;
+    sizeAttenuation_4?: boolean;
+    sizeAttenuation_5?: boolean;
+    sizeAttenuation_6?: boolean;
+    sizeAttenuation_7?: boolean;
+    size_0?: number;
+    size_1?: number;
+    size_2?: number;
+    size_3?: number;
+    size_4?: number;
+    size_5?: number;
+    size_6?: number;
+    size_7?: number;
+
+    // #endregion Properties (20)
+}
+
+// #endregion Interfaces (2)

package/src/interfaces/data/material/IMaterialPointData.ts

@@ -0,0 +1,26 @@
+import { IMaterialAbstractData, IMaterialAbstractDataProperties } from './IMaterialAbstractData';
+
+export interface IMaterialPointDataProperties extends IMaterialAbstractDataProperties {
+    // #region Properties (2)
+
+    size?: number,
+    sizeAttenuation?: boolean
+
+    // #endregion Properties (2)
+}
+
+export interface IMaterialPointData extends IMaterialAbstractData {
+    // #region Properties (2)
+
+    size?: number,
+    sizeAttenuation?: boolean
+
+    // #endregion Properties (2)
+
+    // #region Public Methods (2)
+
+    clone(): IMaterialPointData;
+    copy(source: IMaterialPointData): void;
+
+    // #endregion Public Methods (2)
+}

package/src/interfaces/events/EventResponseMapping.ts

@@ -1,17 +1,34 @@
-import { EVENTTYPE_CAMERA, EVENTTYPE_INTERACTION, EVENTTYPE_OUTPUT, EVENTTYPE_RENDERING, EVENTTYPE_SCENE, EVENTTYPE_SESSION, EVENTTYPE_TASK, EVENTTYPE_VIEWPORT } from "@shapediver/viewer.shared.services";
-import { ICameraEvent } from "./ICameraEvent";
-import { ISceneEvent } from "./ISceneEvent";
-import { ISessionEvent } from "./ISessionEvent";
-import { ITaskEvent } from "./ITaskEvent";
-import { IViewportEvent } from "./IViewportEvent";
-import { IOutputEvent } from "./IOutputEvent";
+import {
+    EVENTTYPE_CAMERA,
+    EVENTTYPE_OUTPUT,
+    EVENTTYPE_PARAMETER,
+    EVENTTYPE_RENDERING,
+    EVENTTYPE_SCENE,
+    EVENTTYPE_SESSION,
+    EVENTTYPE_TASK,
+    EVENTTYPE_VIEWPORT
+} from '@shapediver/viewer.shared.services';
+import { ICameraEvent } from './ICameraEvent';
+import { IOutputEvent } from './IOutputEvent';
+import { IRenderingEvent } from './IRenderingEvent';
+import { ISceneEvent } from './ISceneEvent';
+import { ISessionEvent } from './ISessionEvent';
+import { ITaskEvent } from './ITaskEvent';
+import { IViewportEvent } from './IViewportEvent';
+import { IParameterEvent } from './IParameterEvent';
 
+/**
+ * Definition of the event response mapping.
+ * This mapping is used to map the event type to the corresponding event interface.
+ */
 export type EventResponseMapping = {
     [EVENTTYPE_CAMERA.CAMERA_START]: ICameraEvent,
     [EVENTTYPE_CAMERA.CAMERA_MOVE]: ICameraEvent,
     [EVENTTYPE_CAMERA.CAMERA_END]: ICameraEvent,
     [EVENTTYPE_OUTPUT.OUTPUT_UPDATED]: IOutputEvent,
-    [EVENTTYPE_RENDERING.BEAUTY_RENDERING_FINISHED]: IViewportEvent,
+    [EVENTTYPE_PARAMETER.PARAMETER_VALUE_CHANGED]: IParameterEvent,
+    [EVENTTYPE_PARAMETER.PARAMETER_SESSION_VALUE_CHANGED]: IParameterEvent,
+    [EVENTTYPE_RENDERING.BEAUTY_RENDERING_FINISHED]: IRenderingEvent,
     [EVENTTYPE_SCENE.SCENE_BOUNDING_BOX_CHANGE]: ISceneEvent,
     [EVENTTYPE_SCENE.SCENE_BOUNDING_BOX_EMPTY]: ISceneEvent,
     [EVENTTYPE_VIEWPORT.BUSY_MODE_ON]: IViewportEvent,
@@ -21,10 +38,14 @@ export type EventResponseMapping = {
     [EVENTTYPE_VIEWPORT.VIEWPORT_CLOSED]: IViewportEvent,
     [EVENTTYPE_VIEWPORT.VIEWPORT_VISIBLE]: IViewportEvent,
     [EVENTTYPE_VIEWPORT.VIEWPORT_HIDDEN]: IViewportEvent,
+    [EVENTTYPE_VIEWPORT.BUSY_MODE_ON]: IViewportEvent,
+    [EVENTTYPE_VIEWPORT.BUSY_MODE_OFF]: IViewportEvent,
+    [EVENTTYPE_VIEWPORT.VIEWPORT_SETTINGS_LOADED]: IViewportEvent,
     [EVENTTYPE_SESSION.SESSION_CREATED]: ISessionEvent,
     [EVENTTYPE_SESSION.SESSION_CUSTOMIZED]: ISessionEvent,
     [EVENTTYPE_SESSION.SESSION_CLOSED]: ISessionEvent,
     [EVENTTYPE_SESSION.SESSION_INITIAL_OUTPUTS_LOADED]: ISessionEvent,
+    [EVENTTYPE_SESSION.SESSION_SDTF_DELAYED_LOADED]: ISessionEvent,
     [EVENTTYPE_TASK.TASK_START]: ITaskEvent,
     [EVENTTYPE_TASK.TASK_PROCESS]: ITaskEvent,
     [EVENTTYPE_TASK.TASK_END]: ITaskEvent,

package/src/interfaces/events/ICameraEvent.ts

@@ -1,5 +1,16 @@
-import { IViewportEvent } from "./IViewportEvent";
+import { IViewportEvent } from './IViewportEvent';
 
+/**
+ * Definition of the camera event.
+ * These events are sent when the camera starts, moves or ends ({@link EVENTTYPE_CAMERA}).
+ */
 export interface ICameraEvent extends IViewportEvent {
+    // #region Properties (1)
+
+    /**
+     * The id of the camera.
+     */
     cameraId: string,
+
+    // #endregion Properties (1)
 }

package/src/interfaces/events/IOutputEvent.ts

@@ -1,9 +1,29 @@
-import { ITreeNode } from "@shapediver/viewer.shared.node-tree";
-import { IEvent } from "@shapediver/viewer.shared.services";
+import { ITreeNode } from '@shapediver/viewer.shared.node-tree';
+import { IEvent } from '@shapediver/viewer.shared.services';
 
+/**
+ * Definition of the output event.
+ * These events are sent for output specific events ({@link EVENTTYPE_OUTPUT}).
+ */
 export interface IOutputEvent extends IEvent {
-    outputId: string,
-    outputVersion: string,
+    // #region Properties (4)
+
+    /**
+     * The new node of the output.
+     */
     newNode?: ITreeNode,
+    /**
+     * The old node of the output.
+     */
     oldNode?: ITreeNode
+    /**
+     * The id of the output.
+     */
+    outputId: string,
+    /**
+     * The version of the output.
+     */
+    outputVersion: string,
+
+    // #endregion Properties (4)
 }

package/src/interfaces/events/IParameterEvent.ts

@@ -0,0 +1,21 @@
+import { ISessionEvent } from './ISessionEvent';
+
+/**
+ * Definition of the parameter event.
+ * These events are sent when a parameter changes ({@link EVENTTYPE_PARAMETER}).
+ */
+export interface IParameterEvent extends ISessionEvent {
+    // #region Properties (1)
+
+    /**
+     * The id of the parameter.
+     */
+    parameterId: string
+
+    /**
+     * The value of the parameter.
+     */
+    value: unknown;
+
+    // #endregion Properties (1)
+}

package/src/interfaces/events/IRenderingEvent.ts

@@ -0,0 +1,7 @@
+import { IViewportEvent } from './IViewportEvent';
+
+/**
+ * Definition of the rendering event.
+ * These events are sent for rendering specific events ({@link EVENTTYPE_RENDERING}).
+ */
+export type IRenderingEvent = IViewportEvent

package/src/interfaces/events/ISceneEvent.ts

@@ -1,6 +1,17 @@
-import { vec3 } from "gl-matrix";
-import { IViewportEvent } from "./IViewportEvent";
+import { IViewportEvent } from './IViewportEvent';
+import { vec3 } from 'gl-matrix';
 
+/**
+ * Definition of the scene event.
+ * These events are sent for scene specific events ({@link EVENTTYPE_SCENE}).
+ */
 export interface ISceneEvent extends IViewportEvent {
+    // #region Properties (1)
+
+    /**
+     * The bounding box of the scene.
+     */
     boundingBox: { min: vec3, max: vec3}
+
+    // #endregion Properties (1)
 }

package/src/interfaces/events/ISessionEvent.ts

@@ -1,5 +1,16 @@
-import { IEvent } from "@shapediver/viewer.shared.services";
+import { IEvent } from '@shapediver/viewer.shared.services';
 
+/**
+ * Definition of the session event.
+ * These events are sent for session specific events ({@link EVENTTYPE_SESSION}).
+ */
 export interface ISessionEvent extends IEvent {
-    sessionId: string,
+    // #region Properties (1)
+
+    /**
+     * The id of the session.
+     */
+    sessionId: string
+
+    // #endregion Properties (1)
 }

package/src/interfaces/events/ITaskEvent.ts

@@ -1,5 +1,46 @@
-import { IEvent } from "@shapediver/viewer.shared.services";
+import { IEvent } from '@shapediver/viewer.shared.services';
 
+// #region Interfaces (1)
+
+/**
+ * Definition of the task event.
+ * These events are sent for task specific events ({@link EVENTTYPE_TASK}).
+ */
+export interface ITaskEvent extends IEvent {
+    // #region Properties (5)
+
+    /**
+     * The data of the task.
+     */
+    data?: unknown,
+    /**
+     * The id of the task.
+     */
+    id: string,
+    /**
+     * The progress of the task.
+     */
+    progress: number,
+    /**
+     * The status of the task.
+     */
+    status?: string
+    /**
+     * The type of the task.
+     */
+    type: TASK_TYPE,
+
+    // #endregion Properties (5)
+}
+
+// #endregion Interfaces (1)
+
+// #region Enums (1)
+
+/**
+ * Definition of the task types.
+ * These types are used to identify the type of a task in a task event {@link ITaskEvent}.
+ */
 export enum TASK_TYPE {
     AR_LOADING = 'ar_loading',
     ENVIRONMENT_MAP_LOADING = 'environment_map_loading',
@@ -17,10 +58,4 @@ export enum TASK_TYPE {
     EXPORT_REQUEST = 'export_request',
 }
 
-export interface ITaskEvent extends IEvent {
-    type: TASK_TYPE,
-    id: string,
-    progress: number,
-    data?: any,
-    status?: string
-}
+// #endregion Enums (1)

package/src/interfaces/events/IViewportEvent.ts

@@ -1,5 +1,13 @@
-import { IEvent } from "@shapediver/viewer.shared.services";
+import { IEvent } from '@shapediver/viewer.shared.services';
 
+/**
+ * Definition of the viewport event.
+ * These events are sent for viewport specific events ({@link EVENTTYPE_VIEWPORT}).
+ */
 export interface IViewportEvent extends IEvent {
+    // #region Properties (1)
+
     viewportId: string,
+
+    // #endregion Properties (1)
 }

package/src/types.ts

@@ -1,3 +1,68 @@
-import { vec3, vec4 } from "gl-matrix";
+import { ShapeDiverResponseParameterType, ShapeDiverResponseParameterVisualization } from '@shapediver/sdk.geometry-api-sdk-v2';
+import { vec3, vec4 } from 'gl-matrix';
 
-export type Color = string | number | number[] | vec3 | vec4;
+export type Color = string | number | number[] | vec3 | vec4;
+
+/**
+ * The type of the parameter.
+ */
+export {
+    ShapeDiverResponseParameterType as PARAMETER_TYPE,
+    ShapeDiverResponseParameterVisualization as PARAMETER_VISUALIZATION
+};
+
+export interface ISettingsSections {
+    // #region Properties (2)
+
+    session?: ISessionSettingsSections,
+    viewport?: IViewportSettingsSections
+
+    // #endregion Properties (2)
+}
+
+export interface ISessionSettingsSections {
+    // #region Properties (2)
+
+    export?: {
+        /** Option to update the displayname of the exports (default: false) */
+        displayname?: boolean,
+        /** Option to update the order of the exports (default: false) */
+        order?: boolean,
+        /** Option to update the hidden state of the exports (default: false) */
+        hidden?: boolean
+    }
+
+    parameter?: {
+        /** Option to update the displayname of the parameters (default: false) */
+        displayname?: boolean,
+        /** Option to update the order of the parameters (default: false) */
+        order?: boolean,
+        /** Option to update the hidden state of the parameters (default: false) */
+        hidden?: boolean,
+        /** Option to update the value of the parameters (default: false) */
+        value?: boolean
+    },
+
+    // #endregion Properties (2)
+}
+
+export interface IViewportSettingsSections {
+    // #region Properties (7)
+
+    /** Option to update the ar settings (default: false) */
+    ar?: boolean,
+    /** Option to update the camera settings (default: false) */
+    camera?: boolean,
+    /** Option to update the environment settings (default: false) */
+    environment?: boolean
+    /** Option to update the general settings (default: false) */
+    general?: boolean
+    /** Option to update the light settings (default: false) */
+    light?: boolean,
+    /** Option to update the postprocessing settings (default: false) */
+    postprocessing?: boolean
+    /** Option to update the scene settings (default: false) */
+    scene?: boolean,
+
+    // #endregion Properties (7)
+}