@lumiscaphe/viewer 4.1.14 → 4.1.16

package/dist/lib/index.d.ts

@@ -437,6 +437,88 @@ export declare namespace WRAPIv1 {
 }
 
 export declare namespace WRAPIv2 {
+    export interface AabbRequest {
+        scene: Scene;
+    }
+    export interface HotspotRequest {
+        scene: Scene;
+        mode: AnimationMode | ImageMode | ImagesMode | VrCubeMode | VrObjectMode;
+        renderParameters?: RenderParameters;
+        positions?: Vector3D[];
+        tags?: string[];
+    }
+    export interface PickRequest {
+        scene: Scene;
+        camera: Camera;
+        renderParameters?: RenderParameters;
+        positions: PositionArray;
+    }
+    export interface SnapshotRequest {
+        scene: Scene;
+        mode: AnimationMode | ImageMode | ImagesMode | VrCubeMode | VrObjectMode;
+        renderParameters?: RenderParameters;
+        encoder?: JpegEncoder | PngEncoder | WebpEncoder | VideoEncoder;
+    }
+    export interface AabbResponse {
+        min: {
+            x: number;
+            y: number;
+            z: number;
+        };
+        max: {
+            x: number;
+            y: number;
+            z: number;
+        };
+        size: {
+            x: number;
+            y: number;
+            z: number;
+        };
+    }
+    export type HotspotReponse = Hotspot | Hotspot[];
+    export interface Hotspot {
+        id: string;
+        name: string;
+        position2D: Vector2D;
+        position3D: Vector3D;
+        visibility: HotspotVisibility;
+    }
+    export enum HotspotVisibility {
+        Visible = "Visible",
+        Occluded = "Occluded",
+        Clipped = "Clipped",
+        OutOfFrustum = "OutOfFrustum"
+    }
+    export type PickResponse = PickResult[];
+    export interface PickResult {
+        product: string;
+        surface: PickResultSurface;
+        normal: {
+            x: number;
+            y: number;
+            z: number;
+        };
+        point: {
+            x: number;
+            y: number;
+            z: number;
+        };
+        uvw: {
+            u: number;
+            v: number;
+            w: number;
+        };
+    }
+    export interface PickResultSurface {
+        id: string;
+        name: string;
+        tags: string[];
+    }
+    export type SnapshotResponse = Frame | Frame[];
+    export interface Frame {
+        url: string;
+    }
     export type AnimationArray = Animation[];
     export type Camera = Guid | CameraObj;
     export type CameraGroup = Guid;
@@ -448,8 +530,7 @@ export declare namespace WRAPIv2 {
         endColor: Color;
     };
     export type Guid = string;
-    export type LabelArray = Label[];
-    export type LabelTextArray = LabelText[];
+    export type LabelArray = (Label | ImageLabel | TextLabel)[];
     export type LabelTransformArray = LabelTransform[];
     export type MaterialArray = Material[];
     export type MaterialMultiLayerArray = MaterialMultiLayer[];
@@ -484,13 +565,6 @@ export declare namespace WRAPIv2 {
         zMax?: number;
     }
     export type DepthPolicyMode = 'frustumBased' | 'fixedDepthRange' | 'lookAtPointBasedInterest' | 'useGlobalPolicy';
-    export interface Hotspot {
-        scene: Scene;
-        mode: AnimationMode | ImageMode | ImagesMode | VrCubeMode | VrObjectMode;
-        renderParameters?: RenderParameters;
-        positions?: Vector3D[];
-        tags?: string[];
-    }
     export interface ImageMode {
         image: {
             camera: Camera;
@@ -507,6 +581,7 @@ export declare namespace WRAPIv2 {
         };
     }
     export interface Label {
+        type?: string;
         surface?: string;
         tag?: string;
         id?: Guid;
@@ -515,20 +590,17 @@ export declare namespace WRAPIv2 {
         rotation?: number;
         scaling?: Vector2D;
     }
-    export interface LabelText {
-        surface?: string;
-        tag?: string;
-        id?: Guid;
-        filename?: string;
-        translation?: Vector2D;
-        rotation?: number;
+    export interface ImageLabel extends Label {
+        type: 'image';
+        src: string;
+    }
+    export interface TextLabel extends Label {
+        type: 'text';
         text: string;
         fontFamily: string;
-        fontStyle?: string;
         fontSize: number;
-        color?: string;
-        opacity?: number;
-        textAlign?: string;
+        color?: Color;
+        textAlign?: 'left' | 'start' | 'center' | 'right' | 'end';
     }
     export interface LabelTransform {
         index?: number;
@@ -574,12 +646,6 @@ export declare namespace WRAPIv2 {
         diffuseColorMap?: string;
         specularRoughness?: number;
     }
-    export interface Pick {
-        scene: Scene;
-        camera: Camera;
-        renderParameters?: RenderParameters;
-        positions: PositionArray;
-    }
     export interface Pov {
         target: Vector3D;
         eye: Vector3D;
@@ -603,7 +669,7 @@ export declare namespace WRAPIv2 {
         materialStandards?: MaterialStandardArray;
         partitions?: RenderPartitions;
         surfaces?: SurfaceArray;
-        textLabels?: LabelTextArray;
+        surfacesFilter?: SurfacesFilter;
         translation?: Vector3D;
         rotation?: Vector3D;
         visible?: boolean;
@@ -656,12 +722,6 @@ export declare namespace WRAPIv2 {
         background?: Guid | ColoredBackground | ('product' | 'transparent');
         overlay?: Guid;
     }
-    export interface Snapshot {
-        scene: Scene;
-        mode: AnimationMode | ImageMode | ImagesMode | VrCubeMode | VrObjectMode;
-        renderParameters?: RenderParameters;
-        encoder?: JpegEncoder | PngEncoder | WebpEncoder | VideoEncoder;
-    }
     export interface SSAOParameters {
         enabled: boolean;
         lightmaps: boolean;
@@ -712,12 +772,19 @@ export declare namespace WRAPIv2 {
     export interface Surface {
         tag: string;
         hide?: boolean;
-        hideOthers?: boolean;
         labels?: LabelTransformArray;
         vertices?: number[];
         normals?: number[];
         uvs?: number[];
     }
+    export interface SurfacesFilter {
+        mode: SurfacesFilterMode;
+        tags: string[];
+    }
+    export enum SurfacesFilterMode {
+        ShowOnly = "showOnly",
+        HideOnly = "hideOnly"
+    }
     export interface Vector2D {
         x: number;
         y: number;
@@ -761,35 +828,6 @@ export declare namespace WRAPIv2 {
             quality?: number;
         };
     }
-    export type PickResponse = PickResult[];
-    export type SnapshotResponse = Frame | Frame[];
-    export interface Frame {
-        url: string;
-    }
-    export interface PickResult {
-        product: string;
-        surface: PickResultSurface;
-        normal: {
-            x: number;
-            y: number;
-            z: number;
-        };
-        point: {
-            x: number;
-            y: number;
-            z: number;
-        };
-        uvw: {
-            u: number;
-            v: number;
-            w: number;
-        };
-    }
-    export interface PickResultSurface {
-        id: string;
-        name: string;
-        tags: string[];
-    }
 }
 
 export { }