@procore/bim-webviewer-sdk 15.3.0 → 15.4.0-BIM-4478.0

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.
Files changed (46) hide show
  1. package/CHANGELOG.md +26 -0
  2. package/dist/Procore.Bim.Webviewer.d.ts +30 -74
  3. package/dist/Procore.Bim.Webviewer.js +1 -1
  4. package/dist/types/src/Webviewer.d.ts +1 -1
  5. package/dist/types/src/api/analytic_events/payloadFactories.d.ts +0 -3
  6. package/dist/types/src/controllers/Bootstrapper.d.ts +0 -1
  7. package/dist/types/src/controllers/PubSubController.d.ts +0 -1
  8. package/dist/types/src/controllers/RenderController.d.ts +65 -68
  9. package/dist/types/src/controllers/RenderControllerProxy.d.ts +17 -17
  10. package/dist/types/src/controllers/RenderControllerWorker.d.ts +2 -2
  11. package/dist/types/src/controllers/RendererFactory.d.ts +1 -1
  12. package/dist/types/src/navigation/NavigationModel.d.ts +16 -1
  13. package/dist/types/src/picking/PickingController.d.ts +3 -3
  14. package/dist/types/src/procoregl/MeshGeometry.d.ts +0 -1
  15. package/dist/types/src/procoregl/Models/Models.d.ts +114 -0
  16. package/dist/types/src/procoregl/Models/__tests__/Models.test.d.ts +6 -0
  17. package/dist/types/src/procoregl/Models/index.d.ts +1 -0
  18. package/dist/types/src/procoregl/Models/translateVirtualMeshnodeIndex.d.ts +5 -0
  19. package/dist/types/src/procoregl/PartitionsRenderer.d.ts +15 -4
  20. package/dist/types/src/procoregl/PartitionsRendererImpl.d.ts +9 -18
  21. package/dist/types/src/procoregl/{KDTree.d.ts → SceneGraph/KDTree.d.ts} +9 -8
  22. package/dist/types/src/procoregl/{KDTreeNode.d.ts → SceneGraph/KDTreeNode.d.ts} +3 -4
  23. package/dist/types/src/procoregl/{WASMTree.d.ts → SceneGraph/WASMTree.d.ts} +3 -3
  24. package/dist/types/src/procoregl/SceneGraph/utils.d.ts +2 -0
  25. package/dist/types/src/procoregl/SelectedNodeServices/SelectedNodeServices.d.ts +1 -2
  26. package/dist/types/src/procoregl/StreamedMeshGeometry.d.ts +0 -1
  27. package/dist/types/src/procoregl/ViewerRenderer.d.ts +7 -24
  28. package/dist/types/src/procoregl/__tests__/MockMeshnode.d.ts +1 -0
  29. package/dist/types/src/pwfreader/PWF.d.ts +19 -28
  30. package/dist/types/src/pwfreader/shared/MeshServices.d.ts +1 -1
  31. package/dist/types/src/pwfreader/shared/Meshnode.d.ts +1 -0
  32. package/dist/types/src/pwfreader/streaming/PartitionProxy.d.ts +7 -6
  33. package/dist/types/src/pwfreader/streaming/StreamedMeshServices.d.ts +1 -1
  34. package/dist/types/src/sectioning/SectionController.d.ts +2 -2
  35. package/dist/types/src/utils/DebugGui/MainThreadDebugGui.d.ts +1 -1
  36. package/dist/types/src/utils/DebugGui/WorkerDebugGui.d.ts +1 -1
  37. package/dist/types/src/utils/DebugGui/guifyObject.d.ts +9 -3
  38. package/dist/types/src/utils/ZoomExtents/createZoomExtentsDebugGui.d.ts +14 -7
  39. package/package.json +1 -1
  40. package/dist/types/src/procoregl/RelevantMeshnodesSet/RelevantMeshnodesSet.d.ts +0 -31
  41. package/dist/types/src/procoregl/StandardRenderer.d.ts +0 -91
  42. package/dist/types/src/procoregl/StandardRendererImpl.d.ts +0 -63
  43. /package/dist/types/src/procoregl/{__tests__/KDTree.test.d.ts → Models/__tests__/translateVirtualMeshnodeIndex.test.d.ts} +0 -0
  44. /package/dist/types/src/procoregl/{__tests__/KDTreeNode.test.d.ts → SceneGraph/__tests__/KDTree.test.d.ts} +0 -0
  45. /package/dist/types/src/procoregl/{__tests__/StandardRenderer.test.d.ts → SceneGraph/__tests__/KDTreeNode.test.d.ts} +0 -0
  46. /package/dist/types/src/procoregl/{__tests__ → SceneGraph/__tests__}/WASMTree.test.d.ts +0 -0
package/CHANGELOG.md CHANGED
@@ -5,6 +5,32 @@ 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
+ - When `Webviewer` is initialized with multiple `resources`, they are now all rendered. Most functionality is not yet working for any resource but the first, but rendering is!
13
+
14
+ ### Changed
15
+
16
+ - [Internal][QA Ignore] Improved types on DebugGui.add's configureStore callback. This saves us from a lot of TS casting or ignoring when working with DebugGui.
17
+ - [Internal][QA Ignore] Add `npm run cy:run:ci` for use in running our Cypress test suite in continuous integration. Specifically, it initializes `Webviewer` with `enableWebWorker` false because test coverage was not being picked up on code that ran in the worker and test coverage is currently our primary reason for running Cypress in CI.
18
+
19
+ ### Fixed
20
+
21
+ - `camera.setPose` now sets the camera based on the "refined global bounding box", which is the global bounding box with "space junk" eliminated, rather than the raw global bounding box.
22
+ - This was a problem because `setPose` could set the camera extremely far from the actual model--to the point where you couldn't see anything--if there was some random object out in the void (i.e. "space junk").
23
+
24
+ ## [15.4.0] - 2024-07-19
25
+
26
+ ### Fixed
27
+
28
+ - Measurement Tool tooltip label is no longer a fixed width and will resize with the text content.
29
+
30
+ ### Changed
31
+
32
+ - Loading screen message is re-arranged.
33
+
8
34
  ## [15.3.0] - 2024-06-21
9
35
 
10
36
  ### Changed
@@ -1,6 +1,3 @@
1
- import { Matrix4 } from 'three/src/math/Matrix4';
2
- import { Vector3 as Vector3_2 } from 'three/src/math/Vector3';
3
-
4
1
  export declare const ACTION: {
5
2
  readonly NONE: -1;
6
3
  readonly PAN: 1;
@@ -254,26 +251,6 @@ declare type GPUMeshData = {
254
251
 
255
252
  export declare type HEX = `#${string}`;
256
253
 
257
- declare class KDTree {
258
- private MAX_CHILDREN_PER_NODE;
259
- private root;
260
- private tmpFrustum;
261
- private queue;
262
- private result;
263
- constructor();
264
- cullTree(cameraPosition: Vector3_2, frustumMatrix: Matrix4, detailsParam: number): {
265
- opaques: Meshnode[];
266
- transparents: Meshnode[];
267
- };
268
- buildTree(meshnodes: Meshnode[]): {
269
- isComplete: boolean;
270
- };
271
- collectMeshnodes(cameraPosition: Vector3_2, detailsFactor: number): {
272
- opaques: Meshnode[];
273
- transparents: Meshnode[];
274
- };
275
- }
276
-
277
254
  declare interface Logger {
278
255
  logError(error: any): void;
279
256
  }
@@ -333,7 +310,6 @@ declare class MeshGeometry {
333
310
  color: number;
334
311
  opacity: number;
335
312
  drawType: number;
336
- lastFrameId: number;
337
313
  numFaces: number;
338
314
  constructor(meshData: GPUMeshData, color: number, opacity: number, drawType: number);
339
315
  }
@@ -365,6 +341,7 @@ declare class Meshnode {
365
341
  isNode(): boolean;
366
342
  isMeshnode(): this is Meshnode;
367
343
  index(): number;
344
+ virtualIndex(): number;
368
345
  meshGeometries(): MeshGeometry[];
369
346
  protected geometries(): MeshGeometry[];
370
347
  private meshData;
@@ -434,7 +411,7 @@ declare class MeshServices {
434
411
  isComplete: boolean;
435
412
  };
436
413
  private loadToGPU;
437
- getMeshVerticesAndFaces(meshOffset: number, _meshnodeOffset: number): MeshVerticesAndFaces;
414
+ getMeshVerticesAndFaces(meshOffset: number): MeshVerticesAndFaces;
438
415
  private loadMeshGeometryToGPU;
439
416
  }
440
417
 
@@ -663,13 +640,14 @@ declare class PartitionProxy {
663
640
  };
664
641
  private _byteLength?;
665
642
  private _compressedByteLength?;
666
- static Stats: {
667
- PartitionsLoaded: number;
668
- MeshesLoaded: number;
669
- VerticesLoaded: number;
670
- FacesLoaded: number;
671
- };
643
+ private stats;
672
644
  constructor(pwfPartitionProxy: PWFPartitionProxy);
645
+ meshCount(): number;
646
+ incrementMeshCount(numMeshes: number): void;
647
+ vertexCount(): number;
648
+ incrementVertexCount(numVertices: number): void;
649
+ faceCount(): number;
650
+ incrementFaceCount(numFaces: number): void;
673
651
  partitionId(): number;
674
652
  partitionUrl(): string;
675
653
  meshnodeOffsets(): Uint32Array;
@@ -742,7 +720,6 @@ declare class PWF {
742
720
  offsetY: number;
743
721
  offsetZ: number;
744
722
  };
745
- sceneGraphName: any;
746
723
  isLogging: any;
747
724
  locale: any;
748
725
  downloadMetaData: any;
@@ -750,12 +727,22 @@ declare class PWF {
750
727
  nodeServices: NodeServices | null;
751
728
  meshnodeServices: StreamedMeshnodeServices | MeshnodeServices | null;
752
729
  meshServices: StreamedMeshServices | MeshServices | null;
753
- sceneGraph: WASMTree | KDTree | null;
754
730
  bvhTree: BVHTree | null;
755
731
  measureSet: any[];
756
732
  _gl: any;
757
733
  manifest: any;
758
734
  _numMeshnodes: number;
735
+ detailsParams: {
736
+ detailsInMotion: number;
737
+ detailsAtRest: number;
738
+ };
739
+ virtualMeshnodeIndexOffset: number;
740
+ resourceId: any;
741
+ pwfModel: {
742
+ nodes: never[];
743
+ meshnodes: never[];
744
+ meshes: never[];
745
+ };
759
746
  loadPWFVersion(version: any): void;
760
747
  version: typeof V1 | typeof V2 | undefined;
761
748
  setArrayBuffers(nodeAB: any, meshnodeAB: any, meshAB: any): void;
@@ -763,21 +750,12 @@ declare class PWF {
763
750
  nodeAB: any;
764
751
  meshnodeAB: any;
765
752
  meshAB: any;
766
- detailsParams: {
767
- [key: string]: any;
768
- } | undefined;
769
753
  setPartitionedModelBuffers(nodeAB: any, meshnodeAB: any, partitionProxiesAB: any): void;
770
754
  partitionProxiesAB: ArrayBuffer | undefined;
771
- computeDetailsValues(): number[];
772
755
  getNumPartitions(): number;
773
756
  initPwfParser(): void;
774
757
  pwfModelParser: PWFModelParser | undefined;
775
758
  _numMeshes: number | undefined;
776
- pwfModel: {
777
- nodes: never[];
778
- meshnodes: never[];
779
- meshes: never[];
780
- } | undefined;
781
759
  parsePwfNodes(): {
782
760
  isComplete: boolean;
783
761
  };
@@ -790,22 +768,15 @@ declare class PWF {
790
768
  initMeshnodeServices(): void;
791
769
  initNodeTree(): {
792
770
  nodes: {
793
- [key: string]: Node_2 | Meshnode;
771
+ [key: string]: Meshnode | Node_2;
794
772
  };
795
773
  isComplete: boolean;
796
774
  };
797
775
  initNodeTreeBoundingBoxes(): {
798
776
  isComplete: boolean;
799
777
  };
800
- meshnodes: null;
801
- initSceneGraph(sceneGraphName: any): {
802
- isComplete: boolean;
803
- };
804
- sceneGraphFactory(impl: any): WASMTree | KDTree;
805
778
  allMeshnodes(): Meshnode[];
806
- rebuildSceneGraph(lessRelevantMeshnodes: any): void;
807
779
  getNodeServices(): NodeServices | null;
808
- getSceneGraph(): WASMTree | KDTree | null;
809
780
  getMeshnodeFromIndex(index: any): Meshnode;
810
781
  getParentNodeIds(nodeId: any): any[];
811
782
  getSubtreeNodeIds(nodeId: any): any[];
@@ -818,9 +789,9 @@ declare class PWF {
818
789
  refresh: boolean | undefined;
819
790
  hasMeasureIds(arr: any): boolean;
820
791
  removeMeasureIds(meshnodeIndices: any): void;
821
- getMeshnodeFromNodeId(nodeId: any): Node_2 | Meshnode;
792
+ getMeshnodeFromNodeId(nodeId: any): Meshnode | Node_2;
822
793
  getMeshnode(offset: any): Meshnode;
823
- getNode(offset: any): Node_2 | Meshnode;
794
+ getNode(offset: any): Meshnode | Node_2;
824
795
  numNodes(): number;
825
796
  numMeshnodes(): number;
826
797
  numMeshes(): number;
@@ -844,11 +815,11 @@ declare class PWF {
844
815
  root(): Node_2;
845
816
  forEachMeshnode(callback: any): void;
846
817
  forEachNode(callback: any): void;
847
- getMeshVerticesAndFaces(meshRef: any, meshnodeOffset: any): MeshVerticesAndFaces;
848
- findFirstObject(meshnodeIndex: any): Node_2;
849
- captureModelStats(): void;
850
- captureStandardModelStats(pwfModel: any): void;
851
- capturePartitionedModelStats(pwfModel: any): void;
818
+ getMeshVerticesAndFaces(meshRef: any): MeshVerticesAndFaces;
819
+ findFirstObject(virtualMeshnodeIndex: any): Node_2;
820
+ captureModelStats(): number;
821
+ captureStandardModelStats(pwfModel: any): number;
822
+ capturePartitionedModelStats(pwfModel: any): number | undefined;
852
823
  numFirstObjects(): number;
853
824
  #private;
854
825
  }
@@ -994,7 +965,6 @@ declare class StreamedMeshGeometry extends MeshGeometry {
994
965
  verticesGLBuffer: WebGLBuffer | null;
995
966
  facesLength: number;
996
967
  facesGLBuffer: WebGLBuffer | null;
997
- lastFrameId: number;
998
968
  constructor(color: number, opacity: number, drawType: number, vertexArrayObject: WebGLVertexArrayObject | null, numVertices: number, verticesBuffer: WebGLBuffer | null, numFaces: number, facesBuffer: WebGLBuffer | null, facesBytesLength: number, index: number);
999
969
  }
1000
970
 
@@ -1016,7 +986,7 @@ declare class StreamedMeshnodeServices extends MeshnodeServices {
1016
986
 
1017
987
  declare class StreamedMeshServices extends MeshServices {
1018
988
  constructor(pwf: PWF);
1019
- getMeshVerticesAndFaces(meshOffset: number, _meshnodeOffset: number): MeshVerticesAndFaces;
989
+ getMeshVerticesAndFaces(meshOffset: number): MeshVerticesAndFaces;
1020
990
  loadPartitionContainingMeshnode(streamedMeshnode: StreamedMeshnode): Promise<void>;
1021
991
  getMeshGeometryForOffsets(meshOffset: number, meshnodeOffset: number): StreamedMeshGeometry | undefined;
1022
992
  }
@@ -1117,20 +1087,6 @@ export declare type Visibility = {
1117
1087
  };
1118
1088
  };
1119
1089
 
1120
- declare class WASMTree {
1121
- static maxChunkSize: number;
1122
- meshnodes: any[];
1123
- currentIndex: number;
1124
- cullTree(cameraPosition: any, projectviewMatrix: any, detailsParam: any): {
1125
- opaques: any[];
1126
- transparents: any[];
1127
- };
1128
- maxChunkSize: number;
1129
- buildTree(meshnodes: any): {
1130
- isComplete: boolean;
1131
- };
1132
- }
1133
-
1134
1090
  export declare type WebFormatExtractionItem = {
1135
1091
  item_type: 'WebFormat';
1136
1092
  artifact: {
@@ -1252,7 +1208,7 @@ export declare class Webviewer {
1252
1208
  position: Vector3;
1253
1209
  lookAt: Vector3;
1254
1210
  };
1255
- cameraUp?: Vector3 | undefined;
1211
+ cameraUp?: Vector3;
1256
1212
  }) => Promise<void>;
1257
1213
  };
1258
1214
  markup: {