@procore/bim-webviewer-sdk 16.5.0-BM-919-add-storage-analytics.2 → 16.5.0-BM-910.rc.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.
package/CHANGELOG.md CHANGED
@@ -9,11 +9,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
9
9
 
10
10
  ### Added
11
11
 
12
- - ([#1393](https://github.com/procore/bim-webviewer/pull/1393)) [Internal][QA Ignore] Add `project.3d_models.client_loading.query_environment` analytics event that gathers information from `navigator.userAgent` and `navigator.storage` before bootstrapping.
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
+ - ([#1389](https://github.com/procore/bim-webviewer/pull/1389)) [Internal][QA Ignore] Fetching the model by only using model revision id in SDK side.
13
15
 
14
16
  ### Changed
15
17
 
18
+ - ([#866](https://github.com/procore/bim-webviewer/pull/1377)) [Internal][QA Ignore]Change fetchArray buffer to fetchData and add README file in pwfreader
16
19
  - ([#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.
20
+ - ([#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.
21
+ - ([#1379](https://github.com/procore/bim-webviewer/pull/1379)) Fix the point to point crosshair size to 40px and align in the center.
17
22
 
18
23
  ## [16.5.0] 2024-11-08
19
24
 
@@ -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;
@@ -608,7 +602,7 @@ 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;
@@ -616,11 +610,7 @@ declare type Manifest_2 = {
616
610
  };
617
611
 
618
612
  declare interface MeasurementInterface {
619
- setGlobalOffset(params: {
620
- offsetX: number;
621
- offsetY: number;
622
- offsetZ: number;
623
- }): void;
613
+ setGlobalOffset(params: Vector3): void;
624
614
  toggle(params: {
625
615
  enable: boolean;
626
616
  }): void;
@@ -638,11 +628,7 @@ declare class MeasurementRenderer {
638
628
  settingsController: SettingsController;
639
629
  svgRenderer: SvgRenderer;
640
630
  });
641
- setGlobalOffset(params: {
642
- offsetX: number;
643
- offsetY: number;
644
- offsetZ: number;
645
- }): void;
631
+ setGlobalOffset(params: Vector3): void;
646
632
  getGlobalOffset(): THREE.Vector3;
647
633
  addMeasurement(params: {
648
634
  measurePoint1: Vector3;
@@ -989,6 +975,19 @@ export declare type ModelRevision = {
989
975
  id: number;
990
976
  revision: number;
991
977
  viewpoints: ModelRevisionViewpoint[];
978
+ geometry_file_bundle: ModelRevisionGeometryBundle;
979
+ };
980
+
981
+ declare type ModelRevisionGeometryBundle = {
982
+ manifest_file: GeometryFile;
983
+ mesh_file: GeometryFile;
984
+ mesh_node_file: GeometryFile;
985
+ node_file: GeometryFile;
986
+ };
987
+
988
+ declare type ModelRevisionModeOptions = CommonOptions & {
989
+ modelId: Model['id'];
990
+ modelRevisionId: ModelRevision['id'];
992
991
  };
993
992
 
994
993
  export declare type ModelRevisionModePwfV1Options = CommonOptions & PwfV1Bundle & {
@@ -1011,6 +1010,11 @@ export declare type ModelRevisionModePwfV2Resource = PwfV2Bundle & {
1011
1010
  modelRevisionId: ModelRevision['id'];
1012
1011
  };
1013
1012
 
1013
+ declare type ModelRevisionModeResource = {
1014
+ modelId: Model['id'];
1015
+ modelRevisionId: ModelRevision['id'];
1016
+ };
1017
+
1014
1018
  declare namespace ModelRevisions {
1015
1019
  export {
1016
1020
  GetBimObjectsFor,
@@ -1081,11 +1085,7 @@ declare class Models {
1081
1085
  resourceId: number;
1082
1086
  meshRef: number;
1083
1087
  }): MeshObject;
1084
- globalOffset(resourceId: number): {
1085
- offsetX: number;
1086
- offsetY: number;
1087
- offsetZ: number;
1088
- };
1088
+ globalOffset(resourceId: number): Vector3;
1089
1089
  initGeometryFactory(params: {
1090
1090
  viewerRenderer: ViewerRenderer;
1091
1091
  }): void;
@@ -1472,7 +1472,7 @@ declare class ObjectTree {
1472
1472
  private synchronizeHiddenNodes;
1473
1473
  }
1474
1474
 
1475
- export declare type Options = FileExtractionModePwfV2OverrideOptions | FileExtractionModePwfV1OverrideOptions | FileExtractionModeOptions | ModelRevisionModePwfV2Options | ModelRevisionModePwfV1Options | ResourceOptions;
1475
+ export declare type Options = FileExtractionModePwfV2OverrideOptions | FileExtractionModePwfV1OverrideOptions | FileExtractionModeOptions | ModelRevisionModePwfV2Options | ModelRevisionModePwfV1Options | ModelRevisionModeOptions | ResourceOptions;
1476
1476
 
1477
1477
  declare type OrientedBox = {
1478
1478
  min: Vector3;
@@ -1766,11 +1766,7 @@ declare class PointToPointManager implements MeasurementInterface {
1766
1766
  measurementRenderer: MeasurementRenderer;
1767
1767
  locale: string;
1768
1768
  });
1769
- setGlobalOffset(params: {
1770
- offsetX: number;
1771
- offsetY: number;
1772
- offsetZ: number;
1773
- }): void;
1769
+ setGlobalOffset(params: Vector3): void;
1774
1770
  getGlobalOffset(): THREE.Vector3;
1775
1771
  private onCameraUpdated;
1776
1772
  private onNavigationChanged;
@@ -1967,7 +1963,7 @@ declare interface PWF {
1967
1963
  getSubtreeNodeIds(nodeId: number): number[];
1968
1964
  getVirtualMeshnodeIndexesByNodeId(nodeId: number): number[];
1969
1965
  getNamedNode(nodeId: number): Node_4;
1970
- globalOffset(): GlobalOffset;
1966
+ globalOffset(): Vector3;
1971
1967
  getPwfPartitionContentUrls(): string[];
1972
1968
  numNodes(): number;
1973
1969
  numMeshnodes(): number;
@@ -2001,7 +1997,7 @@ declare class PWFCache {
2001
1997
  private abortController;
2002
1998
  private abortSignal;
2003
1999
  constructor();
2004
- fetchArrayBuffer(url: string, dataType?: 'arrayBuffer' | 'json'): Promise<ArrayBuffer>;
2000
+ fetchData(url: string, dataType?: 'arrayBuffer' | 'json'): Promise<ArrayBuffer>;
2005
2001
  fetchArrayBuffers(urls: string[]): Promise<ArrayBuffer[]>;
2006
2002
  dispose(): void;
2007
2003
  }
@@ -2062,11 +2058,7 @@ declare class PWFModelParser {
2062
2058
  private meshAB;
2063
2059
  private meshBufferReader?;
2064
2060
  constructor(nodeAB: ArrayBuffer, meshnodeAB: ArrayBuffer, meshAB: ArrayBuffer);
2065
- getGlobalOffset(): {
2066
- offsetX: number;
2067
- offsetY: number;
2068
- offsetZ: number;
2069
- };
2061
+ getGlobalOffset(): Vector3;
2070
2062
  getMeshnodeOffPointer(): number;
2071
2063
  parseNodes(): {
2072
2064
  nodes: PWFNode[];
@@ -2185,7 +2177,7 @@ declare class PWFProxy implements PWF {
2185
2177
  loadAllPartitionProxies(): void;
2186
2178
  prefetchPartitions(geometryFactory: StreamedGeometryFactory): BootstrapperResult;
2187
2179
  setGeometryFactory(geometryFactory: GeometryFactory): void;
2188
- globalOffset(): GlobalOffset;
2180
+ globalOffset(): Vector3;
2189
2181
  root(): Node_4;
2190
2182
  forEachNode(callback: (node: Node_4) => void): void;
2191
2183
  forEachMeshnode(callback: (meshnode: Meshnode) => void): void;
@@ -2265,7 +2257,7 @@ declare class PWFV1 implements PWF {
2265
2257
  loadAllPartitionProxies(): void;
2266
2258
  prefetchPartitions(geometryFactory: StreamedGeometryFactory): BootstrapperResult;
2267
2259
  setGeometryFactory(geometryFactory: GeometryFactory): void;
2268
- globalOffset(): GlobalOffset;
2260
+ globalOffset(): Vector3;
2269
2261
  root(): Node_2;
2270
2262
  forEachMeshnode(callback: (meshnode: Meshnode_2) => void): void;
2271
2263
  forEachNode(callback: (node: Node_2) => void): void;
@@ -2355,7 +2347,7 @@ declare class PWFV2 implements PWF {
2355
2347
  loadAllPartitionProxies(): void;
2356
2348
  prefetchPartitions(geometryFactory: StreamedGeometryFactory): BootstrapperResult;
2357
2349
  setGeometryFactory(geometryFactory: GeometryFactory): void;
2358
- globalOffset(): GlobalOffset;
2350
+ globalOffset(): Vector3;
2359
2351
  root(): Node_3;
2360
2352
  forEachMeshnode(callback: (meshnode: Meshnode_3) => void): void;
2361
2353
  forEachNode(callback: (node: Node_3) => void): void;
@@ -2429,11 +2421,7 @@ declare class RenderController {
2429
2421
  frameId: number | null;
2430
2422
  measureEnabled: boolean;
2431
2423
  canvasSelectionEnabled: boolean;
2432
- globalOffset: {
2433
- offsetX: number;
2434
- offsetY: number;
2435
- offsetZ: number;
2436
- } | null;
2424
+ globalOffset: Vector3 | null;
2437
2425
  clock: Clock;
2438
2426
  delta: number;
2439
2427
  webengine: InitOutput | null;
@@ -2572,11 +2560,7 @@ declare class RenderController {
2572
2560
  };
2573
2561
  };
2574
2562
  getModelItemBoundary(id: any): Box3;
2575
- getGlobalOffset(): {
2576
- offsetX: number;
2577
- offsetY: number;
2578
- offsetZ: number;
2579
- } | null;
2563
+ getGlobalOffset(): Vector3 | null;
2580
2564
  getMeshnodeFromNodeId(nodeId: any): Meshnode | null;
2581
2565
  getMeshnodeFromIndex(id: any): Meshnode | null;
2582
2566
  getMeasureObjectMeshes(): MeshnodeObject_3[];
@@ -2953,11 +2937,7 @@ declare class RenderControllerProxy {
2953
2937
  };
2954
2938
  };
2955
2939
  setCameraRotation(...params: any[]): void | Promise<any>;
2956
- getGlobalOffset(...params: any[]): Promise<any> | {
2957
- offsetX: number;
2958
- offsetY: number;
2959
- offsetZ: number;
2960
- } | null;
2940
+ getGlobalOffset(...params: any[]): Promise<any> | Vector3 | null;
2961
2941
  getMeshnodeFromNodeId(...params: any[]): Promise<any> | Meshnode | null;
2962
2942
  unhideNodeFromNodeIds(...params: any[]): boolean | Promise<any>;
2963
2943
  hideNodesFromNodeIds(...params: any[]): boolean | Promise<any>;
@@ -3261,7 +3241,7 @@ declare class RenderControllerWorker {
3261
3241
 
3262
3242
  export declare type RenderMode = (typeof RENDER_MODE)[keyof typeof RENDER_MODE];
3263
3243
 
3264
- export declare type Resource = FileExtractionModePwfV1OverrideResource | FileExtractionModePwfV2OverrideResource | FileExtractionModeResource | ModelRevisionModePwfV1Resource | ModelRevisionModePwfV2Resource;
3244
+ export declare type Resource = FileExtractionModePwfV1OverrideResource | FileExtractionModePwfV2OverrideResource | FileExtractionModeResource | ModelRevisionModePwfV1Resource | ModelRevisionModePwfV2Resource | ModelRevisionModeResource;
3265
3245
 
3266
3246
  declare type ResourceDiscriminator = {
3267
3247
  fileExtractionId: number;
@@ -3644,6 +3624,8 @@ export declare const TOOL_BAR_TOOLS: {
3644
3624
  export declare type ToolBarTools = (typeof TOOL_BAR_TOOLS)[keyof typeof TOOL_BAR_TOOLS];
3645
3625
 
3646
3626
  export declare const UOM: {
3627
+ readonly rad: "rad";
3628
+ readonly deg: "°";
3647
3629
  readonly cdsqm: "cd/m²";
3648
3630
  readonly cuum: "um³";
3649
3631
  readonly cumm: "mm³";
@@ -3950,11 +3932,7 @@ export declare class Webviewer {
3950
3932
  dir_x?: number;
3951
3933
  dir_y?: number;
3952
3934
  }>;
3953
- getGlobalOffset: () => Promise<{
3954
- offsetX: number;
3955
- offsetY: number;
3956
- offsetZ: number;
3957
- } | null>;
3935
+ getGlobalOffsetDoNotUse: () => Promise<Vector3 | null>;
3958
3936
  setXRayMode: () => void;
3959
3937
  setNormalMode: () => void;
3960
3938
  setRenderMode: (mode: RenderMode) => void;