@shapediver/viewer.shared.types 3.3.3 → 3.3.6

package/src/interfaces/events/ITaskEvent.ts

@@ -1,61 +0,0 @@
-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',
-    CUSTOM_CONTENT_LOADING = 'custom_content_loading',
-    GLTF_CREATION = 'gltf_creation',
-    GLTF_CONTENT_LOADING = 'gltf_content_loading',
-    MATERIAL_CONTENT_LOADING = 'material_content_loading',
-    TAG_CONTENT_LOADING = 'tag_content_loading',
-    SDTF_CONTENT_LOADING = 'sdtf_content_loading',
-    SESSION_CUSTOMIZATION = 'session_customization',
-    SESSION_CREATION = 'session_creation',
-    SESSION_OUTPUTS_UPDATE = 'session_outputs_update',
-    SESSION_OUTPUTS_LOADING = 'session_outputs_loading',
-    VIEWPORT_CREATION = 'viewer_creation',
-    EXPORT_REQUEST = 'export_request',
-}
-
-// #endregion Enums (1)

package/src/interfaces/events/IViewportEvent.ts

@@ -1,13 +0,0 @@
-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/interfaces/parameter/IGumballParameterSettings.ts

@@ -1,44 +0,0 @@
-import { IInteractionParameterProps, IInteractionParameterSettings } from './IInteractionParameterSettings';
-
-// #region Type aliases (1)
-
-export type GumballParameterValue = {
-    names: string[],
-    transformations: number[][]
-};
-
-// #endregion Type aliases (1)
-
-// #region Interfaces (1)
-
-/**
- * Properties of a selection parameter.
- */
-export interface IGumballParameterProps extends IInteractionParameterProps {
-    // #region Properties (5)
-
-    /** If the rotation is enabled. (default: true) */
-    enableRotation?: boolean,
-    /** If the scaling is enabled. (default: false) */
-    enableScaling?: boolean,
-    /** If the translation is enabled. (default: true) */
-    enableTranslation?: boolean,
-    /** The scale of the controls. The scale divides the scene bounding sphere to get the actual size. (default: 0.005) */
-    scale?: number,
-    /** The space in which the controls operate. In world space, scaling is not available. (default: 'local') */
-    space?: 'local' | 'world',
-    /** The color of the objects when selected. (default: '#0d44f0') */
-    selectionColor?: string,
-
-    // #endregion Properties (5)
-}
-
-// #endregion Interfaces (1)
-
-// #region Functions (1)
-
-export function isInteractionGumballParameterSettings(def?: IInteractionParameterSettings): def is { type: 'gumball', props: IGumballParameterProps } {
-    return def?.type === 'gumball';
-}
-
-// #endregion Functions (1)

package/src/interfaces/parameter/IInteractionParameterSettings.ts

@@ -1,85 +0,0 @@
-import { z } from 'zod';
-
-// #region Type aliases (1)
-
-export type InteractionParameterSettingsType = 'selection' | 'gumball';
-
-// #endregion Type aliases (1)
-
-// #region Interfaces (2)
-
-/**
- * General properties of an interaction parameter.
- */
-export interface IInteractionParameterProps {
-    // #region Properties (2)
-
-    /** If the objects are hoverable. (default: true) */
-    hover?: boolean,
-    /** The color of the objects when hovered. (default: '#00ff78') */
-    hoverColor?: string,
-    /** The names of the objects that can be interacted with. (see Jira document and discussion result) */
-    nameFilter?: string[]
-
-    // #endregion Properties (2)
-}
-
-/**
- * The definition of an interaction parameter.
- * 
- * For each type, there is a corresponding set of properties.
- */
-export interface IInteractionParameterSettings {
-    // #region Properties (2)
-
-    /** Properties of the parameter definition. */
-    props: IInteractionParameterProps,
-    /** Type of the interaction parameters. */
-    type: InteractionParameterSettingsType,
-
-    // #endregion Properties (2)
-}
-
-// #endregion Interfaces (2)
-
-// #region Variables (7)
-
-const IGeneralInteractionParameterJsonSchema = z.object({
-    hover: z.boolean().optional(),
-    hoverColor: z.string().optional(),
-    nameFilter: z.array(z.string()).optional(),
-});
-
-export const ISelectionParameterJsonSchema = z.object({
-    type: z.literal('selection'),
-    props: z.object({
-        maximumSelection: z.number().optional(),
-        minimumSelection: z.number().optional(),
-        selectionColor: z.string().optional(),
-    }).merge(IGeneralInteractionParameterJsonSchema),
-});
-export const IGumballParameterJsonSchema = z.object({
-    type: z.literal('gumball'),
-    props: z.object({
-        enableRotation: z.boolean().optional(),
-        enableScaling: z.boolean().optional(),
-        enableTranslation: z.boolean().optional(),
-        scale: z.number().optional(),
-        space: z.literal('local').or(z.literal('world')).optional(),
-        selectionColor: z.string().optional(),
-    }).merge(IGeneralInteractionParameterJsonSchema),
-});
-
-export const IInteractionParameterJsonSchema = ISelectionParameterJsonSchema.or(IGumballParameterJsonSchema);
-
-export const validateInteractionParameterSettings = (param: unknown) => {
-    return IInteractionParameterJsonSchema.safeParse(param);
-};
-export const validateSelectionParameterSettings = (param: unknown) => {
-    return ISelectionParameterJsonSchema.safeParse(param);
-};
-export const validateGumballParameterSettings = (param: unknown) => {
-    return IGumballParameterJsonSchema.safeParse(param);
-};
-
-// #endregion Variables (7)

package/src/interfaces/parameter/ISelectionParameterSettings.ts

@@ -1,37 +0,0 @@
-import { IInteractionParameterProps, IInteractionParameterSettings } from './IInteractionParameterSettings';
-
-// #region Type aliases (1)
-
-export type SelectionParameterValue = {
-    names: string[]
-};
-
-// #endregion Type aliases (1)
-
-// #region Interfaces (1)
-
-/**
- * Properties of a selection parameter.
- */
-export interface ISelectionParameterProps extends IInteractionParameterProps {
-    // #region Properties (2)
-
-    /** The maximum number of objects that can be selected. (default: 1) */
-    maximumSelection?: number,
-    /** The minimum number of objects that can be selected. (default: 1) */
-    minimumSelection?: number,
-    /** The color of the objects when selected. (default: '#0d44f0') */
-    selectionColor?: string,
-
-    // #endregion Properties (2)
-}
-
-// #endregion Interfaces (1)
-
-// #region Functions (1)
-
-export function isInteractionSelectionParameterSettings(def?: IInteractionParameterSettings): def is { type: 'selection', props: ISelectionParameterProps } {
-    return def?.type === 'selection';
-}
-
-// #endregion Functions (1)

package/src/interfaces/sdtf/ISDTFAttributeVisualizationData.ts

@@ -1,7 +0,0 @@
-import { mat4 } from "gl-matrix";
-import { IMaterialAbstractData } from "../data/material/IMaterialAbstractData";
-
-export interface ISDTFAttributeVisualizationData {
-    material: IMaterialAbstractData,
-    matrix: mat4
-}

package/src/interfaces/sdtf/ISDTFAttributesData.ts

@@ -1,27 +0,0 @@
-import { ITreeNodeData } from "@shapediver/viewer.shared.node-tree";
-import { SdtfTypeHintName } from '@shapediver/sdk.sdtf-v1'
-
-export interface ISDTFAttributeData {
-  // #region Properties (2)
-
-  readonly typeHint: SdtfTypeHintName | string;
-  readonly value: any;
-
-  // #endregion Properties (2)
-}
-
-export interface ISDTFAttributesData extends ITreeNodeData {
-  // #region Properties (1)
-
-  readonly attributes: {
-    [key: string]: ISDTFAttributeData
-  };
-
-  // #endregion Properties (1)
-
-  // #region Public Methods (1)
-
-  clone(): ISDTFAttributesData;
-
-  // #endregion Public Methods (1)
-}

package/src/interfaces/sdtf/ISDTFItemData.ts

@@ -1,23 +0,0 @@
-import { ITreeNodeData } from "@shapediver/viewer.shared.node-tree";
-import { ISDTFAttributeData } from "./ISDTFAttributesData";
-import { SdtfTypeHintName } from '@shapediver/sdk.sdtf-v1'
-
-export interface ISDTFItemData extends ITreeNodeData {
-    // #region Properties (3)
-
-    readonly attributes: {
-        [key: string]: ISDTFAttributeData
-    }
-
-    readonly typeHint: SdtfTypeHintName | string
-    readonly value: any;
-
-    // #endregion Properties (3)
-
-    // #region Public Methods (1)
-
-    clone(): ISDTFItemData;
-
-    // #endregion Public Methods (1)
-}
-  

package/src/interfaces/sdtf/ISDTFOverviewData.ts

@@ -1,31 +0,0 @@
-import { ITreeNodeData } from "@shapediver/viewer.shared.node-tree";
-import { SdtfTypeHintName } from '@shapediver/sdk.sdtf-v1'
-
-export interface ISDTFOverview {
-    // #region Public Indexers (1)
-
-    [key: string]: {
-        typeHint: SdtfTypeHintName | string;
-        count: number;
-        values?: string[];
-        min?: number;
-        max?: number;
-    }[];
-
-    // #endregion Public Indexers (1)
-};
-
-export interface ISDTFOverviewData extends ITreeNodeData {
-    // #region Properties (1)
-
-    readonly overview: ISDTFOverview;
-
-    // #endregion Properties (1)
-
-    // #region Public Methods (2)
-
-    clone(): ISDTFOverviewData;
-    merge(data: ISDTFOverviewData): void;
-
-    // #endregion Public Methods (2)
-}

package/src/types.ts

@@ -1,68 +0,0 @@
-import { ShapeDiverResponseParameterType, ShapeDiverResponseParameterVisualization } from '@shapediver/sdk.geometry-api-sdk-v2';
-import { vec3, vec4 } from 'gl-matrix';
-
-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)
-}

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"
-    ]
-}