@procore/bim-webviewer-sdk 13.1.0-BIM-2909.0 → 13.1.0-BIM-2909.2
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.
- package/CHANGELOG.md +6 -0
- package/dist/Procore.Bim.Webviewer.d.ts +70 -89
- package/dist/Procore.Bim.Webviewer.js +1 -1
- package/dist/types/src/Webviewer.d.ts +53 -82
- package/dist/types/src/controllers/CacheController.d.ts +2 -2
- package/dist/types/src/pwfreader/PWF.d.ts +2 -2
- package/dist/types/src/sdk.d.ts +1 -1
- package/dist/types/src/types/WebviewerOptions.d.ts +16 -5
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
|
|
|
5
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
6
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
|
|
7
7
|
|
|
8
|
+
## [Unreleased]
|
|
9
|
+
|
|
10
|
+
### Added
|
|
11
|
+
|
|
12
|
+
- Some type declarations are now included in the package. This means that you can now use TypeScript with the Web Viewer SDK.
|
|
13
|
+
|
|
8
14
|
## [13.1.0] - 2024-03-18
|
|
9
15
|
|
|
10
16
|
### Added
|
|
@@ -61,7 +61,7 @@ declare type BoundingBox_2 = {
|
|
|
61
61
|
};
|
|
62
62
|
|
|
63
63
|
declare const Cache_2: {
|
|
64
|
-
removeModel: (options:
|
|
64
|
+
removeModel: (options: any) => Promise<boolean>;
|
|
65
65
|
hasModel: (geometryBundle: GeometryBundle) => Promise<boolean>;
|
|
66
66
|
};
|
|
67
67
|
export { Cache_2 as Cache }
|
|
@@ -83,9 +83,21 @@ declare type CommonOptions = {
|
|
|
83
83
|
*/
|
|
84
84
|
tools?: Tool[];
|
|
85
85
|
bcfCamera?: any;
|
|
86
|
-
min_boundary?: Vector3
|
|
87
|
-
|
|
88
|
-
|
|
86
|
+
min_boundary?: Vector3 | {
|
|
87
|
+
x: string;
|
|
88
|
+
y: string;
|
|
89
|
+
z: string;
|
|
90
|
+
};
|
|
91
|
+
max_boundary?: Vector3 | {
|
|
92
|
+
x: string;
|
|
93
|
+
y: string;
|
|
94
|
+
z: string;
|
|
95
|
+
};
|
|
96
|
+
rotation?: Vector3 | {
|
|
97
|
+
x: string;
|
|
98
|
+
y: string;
|
|
99
|
+
z: string;
|
|
100
|
+
};
|
|
89
101
|
plans?: any[];
|
|
90
102
|
levels?: any[];
|
|
91
103
|
locale?: string;
|
|
@@ -93,7 +105,7 @@ declare type CommonOptions = {
|
|
|
93
105
|
accessToken?: string;
|
|
94
106
|
debug?: boolean;
|
|
95
107
|
multiselect?: boolean;
|
|
96
|
-
selection?:
|
|
108
|
+
selection?: string;
|
|
97
109
|
enableWebWorker?: boolean;
|
|
98
110
|
featureFlags?: FeatureFlags;
|
|
99
111
|
logInitializationTimes?: boolean;
|
|
@@ -264,8 +276,6 @@ declare type SectionDataAutodeskFormat = {
|
|
|
264
276
|
|
|
265
277
|
declare type SectionDataProcoreFormat = ProcoreFormatClipPlane[];
|
|
266
278
|
|
|
267
|
-
declare type SelectionTypes = 'FirstObject' | 'Geometry';
|
|
268
|
-
|
|
269
279
|
export declare class TestRoutineRecorder {
|
|
270
280
|
camera: Camera;
|
|
271
281
|
points: Point[];
|
|
@@ -352,15 +362,12 @@ export declare class Webviewer {
|
|
|
352
362
|
};
|
|
353
363
|
camera: {
|
|
354
364
|
setMarkup: (markupData: any, fov: number) => void;
|
|
355
|
-
getCameraDirection: () => Promise<Vector3
|
|
356
|
-
getPosition: () => Promise<Vector3
|
|
365
|
+
getCameraDirection: () => Promise<Vector3>;
|
|
366
|
+
getPosition: () => Promise<Vector3>;
|
|
357
367
|
setPosition: (x: number, y: number, z: number) => Promise<{
|
|
358
368
|
position: Vector3;
|
|
359
369
|
direction: Vector3;
|
|
360
|
-
}
|
|
361
|
-
position: Vector3;
|
|
362
|
-
direction: Vector3;
|
|
363
|
-
};
|
|
370
|
+
}>;
|
|
364
371
|
getSnapshot: (color: string) => Promise<void>;
|
|
365
372
|
getSnapshotDataUrl: (params?: {
|
|
366
373
|
color: unknown;
|
|
@@ -368,41 +375,31 @@ export declare class Webviewer {
|
|
|
368
375
|
setLookAt: (x: number, y: number, z: number) => Promise<{
|
|
369
376
|
position: Vector3;
|
|
370
377
|
direction: Vector3;
|
|
371
|
-
}
|
|
372
|
-
|
|
373
|
-
direction: Vector3;
|
|
374
|
-
};
|
|
375
|
-
getLookAt: () => Promise<Vector3> | Vector3;
|
|
378
|
+
}>;
|
|
379
|
+
getLookAt: () => Promise<Vector3>;
|
|
376
380
|
getBenchmarkPoint: () => Promise<{
|
|
377
381
|
position: Vector3;
|
|
378
382
|
lookAt: Vector3;
|
|
379
|
-
}
|
|
380
|
-
position: Vector3;
|
|
381
|
-
lookAt: Vector3;
|
|
382
|
-
};
|
|
383
|
+
}>;
|
|
383
384
|
setBenchmarkPoint: (params: {
|
|
384
385
|
position: Vector3;
|
|
385
386
|
lookAt: Vector3;
|
|
386
|
-
}) => Promise<void
|
|
387
|
+
}) => Promise<void>;
|
|
387
388
|
setBcfCamera: (bcfCamera: any, applyOffset?: boolean) => Promise<{
|
|
388
389
|
perspective_camera: BcfCameraPerspective;
|
|
389
|
-
}
|
|
390
|
-
perspective_camera: BcfCameraPerspective;
|
|
391
|
-
} | false;
|
|
390
|
+
} | false>;
|
|
392
391
|
getBcfCamera: () => Promise<{
|
|
393
392
|
perspective_camera: BcfCameraPerspective;
|
|
394
|
-
}
|
|
395
|
-
perspective_camera: BcfCameraPerspective;
|
|
396
|
-
};
|
|
393
|
+
}>;
|
|
397
394
|
navToHomeView: () => Promise<void>;
|
|
398
|
-
getScreenPosition: (x: number, y: number, z: number) => Promise<Vector3
|
|
399
|
-
setEulerAngles: (x: number, y: number, z: number) => Promise<void
|
|
400
|
-
getFieldOfView: () => Promise<number
|
|
401
|
-
setFieldOfView: (deg: number) => Promise<void
|
|
402
|
-
zoomToSelection: () => Promise<void
|
|
403
|
-
zoomToObjects: (objectIds: number[]) => Promise<void
|
|
404
|
-
zoomToBoundingBox: (bbox: BoundingBox) => Promise<void
|
|
405
|
-
zoomToGlobal: () => Promise<void
|
|
395
|
+
getScreenPosition: (x: number, y: number, z: number) => Promise<Vector3 | Vector3[]>;
|
|
396
|
+
setEulerAngles: (x: number, y: number, z: number) => Promise<void>;
|
|
397
|
+
getFieldOfView: () => Promise<number>;
|
|
398
|
+
setFieldOfView: (deg: number) => Promise<void>;
|
|
399
|
+
zoomToSelection: () => Promise<void>;
|
|
400
|
+
zoomToObjects: (objectIds: number[]) => Promise<void>;
|
|
401
|
+
zoomToBoundingBox: (bbox: BoundingBox) => Promise<void>;
|
|
402
|
+
zoomToGlobal: () => Promise<void>;
|
|
406
403
|
setPose: (params: {
|
|
407
404
|
pose: string | {
|
|
408
405
|
position: Vector3;
|
|
@@ -418,25 +415,25 @@ export declare class Webviewer {
|
|
|
418
415
|
clear: () => void;
|
|
419
416
|
};
|
|
420
417
|
model: {
|
|
421
|
-
getMeshnode: (meshnodeIndex: number) => Promise<any | null
|
|
422
|
-
getMeshnodeFromObjectId: (objectId: number) => Promise<any
|
|
423
|
-
getHiddenMeshnodeIndices: () => Promise<number[]
|
|
424
|
-
addHiddenMeshnodeIndices: (meshnodeIndices: number[]) => Promise<void
|
|
425
|
-
hasHiddenMeshnodeIndices: (meshnodeIndices: number[]) => Promise<boolean
|
|
426
|
-
clearHiddenMeshnodeIndices: () => Promise<boolean
|
|
427
|
-
getSelectedMeshnodeIndices: () => Promise<number[]
|
|
428
|
-
addSelectedMeshnodeIndices: (meshnodeIndices: number[]) => Promise<boolean
|
|
429
|
-
hasSelectedMeshnodeIndices: (meshnodeIndices: number[]) => Promise<boolean
|
|
430
|
-
clearSelectedMeshnodeIndices: () => Promise<boolean
|
|
431
|
-
setMeshnodeColor: (meshnodeIndex: number, hexColor: string, opacity: number) =>
|
|
432
|
-
getSections: (format: string) => Promise<SectionDataProcoreFormat | SectionDataAutodeskFormat | null
|
|
433
|
-
setSectionsData: (sectionsData: any, unit: string, showCoachmark: boolean) => Promise<boolean
|
|
434
|
-
setSectionBox: (minXYZ: Vector3, maxXYZ: Vector3, rotation: Vector3, showCoachmark: boolean) => Promise<void
|
|
435
|
-
resetSectionBox: () => Promise<void
|
|
436
|
-
removeSectionBox: () => Promise<void
|
|
437
|
-
addSectionPlane: (distance: number, normal: Vector3, showCoachmark: boolean) =>
|
|
438
|
-
removeSectionPlane: (uuid: string) =>
|
|
439
|
-
clearSection: () => Promise<void
|
|
418
|
+
getMeshnode: (meshnodeIndex: number) => Promise<any | null>;
|
|
419
|
+
getMeshnodeFromObjectId: (objectId: number) => Promise<any>;
|
|
420
|
+
getHiddenMeshnodeIndices: () => Promise<number[]>;
|
|
421
|
+
addHiddenMeshnodeIndices: (meshnodeIndices: number[]) => Promise<void>;
|
|
422
|
+
hasHiddenMeshnodeIndices: (meshnodeIndices: number[]) => Promise<boolean>;
|
|
423
|
+
clearHiddenMeshnodeIndices: () => Promise<boolean>;
|
|
424
|
+
getSelectedMeshnodeIndices: () => Promise<number[]>;
|
|
425
|
+
addSelectedMeshnodeIndices: (meshnodeIndices: number[]) => Promise<boolean>;
|
|
426
|
+
hasSelectedMeshnodeIndices: (meshnodeIndices: number[]) => Promise<boolean>;
|
|
427
|
+
clearSelectedMeshnodeIndices: () => Promise<boolean>;
|
|
428
|
+
setMeshnodeColor: (meshnodeIndex: number, hexColor: string, opacity: number) => void;
|
|
429
|
+
getSections: (format: string) => Promise<SectionDataProcoreFormat | SectionDataAutodeskFormat | null>;
|
|
430
|
+
setSectionsData: (sectionsData: any, unit: string, showCoachmark: boolean) => Promise<boolean>;
|
|
431
|
+
setSectionBox: (minXYZ: Vector3, maxXYZ: Vector3, rotation: Vector3, showCoachmark: boolean) => Promise<void>;
|
|
432
|
+
resetSectionBox: () => Promise<void>;
|
|
433
|
+
removeSectionBox: () => Promise<void>;
|
|
434
|
+
addSectionPlane: (distance: number, normal: Vector3, showCoachmark: boolean) => void;
|
|
435
|
+
removeSectionPlane: (uuid: string) => void;
|
|
436
|
+
clearSection: () => Promise<void>;
|
|
440
437
|
configureSectionBoxDisplay: (config: {
|
|
441
438
|
dropdown?: boolean;
|
|
442
439
|
hidePlanes?: boolean;
|
|
@@ -457,63 +454,47 @@ export declare class Webviewer {
|
|
|
457
454
|
setNavigationMode: (mode: NavigationMode) => void;
|
|
458
455
|
setOptions: (opts: {
|
|
459
456
|
selection: string;
|
|
460
|
-
}) =>
|
|
457
|
+
}) => void;
|
|
461
458
|
MapToModelSpace: (point: Vector2, modelA: Vector2, modelB: Vector2, planA: Vector2, planB: Vector2, imgSize: Vector2, rect: Vector2, direction: Vector2, applyOffset: boolean) => Promise<{
|
|
462
459
|
x?: number;
|
|
463
460
|
y?: number;
|
|
464
461
|
dir_x?: number;
|
|
465
462
|
dir_y?: number;
|
|
466
|
-
}
|
|
467
|
-
x?: number;
|
|
468
|
-
y?: number;
|
|
469
|
-
dir_x?: number;
|
|
470
|
-
dir_y?: number;
|
|
471
|
-
};
|
|
463
|
+
}>;
|
|
472
464
|
ModelToMapSpace: (point: Vector2, modelA: Vector2, modelB: Vector2, planA: Vector2, planB: Vector2, imgSize: Vector2, rect: Vector2, direction: Vector2, applyOffset: boolean) => Promise<{
|
|
473
465
|
x?: number;
|
|
474
466
|
y?: number;
|
|
475
467
|
dir_x?: number;
|
|
476
468
|
dir_y?: number;
|
|
477
|
-
}
|
|
478
|
-
x?: number;
|
|
479
|
-
y?: number;
|
|
480
|
-
dir_x?: number;
|
|
481
|
-
dir_y?: number;
|
|
482
|
-
};
|
|
469
|
+
}>;
|
|
483
470
|
getGlobalOffset: () => Promise<{
|
|
484
471
|
offsetX: number;
|
|
485
472
|
offsetY: number;
|
|
486
473
|
offsetZ: number;
|
|
487
|
-
} | null
|
|
488
|
-
offsetX: number;
|
|
489
|
-
offsetY: number;
|
|
490
|
-
offsetZ: number;
|
|
491
|
-
} | null;
|
|
474
|
+
} | null>;
|
|
492
475
|
setXRayMode: () => void;
|
|
493
476
|
setNormalMode: () => void;
|
|
494
|
-
getObject: (id: number, objectTreeName?: string) => Promise<PublicNode | undefined
|
|
495
|
-
getObjects: (objectIds: number[], objectTreeName?: string) => Promise<PublicNode[]
|
|
477
|
+
getObject: (id: number, objectTreeName?: string) => Promise<PublicNode | undefined>;
|
|
478
|
+
getObjects: (objectIds: number[], objectTreeName?: string) => Promise<PublicNode[]>;
|
|
496
479
|
getNumObjectsSelected: (method: string) => Promise<{
|
|
497
480
|
count: number;
|
|
498
481
|
}>;
|
|
499
482
|
getNumObjectsHidden: () => Promise<{
|
|
500
483
|
count: number;
|
|
501
|
-
}
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
getRootObject: (objectTreeName?: string) => Promise<PublicNode | undefined> | PublicNode | undefined;
|
|
505
|
-
hideObjects: (objectIds: number[], objectTreeName?: string) => Promise<boolean> | boolean;
|
|
484
|
+
}>;
|
|
485
|
+
getRootObject: (objectTreeName?: string) => Promise<PublicNode | undefined>;
|
|
486
|
+
hideObjects: (objectIds: number[], objectTreeName?: string) => Promise<boolean>;
|
|
506
487
|
hideAllObjects: (objectTreeName?: string) => Promise<boolean>;
|
|
507
|
-
unhideAllObjects: () => Promise<boolean
|
|
508
|
-
unhideObjects: (objectIds: number[], objectTreeName?: string) => Promise<boolean
|
|
488
|
+
unhideAllObjects: () => Promise<boolean>;
|
|
489
|
+
unhideObjects: (objectIds: number[], objectTreeName?: string) => Promise<boolean>;
|
|
509
490
|
getHiddenObjects: () => Promise<number[]> | number[];
|
|
510
|
-
selectObjects: (objectIds: number[], objectTreeName?: string) => Promise<boolean
|
|
511
|
-
deselectAllObjects: () => Promise<boolean
|
|
512
|
-
deselectObjects: (objectIds: number[], objectTreeName?: string) => Promise<boolean
|
|
491
|
+
selectObjects: (objectIds: number[], objectTreeName?: string) => Promise<boolean>;
|
|
492
|
+
deselectAllObjects: () => Promise<boolean>;
|
|
493
|
+
deselectObjects: (objectIds: number[], objectTreeName?: string) => Promise<boolean>;
|
|
513
494
|
selectAllObjects: (objectTreeName?: string) => Promise<boolean>;
|
|
514
|
-
getSelectedObjects: () => Promise<number[]
|
|
515
|
-
setMeasurement: (enable: boolean) =>
|
|
516
|
-
setObjectColor: (palettes: any) =>
|
|
495
|
+
getSelectedObjects: () => Promise<number[]>;
|
|
496
|
+
setMeasurement: (enable: boolean) => void;
|
|
497
|
+
setObjectColor: (palettes: any) => void;
|
|
517
498
|
clearObjectColor: (objectIds: number[]) => Promise<void> | void;
|
|
518
499
|
clearAllObjectColor: () => Promise<void> | void;
|
|
519
500
|
filterObjectTree: (objectIds: number[]) => Promise<void>;
|