@procore/bim-webviewer-sdk 15.4.0 → 15.5.0-plane-mapping.1

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 (45) hide show
  1. package/CHANGELOG.md +20 -0
  2. package/dist/Procore.Bim.Webviewer.d.ts +62 -92
  3. package/dist/Procore.Bim.Webviewer.js +1 -1
  4. package/dist/types/src/Webviewer.d.ts +14 -4
  5. package/dist/types/src/components/CoachmarkManagerComponent/CoachmarkComponent.d.ts +2 -0
  6. package/dist/types/src/components/CoachmarkManagerComponent/CoachmarkManagerComponent.d.ts +10 -0
  7. package/dist/types/src/components/CoachmarkManagerComponent/Coachmarks.d.ts +2 -0
  8. package/dist/types/src/components/Tooltip/Tooltip.d.ts +21 -0
  9. package/dist/types/src/components/Tooltip/index.d.ts +1 -0
  10. package/dist/types/src/controllers/RenderController.d.ts +47 -47
  11. package/dist/types/src/controllers/RenderControllerProxy.d.ts +3 -3
  12. package/dist/types/src/controllers/RenderControllerWorker.d.ts +1 -1
  13. package/dist/types/src/controllers/ShortestDistanceController.d.ts +16 -0
  14. package/dist/types/src/navigation/NavigationModel.d.ts +16 -1
  15. package/dist/types/src/picking/PickingController.d.ts +3 -3
  16. package/dist/types/src/procoregl/ColorServices/ColorServices.d.ts +17 -13
  17. package/dist/types/src/procoregl/Models/Models.d.ts +51 -19
  18. package/dist/types/src/procoregl/Models/__tests__/Models.test.d.ts +6 -1
  19. package/dist/types/src/procoregl/Models/translateVirtualMeshnodeIndex.d.ts +5 -0
  20. package/dist/types/src/procoregl/PartitionsRenderer.d.ts +14 -3
  21. package/dist/types/src/procoregl/PartitionsRendererImpl.d.ts +5 -7
  22. package/dist/types/src/procoregl/{KDTree.d.ts → SceneGraph/KDTree.d.ts} +2 -1
  23. package/dist/types/src/procoregl/{KDTreeNode.d.ts → SceneGraph/KDTreeNode.d.ts} +1 -1
  24. package/dist/types/src/procoregl/SceneGraph/__tests__/KDTreeNode.test.d.ts +1 -0
  25. package/dist/types/src/procoregl/SceneGraph/__tests__/WASMTree.test.d.ts +1 -0
  26. package/dist/types/src/procoregl/SceneGraph/utils.d.ts +2 -0
  27. package/dist/types/src/procoregl/ViewerRenderer.d.ts +4 -6
  28. package/dist/types/src/procoregl/__tests__/MockMeshnode.d.ts +1 -0
  29. package/dist/types/src/pwfreader/PWF.d.ts +15 -45
  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/StreamedMeshServices.d.ts +1 -1
  33. package/dist/types/src/sdk.d.ts +0 -1
  34. package/dist/types/src/utils/DebugGui/MainThreadDebugGui.d.ts +1 -1
  35. package/dist/types/src/utils/DebugGui/WorkerDebugGui.d.ts +1 -1
  36. package/dist/types/src/utils/DebugGui/guifyObject.d.ts +9 -3
  37. package/dist/types/src/utils/GlobalBoundingBox/globalBoundingBox.d.ts +26 -21
  38. package/dist/types/src/utils/GlobalBoundingBox/index.d.ts +1 -1
  39. package/dist/types/src/utils/ZoomExtents/computeRefinedBbox.d.ts +12 -5
  40. package/dist/types/src/utils/ZoomExtents/createZoomExtentsDebugGui.d.ts +14 -7
  41. package/package.json +1 -1
  42. /package/dist/types/src/{procoregl/__tests__/KDTree.test.d.ts → controllers/__tests__/ShortestDistanceController.test.d.ts} +0 -0
  43. /package/dist/types/src/procoregl/{__tests__/KDTreeNode.test.d.ts → Models/__tests__/translateVirtualMeshnodeIndex.test.d.ts} +0 -0
  44. /package/dist/types/src/procoregl/{WASMTree.d.ts → SceneGraph/WASMTree.d.ts} +0 -0
  45. /package/dist/types/src/procoregl/{__tests__/WASMTree.test.d.ts → SceneGraph/__tests__/KDTree.test.d.ts} +0 -0
package/CHANGELOG.md CHANGED
@@ -5,6 +5,26 @@ 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
+ ### Changed
11
+
12
+ - [Internal] Move shortest distance related functions into `ShortestDistanceController.ts` and use virtualMeshnodeIndex for all the shortestDistance functions.
13
+ - [Internal] Refactored `GlobalBoundingBox` class (used as a singleton) to have one main method (`getGlobalBoundingBox`) that abstracts away the difference between the "user defined global bounding box" and the "refined global bounding box", which was the class's original purpose but it wasn't fulfilling as well as it could have. This also required updating it to be fully initialized in its constructor and consolidating the `RenderController` code that initializes it.
14
+ - Color override methods now accept an optional `resourceId` parameter, which allows color overriding objects on multiple loaded models. If no `resourceId` is provided then the object ids will be assumed to reference the first model.
15
+
16
+ ## [15.5.0] - 2024-08-02
17
+
18
+ ### Added
19
+
20
+ - 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!
21
+
22
+ ### Fixed
23
+
24
+ - `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.
25
+ - 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").
26
+ - The space junk removal algorithm has been improved for models where there is space junk at various distances away. For example, one space junk at 50_000 feet away and one at 10_000 feet away for a model that is only 1000 feet across. The one at 10_000 feet should now be correctly identified as space junk.
27
+
8
28
  ## [15.4.0] - 2024-07-19
9
29
 
10
30
  ### Fixed
@@ -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 readonly root;
260
- private frustum;
261
- private queue;
262
- private readonly result;
263
- constructor();
264
- cullTree(cameraPosition: Vector3_2, frustumMatrix: Matrix4, detailsParam: number): {
265
- opaques: Set<Meshnode>;
266
- transparents: Set<Meshnode>;
267
- };
268
- buildTree(meshnodes: Meshnode[]): {
269
- isComplete: boolean;
270
- };
271
- collectMeshnodes(cameraPosition: Vector3_2, detailsFactor: number): {
272
- opaques: Set<Meshnode>;
273
- transparents: Set<Meshnode>;
274
- };
275
- }
276
-
277
254
  declare interface Logger {
278
255
  logError(error: any): void;
279
256
  }
@@ -364,6 +341,7 @@ declare class Meshnode {
364
341
  isNode(): boolean;
365
342
  isMeshnode(): this is Meshnode;
366
343
  index(): number;
344
+ virtualIndex(): number;
367
345
  meshGeometries(): MeshGeometry[];
368
346
  protected geometries(): MeshGeometry[];
369
347
  private meshData;
@@ -433,7 +411,7 @@ declare class MeshServices {
433
411
  isComplete: boolean;
434
412
  };
435
413
  private loadToGPU;
436
- getMeshVerticesAndFaces(meshOffset: number, _meshnodeOffset: number): MeshVerticesAndFaces;
414
+ getMeshVerticesAndFaces(meshOffset: number): MeshVerticesAndFaces;
437
415
  private loadMeshGeometryToGPU;
438
416
  }
439
417
 
@@ -733,7 +711,6 @@ export declare type PublicNode = {
733
711
  };
734
712
 
735
713
  declare class PWF {
736
- static SMALLEST_OBJECT_AT_10_FEET: number;
737
714
  static timeSince(time: any): string;
738
715
  static isPartitionProxiesAB(meshAB: any): boolean;
739
716
  constructor(params: any);
@@ -743,7 +720,6 @@ declare class PWF {
743
720
  offsetY: number;
744
721
  offsetZ: number;
745
722
  };
746
- sceneGraphName: any;
747
723
  isLogging: any;
748
724
  locale: any;
749
725
  downloadMetaData: any;
@@ -751,7 +727,6 @@ declare class PWF {
751
727
  nodeServices: NodeServices | null;
752
728
  meshnodeServices: StreamedMeshnodeServices | MeshnodeServices | null;
753
729
  meshServices: StreamedMeshServices | MeshServices | null;
754
- sceneGraph: WASMTree | KDTree | null;
755
730
  bvhTree: BVHTree | null;
756
731
  measureSet: any[];
757
732
  _gl: any;
@@ -761,6 +736,13 @@ declare class PWF {
761
736
  detailsInMotion: number;
762
737
  detailsAtRest: number;
763
738
  };
739
+ virtualMeshnodeIndexOffset: number;
740
+ resourceId: any;
741
+ pwfModel: {
742
+ nodes: never[];
743
+ meshnodes: never[];
744
+ meshes: never[];
745
+ };
764
746
  loadPWFVersion(version: any): void;
765
747
  version: typeof V1 | typeof V2 | undefined;
766
748
  setArrayBuffers(nodeAB: any, meshnodeAB: any, meshAB: any): void;
@@ -770,25 +752,10 @@ declare class PWF {
770
752
  meshAB: any;
771
753
  setPartitionedModelBuffers(nodeAB: any, meshnodeAB: any, partitionProxiesAB: any): void;
772
754
  partitionProxiesAB: ArrayBuffer | undefined;
773
- MODEL_PERFORMANCE_DATA: {
774
- model: string;
775
- numFaces: number;
776
- detailsInMotion: number;
777
- }[];
778
- interpolateDetailsFactor(faceCount: any): number | null;
779
- computeDetailsParam(totalFaces: any): {
780
- detailsInMotion: number | null;
781
- detailsAtRest: number;
782
- };
783
755
  getNumPartitions(): number;
784
756
  initPwfParser(): void;
785
757
  pwfModelParser: PWFModelParser | undefined;
786
758
  _numMeshes: number | undefined;
787
- pwfModel: {
788
- nodes: never[];
789
- meshnodes: never[];
790
- meshes: never[];
791
- } | undefined;
792
759
  parsePwfNodes(): {
793
760
  isComplete: boolean;
794
761
  };
@@ -801,36 +768,24 @@ declare class PWF {
801
768
  initMeshnodeServices(): void;
802
769
  initNodeTree(): {
803
770
  nodes: {
804
- [key: string]: Node_2 | Meshnode;
771
+ [key: string]: Meshnode | Node_2;
805
772
  };
806
773
  isComplete: boolean;
807
774
  };
808
775
  initNodeTreeBoundingBoxes(): {
809
776
  isComplete: boolean;
810
777
  };
811
- meshnodes: null;
812
- initSceneGraph(sceneGraphName: any): {
813
- isComplete: boolean;
814
- };
815
- sceneGraphFactory(impl: any): WASMTree | KDTree;
816
778
  allMeshnodes(): Meshnode[];
817
779
  getNodeServices(): NodeServices | null;
818
- getSceneGraph(): WASMTree | KDTree | null;
819
780
  getMeshnodeFromIndex(index: any): Meshnode;
820
781
  getParentNodeIds(nodeId: any): any[];
821
782
  getSubtreeNodeIds(nodeId: any): any[];
822
- getSubtreeMeshnodeIndex(nodeId: any): any[];
783
+ getVirtualMeshnodeIndexesByNodeId(nodeId: any): any[];
823
784
  getNamedNode(nodeId: any): Node_2 | undefined;
824
- getSubObjects(node: any, subArr: any): void;
825
- getMeasureIds(): any[];
826
- addMeasureIds(meshnodeIndices: any): void;
827
- clearMeasureIds(): void;
828
- refresh: boolean | undefined;
829
- hasMeasureIds(arr: any): boolean;
830
- removeMeasureIds(meshnodeIndices: any): void;
831
- getMeshnodeFromNodeId(nodeId: any): Node_2 | Meshnode;
785
+ getSubTreeVirtualMeshnodeIndexes(node: any, subArr: any): void;
786
+ getMeshnodeFromNodeId(nodeId: any): Meshnode | Node_2;
832
787
  getMeshnode(offset: any): Meshnode;
833
- getNode(offset: any): Node_2 | Meshnode;
788
+ getNode(offset: any): Meshnode | Node_2;
834
789
  numNodes(): number;
835
790
  numMeshnodes(): number;
836
791
  numMeshes(): number;
@@ -854,14 +809,9 @@ declare class PWF {
854
809
  root(): Node_2;
855
810
  forEachMeshnode(callback: any): void;
856
811
  forEachNode(callback: any): void;
857
- getMeshVerticesAndFaces(meshRef: any, meshnodeOffset: any): MeshVerticesAndFaces;
858
- findFirstObject(meshnodeIndex: any): Node_2;
859
- captureModelStats(): {
860
- [key: string]: any;
861
- };
862
- detailsParam: {
863
- [key: string]: any;
864
- } | undefined;
812
+ getMeshVerticesAndFaces(meshRef: any): MeshVerticesAndFaces;
813
+ findFirstObject(virtualMeshnodeIndex: any): Node_2;
814
+ captureModelStats(): number;
865
815
  captureStandardModelStats(pwfModel: any): number;
866
816
  capturePartitionedModelStats(pwfModel: any): number | undefined;
867
817
  numFirstObjects(): number;
@@ -965,12 +915,6 @@ export declare type RenderMode = (typeof RENDER_MODE)[keyof typeof RENDER_MODE];
965
915
 
966
916
  export declare type Resource = FileExtractionModePwfV1OverrideResource | FileExtractionModePwfV2OverrideResource | FileExtractionModeResource | ModelRevisionModePwfV1Resource | ModelRevisionModePwfV2Resource;
967
917
 
968
- export declare type ResourceDiscriminator = {
969
- fileExtractionId: number;
970
- } | {
971
- modelRevisionId: number;
972
- };
973
-
974
918
  export declare type ResourceOptions = CommonOptions & {
975
919
  resources: Resource[];
976
920
  };
@@ -1030,7 +974,7 @@ declare class StreamedMeshnodeServices extends MeshnodeServices {
1030
974
 
1031
975
  declare class StreamedMeshServices extends MeshServices {
1032
976
  constructor(pwf: PWF);
1033
- getMeshVerticesAndFaces(meshOffset: number, _meshnodeOffset: number): MeshVerticesAndFaces;
977
+ getMeshVerticesAndFaces(meshOffset: number): MeshVerticesAndFaces;
1034
978
  loadPartitionContainingMeshnode(streamedMeshnode: StreamedMeshnode): Promise<void>;
1035
979
  getMeshGeometryForOffsets(meshOffset: number, meshnodeOffset: number): StreamedMeshGeometry | undefined;
1036
980
  }
@@ -1086,6 +1030,37 @@ export declare const TOOL_BAR_TOOLS: {
1086
1030
 
1087
1031
  export declare type ToolBarTools = (typeof TOOL_BAR_TOOLS)[keyof typeof TOOL_BAR_TOOLS];
1088
1032
 
1033
+ declare const UnitUtil: {
1034
+ DisplayUnit: {
1035
+ readonly METERS: 0;
1036
+ readonly MILLIMETERS: 1;
1037
+ readonly FEETINCHES: 2;
1038
+ };
1039
+ Units: {
1040
+ readonly Meters: 0;
1041
+ readonly Centimeters: 1;
1042
+ readonly Millimeters: 2;
1043
+ readonly Feet: 3;
1044
+ readonly Inches: 4;
1045
+ readonly Yards: 5;
1046
+ readonly Kilometers: 6;
1047
+ readonly Miles: 7;
1048
+ readonly Micrometers: 8;
1049
+ readonly Mils: 9;
1050
+ readonly Microinches: 10;
1051
+ };
1052
+ ScaleFactors: readonly [readonly [1, 100, 1000, 3.28084, 39.37008, 1.0936133333333, 0.0010000000319999695, 0.0006213712121211932, 1000000.0319999696, 39370.08, 2.54e-8], readonly [0.01, 1, 10, 0.0328084, 0.393701, 0.0109361, 0.00001, 0.0000062137119224, 10000, 393.701, 393700.7874], readonly [0.001, 0.1, 1, 0.00328084, 0.0393701, 0.00109361, 0.000001, 6.2137e-7, 1000, 39.3701, 39370.1], readonly [0.3048, 30.48, 304.8, 1, 12, 0.333333, 0.0003048, 0.000189394, 304800, 12000, 12000000], readonly [0.0254, 2.54, 25.4, 0.0833333, 1, 0.0277778, 0.0000254, 0.0000157828283, 25400, 1000, 1000000], readonly [0.9144, 91.44, 914.4, 3, 36, 1, 0.0009144, 0.000568182, 914400, 36000, 36000000], readonly [1000, 100000, 1000000, 3280.84, 39370.1, 1093.61, 1, 0.621371, 1000000000, 0.621371, 39370078740.157], readonly [1609.34, 160934, 1609344, 5280, 63360, 1760, 1.60934, 1, 1609344000, 63360000, 63360000000], readonly [0.000001, 0.0001, 0.001, 0.00000328084, 0.000039370079, 0.000001093613, 1e-9, 6.214e-10, 1, 0.0393701, 39.37007874], readonly [0.0000254, 0.00254, 0.0254, 0.0000833333, 0.001, 0.0000277778, 2.54e-8, 1.57e-8, 25.4, 1, 1000], readonly [2.54e-8, 0.00000254, 0.0000254, 8.33e-8, 0.000001, 2.77e-8, 2.54e-11, 1.57e-11, 0.03, 0.001, 1]];
1053
+ unitFromAbbreviation: (abbv: string) => number;
1054
+ abbreviationFromDisplayUnit: (displayUnit: number) => string;
1055
+ unitConvert: (value: number, targetUnit: number, sourceUnit: number, pow: number) => number;
1056
+ vulgarFraction: (frac: number) => string;
1057
+ formatAs: (value: number, displayUnit: string) => string | {
1058
+ entire: string;
1059
+ whole: string;
1060
+ fraction: string;
1061
+ };
1062
+ };
1063
+
1089
1064
  declare namespace V1 {
1090
1065
  export {
1091
1066
  MeshnodeServices_2 as MeshnodeServices,
@@ -1131,20 +1106,6 @@ export declare type Visibility = {
1131
1106
  };
1132
1107
  };
1133
1108
 
1134
- declare class WASMTree {
1135
- static maxChunkSize: number;
1136
- meshnodes: any[];
1137
- currentIndex: number;
1138
- cullTree(cameraPosition: any, projectViewMatrix: any, detailsFactor: any): {
1139
- opaques: Set<any>;
1140
- transparents: Set<any>;
1141
- };
1142
- maxChunkSize: number;
1143
- buildTree(meshnodes: any): {
1144
- isComplete: boolean;
1145
- };
1146
- }
1147
-
1148
1109
  export declare type WebFormatExtractionItem = {
1149
1110
  item_type: 'WebFormat';
1150
1111
  artifact: {
@@ -1266,7 +1227,7 @@ export declare class Webviewer {
1266
1227
  position: Vector3;
1267
1228
  lookAt: Vector3;
1268
1229
  };
1269
- cameraUp?: Vector3 | undefined;
1230
+ cameraUp?: Vector3;
1270
1231
  }) => Promise<void>;
1271
1232
  };
1272
1233
  markup: {
@@ -1359,13 +1320,13 @@ export declare class Webviewer {
1359
1320
  getSelectedObjects: () => Promise<number[]>;
1360
1321
  setMeasurement: (enable: boolean) => void;
1361
1322
  setObjectColor: (palettes: PaletteParams[], options?: {
1362
- resource?: ResourceDiscriminator;
1323
+ resourceId?: number;
1363
1324
  }) => void;
1364
1325
  clearObjectColor: (objectIds: number[], options?: {
1365
- resource?: ResourceDiscriminator;
1326
+ resourceId?: number;
1366
1327
  }) => Promise<void> | void;
1367
1328
  clearAllObjectColor: (options?: {
1368
- resource?: ResourceDiscriminator;
1329
+ resourceId?: number;
1369
1330
  }) => Promise<void> | void;
1370
1331
  filterObjectTree: (objectIds: number[]) => Promise<void>;
1371
1332
  clearObjectTreeFilter: () => Promise<void>;
@@ -1393,9 +1354,18 @@ export declare class Webviewer {
1393
1354
  removeContextMenuItems: ({ contextMenuItemIds, }: {
1394
1355
  contextMenuItemIds: string[];
1395
1356
  }) => void;
1357
+ showCoachmark: (params: {
1358
+ id: string;
1359
+ label: string;
1360
+ buttonLabel: string;
1361
+ buttonOnClick?: () => void;
1362
+ tooltipMessage?: string;
1363
+ }) => void;
1364
+ hideCoachmark: (coachmarkId: string) => void;
1396
1365
  getSettings: () => {
1397
1366
  displayUnits: string;
1398
1367
  };
1368
+ formatNumberInUnit: (valueInFt: number, unit: string) => ReturnType<typeof UnitUtil.formatAs>;
1399
1369
  setToolbarHidden: (hidden: boolean) => void;
1400
1370
  setHotkeysEnabled: (enabled: boolean) => void;
1401
1371
  };