@lumiscaphe/viewer 4.0.6 → 4.0.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
File without changes
@@ -10,7 +10,7 @@ export declare class Canvas2D {
10
10
  destroy(): void;
11
11
  show(useDisplay: boolean): void;
12
12
  hide(useDisplay: boolean): void;
13
- resize(width: number, height: number): void;
13
+ resize(width: number, height: number, pixelRatio: number): void;
14
14
  draw(img: HTMLImageElement, fade: boolean, speed?: number): void;
15
15
  private fadeLoop;
16
16
  }
@@ -4,5 +4,5 @@ export declare class Canvas3D {
4
4
  constructor();
5
5
  show(): void;
6
6
  hide(): void;
7
- resize(width: number, height: number): void;
7
+ resize(width: number, height: number, pixelRatio: number): void;
8
8
  }
package/dist/Scene.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- export declare type ImageScene = string;
1
+ export type ImageScene = string;
2
2
  export interface WebRenderScene {
3
3
  database: string;
4
4
  configuration?: string;
@@ -10,4 +10,4 @@ export interface WebRenderScene {
10
10
  accessory?: boolean;
11
11
  decor?: boolean;
12
12
  }
13
- export declare type Scene = ImageScene | WebRenderScene;
13
+ export type Scene = ImageScene | WebRenderScene;
@@ -1,37 +1,16 @@
1
- export declare namespace WRAPIv1 {
2
- interface RequestRender {
3
- databaseId: string;
4
- configuration?: string;
5
- animations?: string;
6
- accessoryDatabaseId?: string;
7
- decorDatabaseId?: string;
8
- decorDeltaAltitude?: number;
9
- background?: string;
10
- width: number;
11
- height: number;
12
- softwareAntialiasing: boolean;
13
- superSampling: number;
14
- imageFormat: string;
15
- imageQuality: number;
16
- }
17
- interface RequestRenderBatchCubeFromBookmark extends RequestRender {
18
- bookmarkSet: string;
19
- bookmark: string;
20
- }
21
- interface RequestRenderBatchImagesFromAnimation extends RequestRender {
22
- animation: string;
23
- bookmarkSet: string;
24
- bookmark: string;
25
- duration?: number;
26
- frames?: number;
27
- loop?: boolean;
28
- reverse?: boolean;
29
- }
30
- interface RequestRenderBatchImagesFromBookmarkSet extends RequestRender {
31
- bookmarkSet: string;
32
- }
33
- interface RequestRenderImageFromBookmark extends RequestRender {
34
- bookmarkSet: string;
35
- bookmark: string;
36
- }
1
+ import { Snapshot } from './Snapshot';
2
+ export declare class WebRenderAPIv1 {
3
+ private server;
4
+ private static readonly xmlRegex;
5
+ constructor(server: string);
6
+ private static buildQuery;
7
+ private static sceneParameters;
8
+ private static renderParameters;
9
+ private static encoderParameters;
10
+ private static fetch;
11
+ animation(snapshot: Snapshot): Promise<string[]>;
12
+ image(snapshot: Snapshot): Promise<string>;
13
+ video(snapshot: Snapshot): Promise<string>;
14
+ vrCube(snapshot: Snapshot): Promise<string[]>;
15
+ vrObject(snapshot: Snapshot): Promise<string[]>;
37
16
  }
@@ -1,289 +1,14 @@
1
- export declare namespace WRAPIv2 {
2
- type AnimationArray = Animation[];
3
- type Camera = Guid | CameraObj;
4
- type CameraGroup = Guid;
5
- type Color = string;
6
- type ColoredBackground = {
7
- color: Color;
8
- } | {
9
- startColor: Color;
10
- endColor: Color;
11
- };
12
- type Guid = string;
13
- type LabelArray = Label[];
14
- type LabelTransformArray = LabelTransform[];
15
- type MaterialArray = Material[];
16
- type MaterialMultiLayerArray = MaterialMultiLayer[];
17
- type MaterialSeamArray = MaterialSeam[];
18
- type MaterialStandardArray = MaterialStandard[];
19
- type PositionArray = Vector2D[];
20
- type ProductArray = Product[];
21
- type Scene = Guid | Product | ProductArray;
22
- type SurfaceArray = Surface[];
23
- interface Animation {
24
- id: Guid;
25
- time: number;
26
- }
27
- interface AnimationMode {
28
- animation: {
29
- id: Guid;
30
- camera?: Camera;
31
- fps?: number;
32
- reverse?: boolean;
33
- };
34
- }
35
- interface CameraObj {
36
- id?: Guid;
37
- depthPolicy?: DepthPolicy;
38
- lens?: LensFov | LensFrustum;
39
- pov?: Pov;
40
- sensor?: Guid | Sensor;
41
- }
42
- interface DepthPolicy {
43
- mode?: 'frustrumBased' | 'fixedDepthRange' | 'lookAtPointBasedInterest' | 'useGlobalPolicy';
44
- zMin?: number;
45
- zMax?: number;
46
- }
47
- interface Hotspot {
48
- scene: Scene;
49
- mode: AnimationMode | ImageMode | ImagesMode | VrCubeMode | VrObjectMode;
50
- renderParameters?: RenderParameters;
51
- tags: [string, ...string[]];
52
- }
53
- interface ImageMode {
54
- image: {
55
- camera: Camera;
56
- };
57
- }
58
- interface ImagesMode {
59
- images: {
60
- cameraGroup: CameraGroup;
61
- };
62
- }
63
- interface JpegEncoder {
64
- jpeg: {
65
- quality?: number;
66
- };
67
- }
68
- interface Label {
69
- surface?: string;
70
- tag?: string;
71
- id?: Guid;
72
- filename?: string;
73
- translation?: Vector2D;
74
- rotation?: number;
75
- scaling?: Vector2D;
76
- }
77
- interface LabelTransform {
78
- index?: number;
79
- translation?: Vector2D;
80
- rotation?: number;
81
- scaling?: Vector2D;
82
- }
83
- interface LensFov {
84
- fov: number;
85
- view?: 'perspective' | 'isometric';
86
- axis?: 'x' | 'y';
87
- }
88
- interface LensFrustum {
89
- left: number;
90
- right: number;
91
- top: number;
92
- bottom: number;
93
- view?: 'perspective' | 'isometric';
94
- }
95
- interface Material {
96
- name?: string;
97
- tag?: string;
98
- id?: Guid;
99
- filename?: string;
100
- }
101
- interface MaterialMultiLayer {
102
- name: string;
103
- layer: number;
104
- diffuseColor?: Color;
105
- diffuseColorIntensity?: number;
106
- specularRoughness?: number;
107
- }
108
- interface MaterialSeam {
109
- name: string;
110
- diffuseColor?: Color;
111
- diffuseColorIntensity?: number;
112
- specularRoughness?: number;
113
- }
114
- interface MaterialStandard {
115
- name: string;
116
- diffuseColor?: Color;
117
- diffuseColorIntensity?: number;
118
- diffuseColorMap?: string;
119
- specularRoughness?: number;
120
- }
121
- interface Pick {
122
- scene: Scene;
123
- camera: Camera;
124
- renderParameters?: RenderParameters;
125
- positions: PositionArray;
126
- }
127
- interface Pov {
128
- target: Vector3D;
129
- eye: Vector3D;
130
- up: Vector3D;
131
- }
132
- interface PngEncoder {
133
- png: {
134
- compression?: number;
135
- };
136
- }
137
- interface Product {
138
- id?: Guid;
139
- database: Guid;
140
- product?: Guid;
141
- animations?: AnimationArray;
142
- configuration?: string;
143
- labels?: LabelArray;
144
- materials?: MaterialArray;
145
- materialMultiLayers?: MaterialMultiLayerArray;
146
- materialSeams?: MaterialSeamArray;
147
- materialStandards?: MaterialStandardArray;
148
- surfaces?: SurfaceArray;
149
- translation?: Vector3D;
150
- rotation?: Vector3D;
151
- isMaster?: boolean;
152
- }
153
- interface RenderParameters {
154
- width?: number;
155
- height?: number;
156
- mode?: 'aabb' | 'fill' | 'gbuffer' | 'lightmap' | 'material' | 'mix' | 'normalDepth' | 'uv' | 'wireframe' | 'worldPosition' | 'zbuffer';
157
- antialiasing?: boolean;
158
- background?: boolean;
159
- compositing?: boolean;
160
- enhancedTransparency?: boolean;
161
- grid?: boolean;
162
- matting?: boolean;
163
- mipmap?: boolean;
164
- mirror?: boolean;
165
- overlay?: boolean;
166
- partitions?: RenderPartitions;
167
- postProcess?: boolean;
168
- product?: boolean;
169
- referential?: boolean;
170
- superSampling?: '1' | '2' | '3' | '4';
171
- screenSpaceReflections?: boolean;
172
- screenSpaceReflectionsGrazingAngleFadeoff?: number;
173
- screenSpaceReflectionsQualityFactor?: number;
174
- screenSpaceReflectionsRayDepthFactor?: number;
175
- ssaoParameters?: SSAOParameters;
176
- }
177
- interface RenderPartitions {
178
- environment?: boolean;
179
- error?: boolean;
180
- label?: boolean;
181
- matte?: boolean;
182
- mirrorOpaque?: boolean;
183
- mirrorTransparent?: boolean;
184
- multiLayerOpaque?: boolean;
185
- multiLayerTransparent?: boolean;
186
- null?: boolean;
187
- seam?: boolean;
188
- shaper?: boolean;
189
- standardOpaque?: boolean;
190
- standardTransparent?: boolean;
191
- }
192
- interface Sensor {
193
- id?: Guid;
194
- background?: Guid | ColoredBackground | ('product' | 'transparent');
195
- overlay?: Guid;
196
- }
197
- interface Snapshot {
198
- scene: Scene;
199
- mode: AnimationMode | ImageMode | ImagesMode | VrCubeMode | VrObjectMode;
200
- renderParameters?: RenderParameters;
201
- encoder?: JpegEncoder | PngEncoder | WebpEncoder | VideoEncoder;
202
- }
203
- interface SSAOParameters {
204
- enabled: boolean;
205
- lightmaps: boolean;
206
- transparentSurfaces: boolean;
207
- radius: number;
208
- intensity: number;
209
- bias: number;
210
- steps: number;
211
- }
212
- interface Surface {
213
- tag: string;
214
- labels: LabelTransformArray;
215
- hide?: boolean;
216
- hideOthers?: boolean;
217
- }
218
- interface Vector2D {
219
- x: number;
220
- y: number;
221
- }
222
- interface Vector3D {
223
- x: number;
224
- y: number;
225
- z: number;
226
- }
227
- interface VideoEncoder {
228
- video: {
229
- container?: string;
230
- encoder?: string;
231
- bitrate?: number;
232
- fps?: number;
233
- };
234
- }
235
- interface VrCubeMode {
236
- vrCube: {
237
- camera: Camera;
238
- };
239
- }
240
- interface VrObjectMode {
241
- vrObject: {
242
- camera: Camera;
243
- frames: number;
244
- } | {
245
- camera: Camera;
246
- panLoop?: boolean;
247
- panFrom?: number;
248
- panTo?: number;
249
- panFrames: number;
250
- tiltLoop?: boolean;
251
- tiltFrom?: number;
252
- tiltTo?: number;
253
- tiltFrames?: number;
254
- };
255
- }
256
- interface WebpEncoder {
257
- webp?: {
258
- quality?: number;
259
- };
260
- }
261
- type PickResponse = PickResult[];
262
- type SnapshotResponse = Frame | Frame[];
263
- interface Frame {
264
- url: string;
265
- }
266
- interface PickResult {
267
- product: string;
268
- surface: {
269
- id: string;
270
- name: string;
271
- tags: string[];
272
- };
273
- normal: {
274
- x: number;
275
- y: number;
276
- z: number;
277
- };
278
- point: {
279
- x: number;
280
- y: number;
281
- z: number;
282
- };
283
- uvw: {
284
- u: number;
285
- v: number;
286
- w: number;
287
- };
288
- }
1
+ import { Snapshot } from './Snapshot';
2
+ export declare class WebRenderAPIv2 {
3
+ private server;
4
+ constructor(server: string);
5
+ private static scene;
6
+ private static renderParameters;
7
+ private static encoder;
8
+ private static fetch;
9
+ private static fetchOne;
10
+ image(snapshot: Snapshot): Promise<string>;
11
+ vrCube(snapshot: Snapshot): Promise<string[]>;
12
+ vrObject(snapshot: Snapshot): Promise<string[]>;
13
+ animation(snapshot: Snapshot): Promise<string[]>;
289
14
  }