@procore/bim-webviewer-sdk 16.6.0-rc.1 → 16.6.0-rc.10

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 (59) hide show
  1. package/CHANGELOG.md +17 -0
  2. package/dist/Procore.Bim.Webviewer.d.ts +41 -70
  3. package/dist/Procore.Bim.Webviewer.js +1 -1
  4. package/dist/types/src/Webviewer.d.ts +1 -5
  5. package/dist/types/src/api/analytic_events/analyticKeys.d.ts +51 -29
  6. package/dist/types/src/api/analytic_events/index.d.ts +1 -1
  7. package/dist/types/src/api/analytic_events/payloadFactories.d.ts +10 -9
  8. package/dist/types/src/components/ContextMenuComponent/ContextMenuComponent.d.ts +1 -1
  9. package/dist/types/src/components/RootComponent.d.ts +3 -3
  10. package/dist/types/src/components/ShortestDistanceComponent.d.ts +9 -10
  11. package/dist/types/src/components/WindowModelObjectComponent/VirtualizedList.d.ts +1 -1
  12. package/dist/types/src/components/WindowModelObjectComponent/WindowModelObjectComponent.d.ts +3 -3
  13. package/dist/types/src/components/WindowTreeComponent.d.ts +0 -1
  14. package/dist/types/src/components/WindowTreeViewComponent.d.ts +2 -3
  15. package/dist/types/src/components/WindowViewPropertiesComponent/WindowViewPropertiesComponent.d.ts +3 -3
  16. package/dist/types/src/components/__tests__/ShortestDisanceFixtures.d.ts +21 -0
  17. package/dist/types/src/controllers/ApiController/ApiController.d.ts +2 -2
  18. package/dist/types/src/controllers/CacheController.d.ts +2 -2
  19. package/dist/types/src/controllers/DatabaseController.d.ts +1 -1
  20. package/dist/types/src/controllers/DomController/DomController.d.ts +0 -1
  21. package/dist/types/src/controllers/PubSubController.d.ts +1 -1
  22. package/dist/types/src/controllers/RenderController.d.ts +18 -26
  23. package/dist/types/src/controllers/RenderControllerProxy.d.ts +12 -16
  24. package/dist/types/src/controllers/RenderStatusType.d.ts +4 -4
  25. package/dist/types/src/measuring/MeasurementInterface.d.ts +10 -5
  26. package/dist/types/src/measuring/MeasurementManager.d.ts +4 -5
  27. package/dist/types/src/measuring/MeasurementRenderer.d.ts +1 -5
  28. package/dist/types/src/measuring/PointToPointManager.d.ts +6 -8
  29. package/dist/types/src/messages.d.ts +7 -7
  30. package/dist/types/src/navigation/Orbit/calcNewPosition.d.ts +0 -1
  31. package/dist/types/src/navigation/Orbit/getQuatToCylinderSpace.d.ts +0 -1
  32. package/dist/types/src/procoregl/HiddenNodeServices/HiddenNodeServices.d.ts +1 -1
  33. package/dist/types/src/procoregl/HiddenNodeServices/rangify.d.ts +2 -8
  34. package/dist/types/src/procoregl/Models/Models.d.ts +2 -5
  35. package/dist/types/src/procoregl/PartitionsRenderer.d.ts +3 -3
  36. package/dist/types/src/procoregl/ProcoreGeometries/ProcoreArrow.d.ts +0 -1
  37. package/dist/types/src/procoregl/ProcoreGeometries/StubbyArrow.d.ts +0 -1
  38. package/dist/types/src/procoregl/SectionDisplay/getCursorDirectionFromCameraToPlane.d.ts +1 -2
  39. package/dist/types/src/pwfreader/PWF.d.ts +3 -2
  40. package/dist/types/src/pwfreader/PWFCache.d.ts +1 -1
  41. package/dist/types/src/pwfreader/PWFProxy.d.ts +1 -1
  42. package/dist/types/src/pwfreader/PWFTypes.d.ts +0 -5
  43. package/dist/types/src/pwfreader/v1/PWFModelParser.d.ts +2 -5
  44. package/dist/types/src/pwfreader/v1/PWFV1.d.ts +3 -2
  45. package/dist/types/src/pwfreader/v1/impl/bufferReader/MeshnodeBufferReader.d.ts +2 -5
  46. package/dist/types/src/pwfreader/v2/Manifest.d.ts +3 -3
  47. package/dist/types/src/pwfreader/v2/PWFV2.d.ts +3 -2
  48. package/dist/types/src/sectioning/utils.d.ts +0 -1
  49. package/dist/types/src/threeShaking.d.ts +47 -47
  50. package/dist/types/src/unit_util.d.ts +5 -3
  51. package/dist/types/src/utils/Benchmark/MainThreadBenchmark.d.ts +2 -2
  52. package/dist/types/src/utils/DebugGui/MainThreadDebugGui.d.ts +1 -1
  53. package/dist/types/src/utils/DebugGui/WorkerDebugGui.d.ts +1 -1
  54. package/dist/types/src/utils/ZoomExtents/__tests__/computePoseToFitBoxFromPosition.test.d.ts +0 -1
  55. package/dist/types/src/utils/ZoomExtents/computeRefinedBbox.d.ts +2 -3
  56. package/dist/types/src/utils/ZoomExtents/utils.d.ts +0 -1
  57. package/dist/types/src/utils/i18n.d.ts +1 -1
  58. package/dist/types/src/validateOptions/checkTools.d.ts +1 -1
  59. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -5,6 +5,23 @@ 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
+ - ([#1393](https://github.com/procore/bim-webviewer/pull/1393)) [Internal][QA Ignore] Add `project.3d_models.webviewer.environment` analytics event that gathers information from `navigator.userAgent` and `navigator.storage` before bootstrapping.
13
+ - ([#1394](https://github.com/procore/bim-webviewer/pull/1394)) Automatic conversion of angle properties from radian to degrees (°) and correct formatting for angles in degrees.
14
+
15
+ ### Changed
16
+
17
+ - ([#866](https://github.com/procore/bim-webviewer/pull/1377)) [Internal][QA Ignore]Change fetchArray buffer to fetchData and add README file in pwfreader
18
+ - ([#1386](https://github.com/procore/bim-webviewer/pull/1386)) The Shortest Distance Measurement tool's cursor tooltip now displays "Select first object" then "Select second object" rather than just "Select two objects". This is to match behavior with the new Point to Point Measurement tool.
19
+ - ([#1382](https://github.com/procore/bim-webviewer/pull/1382)) [Breaking Change]Refactoring global offset to a type of vector3 and SDK method name change from `getGlobalOffset` to `getGlobalOffsetDoNotUse` to avoid 3rd party use.
20
+ - ([#1388](https://github.com/procore/bim-webviewer/pull/1388)) Escape key, when pressed, will now reset measurements that are either in progress or have been completed. If the measurement is enabled and in the initial state, pressing escape will disable the measurement tool.
21
+ - ([#1379](https://github.com/procore/bim-webviewer/pull/1379)) Fix the point to point crosshair size to 40px and align in the center.
22
+ - ([#1397](https://github.com/procore/bim-webviewer/pull/1397)) [Internal][QA Ignore] Update Typescript from v4 to v5
23
+ - ([#1400](https://github.com/procore/bim-webviewer/pull/1400)) Cursor tooltip for Measurement tool now uses clientX and clientY to position the tooltip. This is to prevent the tooltip from being positioned incorrectly when users mouse is over a child element of the bim main container.
24
+
8
25
  ## [16.5.0] 2024-11-08
9
26
 
10
27
  ### Added
@@ -469,12 +469,6 @@ declare type GetSimilarBimObjectsParams = {
469
469
  holderType: HolderType;
470
470
  };
471
471
 
472
- declare type GlobalOffset = {
473
- offsetX: number;
474
- offsetY: number;
475
- offsetZ: number;
476
- };
477
-
478
472
  declare type GPUMeshData = {
479
473
  index: number;
480
474
  f_byte_size: number;
@@ -507,7 +501,7 @@ declare class HiddenNodeServices {
507
501
  hasMeshnodeIndices: (indexes: Array<number>, resourceId: number) => boolean;
508
502
  private nodeNeedsUpdating;
509
503
  getVisibility: (resourceId: number, options?: {
510
- defaultVisibilityAlwaysTrue?: boolean | undefined;
504
+ defaultVisibilityAlwaysTrue?: boolean;
511
505
  }) => Visibility;
512
506
  setVisibility: (visibility: Visibility, resourceId: number) => void;
513
507
  private updateNodeAndChildren;
@@ -608,22 +602,26 @@ declare type Manifest_2 = {
608
602
  numMeshnodes: number;
609
603
  numMeshes: number;
610
604
  numNodes: number;
611
- globalOffset: GlobalOffset;
605
+ globalOffset: Vector3;
612
606
  numFaces: number;
613
607
  numVertices: number;
614
608
  isPartitioned: boolean;
615
609
  numPartitions: number;
616
610
  };
617
611
 
612
+ declare const MEASUREMENT_STATE: {
613
+ readonly initial: "initial";
614
+ readonly inProgress: "inProgress";
615
+ readonly completed: "completed";
616
+ };
617
+
618
618
  declare interface MeasurementInterface {
619
- setGlobalOffset(params: {
620
- offsetX: number;
621
- offsetY: number;
622
- offsetZ: number;
623
- }): void;
619
+ setGlobalOffset(params: Vector3): void;
624
620
  toggle(params: {
625
621
  enable: boolean;
626
622
  }): void;
623
+ getMeasurementProgress(): MeasurementState;
624
+ resetMeasurement(): void;
627
625
  }
628
626
 
629
627
  declare class MeasurementRenderer {
@@ -638,11 +636,7 @@ declare class MeasurementRenderer {
638
636
  settingsController: SettingsController;
639
637
  svgRenderer: SvgRenderer;
640
638
  });
641
- setGlobalOffset(params: {
642
- offsetX: number;
643
- offsetY: number;
644
- offsetZ: number;
645
- }): void;
639
+ setGlobalOffset(params: Vector3): void;
646
640
  getGlobalOffset(): THREE.Vector3;
647
641
  addMeasurement(params: {
648
642
  measurePoint1: Vector3;
@@ -666,6 +660,8 @@ declare class MeasurementRenderer {
666
660
  private updateSvgData;
667
661
  }
668
662
 
663
+ declare type MeasurementState = (typeof MEASUREMENT_STATE)[keyof typeof MEASUREMENT_STATE];
664
+
669
665
  declare class Mesh {
670
666
  private pwfMesh;
671
667
  constructor(pwfMesh: PWFMesh);
@@ -1081,11 +1077,7 @@ declare class Models {
1081
1077
  resourceId: number;
1082
1078
  meshRef: number;
1083
1079
  }): MeshObject;
1084
- globalOffset(resourceId: number): {
1085
- offsetX: number;
1086
- offsetY: number;
1087
- offsetZ: number;
1088
- };
1080
+ globalOffset(resourceId: number): Vector3;
1089
1081
  initGeometryFactory(params: {
1090
1082
  viewerRenderer: ViewerRenderer;
1091
1083
  }): void;
@@ -1766,24 +1758,21 @@ declare class PointToPointManager implements MeasurementInterface {
1766
1758
  measurementRenderer: MeasurementRenderer;
1767
1759
  locale: string;
1768
1760
  });
1769
- setGlobalOffset(params: {
1770
- offsetX: number;
1771
- offsetY: number;
1772
- offsetZ: number;
1773
- }): void;
1761
+ setGlobalOffset(params: Vector3): void;
1774
1762
  getGlobalOffset(): THREE.Vector3;
1763
+ getMeasurementProgress(): MeasurementState;
1775
1764
  private onCameraUpdated;
1776
1765
  private onNavigationChanged;
1777
1766
  private onMeasurementObjectMove;
1778
1767
  private updateTemporaryDistanceLabel;
1779
1768
  private onMeasurementObjectLeave;
1780
1769
  private onMeasurementObjectClick;
1781
- private resetMeasurement;
1770
+ resetMeasurement(): void;
1782
1771
  static isEnabled(): boolean;
1783
1772
  toggle(params: {
1784
1773
  enable: boolean;
1785
1774
  }): Promise<void>;
1786
- private createCursors;
1775
+ private clearDisplayElements;
1787
1776
  private removeCursors;
1788
1777
  private setCameraAndNavigationControls;
1789
1778
  private updateSvg;
@@ -1847,7 +1836,7 @@ declare class PubSubController {
1847
1836
  }
1848
1837
 
1849
1838
  declare namespace PubSubController {
1850
- const EVENTS: Readonly<{
1839
+ let EVENTS: Readonly<{
1851
1840
  animate: "animate";
1852
1841
  appResize: "appResize";
1853
1842
  appStart: "appStart";
@@ -1967,7 +1956,7 @@ declare interface PWF {
1967
1956
  getSubtreeNodeIds(nodeId: number): number[];
1968
1957
  getVirtualMeshnodeIndexesByNodeId(nodeId: number): number[];
1969
1958
  getNamedNode(nodeId: number): Node_4;
1970
- globalOffset(): GlobalOffset;
1959
+ globalOffset(): Vector3;
1971
1960
  getPwfPartitionContentUrls(): string[];
1972
1961
  numNodes(): number;
1973
1962
  numMeshnodes(): number;
@@ -2001,7 +1990,7 @@ declare class PWFCache {
2001
1990
  private abortController;
2002
1991
  private abortSignal;
2003
1992
  constructor();
2004
- fetchArrayBuffer(url: string, dataType?: 'arrayBuffer' | 'json'): Promise<ArrayBuffer>;
1993
+ fetchData(url: string, dataType?: 'arrayBuffer' | 'json'): Promise<ArrayBuffer>;
2005
1994
  fetchArrayBuffers(urls: string[]): Promise<ArrayBuffer[]>;
2006
1995
  dispose(): void;
2007
1996
  }
@@ -2062,11 +2051,7 @@ declare class PWFModelParser {
2062
2051
  private meshAB;
2063
2052
  private meshBufferReader?;
2064
2053
  constructor(nodeAB: ArrayBuffer, meshnodeAB: ArrayBuffer, meshAB: ArrayBuffer);
2065
- getGlobalOffset(): {
2066
- offsetX: number;
2067
- offsetY: number;
2068
- offsetZ: number;
2069
- };
2054
+ getGlobalOffset(): Vector3;
2070
2055
  getMeshnodeOffPointer(): number;
2071
2056
  parseNodes(): {
2072
2057
  nodes: PWFNode[];
@@ -2185,7 +2170,7 @@ declare class PWFProxy implements PWF {
2185
2170
  loadAllPartitionProxies(): void;
2186
2171
  prefetchPartitions(geometryFactory: StreamedGeometryFactory): BootstrapperResult;
2187
2172
  setGeometryFactory(geometryFactory: GeometryFactory): void;
2188
- globalOffset(): GlobalOffset;
2173
+ globalOffset(): Vector3;
2189
2174
  root(): Node_4;
2190
2175
  forEachNode(callback: (node: Node_4) => void): void;
2191
2176
  forEachMeshnode(callback: (meshnode: Meshnode) => void): void;
@@ -2265,7 +2250,7 @@ declare class PWFV1 implements PWF {
2265
2250
  loadAllPartitionProxies(): void;
2266
2251
  prefetchPartitions(geometryFactory: StreamedGeometryFactory): BootstrapperResult;
2267
2252
  setGeometryFactory(geometryFactory: GeometryFactory): void;
2268
- globalOffset(): GlobalOffset;
2253
+ globalOffset(): Vector3;
2269
2254
  root(): Node_2;
2270
2255
  forEachMeshnode(callback: (meshnode: Meshnode_2) => void): void;
2271
2256
  forEachNode(callback: (node: Node_2) => void): void;
@@ -2355,7 +2340,7 @@ declare class PWFV2 implements PWF {
2355
2340
  loadAllPartitionProxies(): void;
2356
2341
  prefetchPartitions(geometryFactory: StreamedGeometryFactory): BootstrapperResult;
2357
2342
  setGeometryFactory(geometryFactory: GeometryFactory): void;
2358
- globalOffset(): GlobalOffset;
2343
+ globalOffset(): Vector3;
2359
2344
  root(): Node_3;
2360
2345
  forEachMeshnode(callback: (meshnode: Meshnode_3) => void): void;
2361
2346
  forEachNode(callback: (node: Node_3) => void): void;
@@ -2429,11 +2414,7 @@ declare class RenderController {
2429
2414
  frameId: number | null;
2430
2415
  measureEnabled: boolean;
2431
2416
  canvasSelectionEnabled: boolean;
2432
- globalOffset: {
2433
- offsetX: number;
2434
- offsetY: number;
2435
- offsetZ: number;
2436
- } | null;
2417
+ globalOffset: Vector3 | null;
2437
2418
  clock: Clock;
2438
2419
  delta: number;
2439
2420
  webengine: InitOutput | null;
@@ -2572,11 +2553,7 @@ declare class RenderController {
2572
2553
  };
2573
2554
  };
2574
2555
  getModelItemBoundary(id: any): Box3;
2575
- getGlobalOffset(): {
2576
- offsetX: number;
2577
- offsetY: number;
2578
- offsetZ: number;
2579
- } | null;
2556
+ getGlobalOffset(): Vector3 | null;
2580
2557
  getMeshnodeFromNodeId(nodeId: any): Meshnode | null;
2581
2558
  getMeshnodeFromIndex(id: any): Meshnode | null;
2582
2559
  getMeasureObjectMeshes(): MeshnodeObject_3[];
@@ -2616,7 +2593,7 @@ declare class RenderController {
2616
2593
  hidden?: boolean | undefined;
2617
2594
  selected?: boolean | undefined;
2618
2595
  partiallySelected?: boolean | undefined;
2619
- parentId?: number | undefined;
2596
+ parentId?: number;
2620
2597
  }[];
2621
2598
  };
2622
2599
  onDoubleClick(evt: any): void;
@@ -2811,9 +2788,9 @@ declare class RenderController {
2811
2788
 
2812
2789
  declare namespace RenderController {
2813
2790
  namespace NullSelectedSubtree {
2814
- const objectId: number;
2815
- const selectionContainerId: number;
2816
- const ancestry: never[];
2791
+ let objectId: number;
2792
+ let selectionContainerId: number;
2793
+ let ancestry: never[];
2817
2794
  }
2818
2795
  function createCameras(options: any): {
2819
2796
  default: PerspectiveCamera;
@@ -2953,11 +2930,7 @@ declare class RenderControllerProxy {
2953
2930
  };
2954
2931
  };
2955
2932
  setCameraRotation(...params: any[]): void | Promise<any>;
2956
- getGlobalOffset(...params: any[]): Promise<any> | {
2957
- offsetX: number;
2958
- offsetY: number;
2959
- offsetZ: number;
2960
- } | null;
2933
+ getGlobalOffset(...params: any[]): Promise<any> | Vector3 | null;
2961
2934
  getMeshnodeFromNodeId(...params: any[]): Promise<any> | Meshnode | null;
2962
2935
  unhideNodeFromNodeIds(...params: any[]): boolean | Promise<any>;
2963
2936
  hideNodesFromNodeIds(...params: any[]): boolean | Promise<any>;
@@ -3125,11 +3098,11 @@ declare class RenderControllerProxy {
3125
3098
 
3126
3099
  declare namespace RenderControllerProxy {
3127
3100
  namespace NAVIGATION_MODE {
3128
- const NONE: number;
3129
- const GENERAL: number;
3130
- const WALK: number;
3131
- const ORBIT: number;
3132
- const MEASURE: number;
3101
+ let NONE: number;
3102
+ let GENERAL: number;
3103
+ let WALK: number;
3104
+ let ORBIT: number;
3105
+ let MEASURE: number;
3133
3106
  }
3134
3107
  }
3135
3108
 
@@ -3644,6 +3617,8 @@ export declare const TOOL_BAR_TOOLS: {
3644
3617
  export declare type ToolBarTools = (typeof TOOL_BAR_TOOLS)[keyof typeof TOOL_BAR_TOOLS];
3645
3618
 
3646
3619
  export declare const UOM: {
3620
+ readonly rad: "rad";
3621
+ readonly deg: "°";
3647
3622
  readonly cdsqm: "cd/m²";
3648
3623
  readonly cuum: "um³";
3649
3624
  readonly cumm: "mm³";
@@ -3950,11 +3925,7 @@ export declare class Webviewer {
3950
3925
  dir_x?: number;
3951
3926
  dir_y?: number;
3952
3927
  }>;
3953
- getGlobalOffset: () => Promise<{
3954
- offsetX: number;
3955
- offsetY: number;
3956
- offsetZ: number;
3957
- } | null>;
3928
+ getGlobalOffsetDoNotUse: () => Promise<Vector3 | null>;
3958
3929
  setXRayMode: () => void;
3959
3930
  setNormalMode: () => void;
3960
3931
  setRenderMode: (mode: RenderMode) => void;