@procore/bim-webviewer-sdk 16.3.0 → 16.4.0-rc.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 (31) hide show
  1. package/CHANGELOG.md +18 -0
  2. package/dist/Procore.Bim.Webviewer.d.ts +40 -20
  3. package/dist/Procore.Bim.Webviewer.js +1 -1
  4. package/dist/types/src/Webviewer.d.ts +2 -1
  5. package/dist/types/src/components/RootComponent.d.ts +3 -4
  6. package/dist/types/src/components/ShortestDistanceComponent.d.ts +4 -12
  7. package/dist/types/src/components/ToolBarComponent/ToolBarComponent.d.ts +5 -2
  8. package/dist/types/src/components/ToolBarComponent/ToolbarButton/SplitButton.d.ts +25 -0
  9. package/dist/types/src/components/ToolBarComponent/ToolbarButton/__tests__/SplitButton.test.d.ts +1 -0
  10. package/dist/types/src/components/WindowViewPropertiesComponent/WindowViewPropertiesComponent.d.ts +4 -0
  11. package/dist/types/src/controllers/PubSubController.d.ts +1 -0
  12. package/dist/types/src/measuring/CursorTooltip/CursorToolip.d.ts +15 -0
  13. package/dist/types/src/measuring/CursorTooltip/__tests__/CursorToolip.test.d.ts +1 -0
  14. package/dist/types/src/measuring/CursorTooltip/index.d.ts +1 -0
  15. package/dist/types/src/measuring/DistanceLabel.d.ts +1 -0
  16. package/dist/types/src/measuring/FeatureTooltip/FeatureTooltip.d.ts +20 -0
  17. package/dist/types/src/measuring/FeatureTooltip/__tests__/FeatureTooltip.test.d.ts +1 -0
  18. package/dist/types/src/measuring/FeatureTooltip/index.d.ts +1 -0
  19. package/dist/types/src/measuring/MeasureToolUtils.d.ts +1 -1
  20. package/dist/types/src/measuring/MeasurementInterface.d.ts +10 -0
  21. package/dist/types/src/measuring/MeasurementManager.d.ts +28 -0
  22. package/dist/types/src/measuring/MeasurementRenderer.d.ts +1 -0
  23. package/dist/types/src/measuring/PointToPointController.d.ts +7 -7
  24. package/dist/types/src/measuring/PointToPointManager.d.ts +22 -15
  25. package/dist/types/src/measuring/__tests__/MeasurementManager.test.d.ts +1 -0
  26. package/dist/types/src/measuring/__tests__/PointToPointFixtures.d.ts +1 -1
  27. package/dist/types/src/measuring/__tests__/fixtures.d.ts +34 -0
  28. package/dist/types/src/measuring/index.d.ts +1 -0
  29. package/dist/types/src/validateOptions/index.d.ts +1 -1
  30. package/dist/types/src/validateOptions/validateOptions.d.ts +1 -0
  31. package/package.json +2 -2
package/CHANGELOG.md CHANGED
@@ -5,6 +5,24 @@ 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
+ ## [16.4.0] 2024-10-25
9
+
10
+ ### Added
11
+
12
+ - ([#1355](https://github.com/procore/bim-webviewer/pull/1355)) Measurement-related object properties are now automatically updated when the display units change (e.g. changed through settings), no need to reselect an object for it to update. Only applies for properties that have a typed-value.
13
+ - ([#1346](https://github.com/procore/bim-webviewer/pull/1346)) Point To Point now displays two tooltips, One that follows the mouse cursor and one that displays the name of a snap feature.
14
+ - ([#1363](https://github.com/procore/bim-webviewer/pull/1363)) When Point to Point is enabled, the bottom toolbar will now display a split button that allows the user to switch between different measurement modes for the Measure Tool.
15
+ - ([#1362](https://github.com/procore/bim-webviewer/pull/1362)) Point To Point distance labels now dynamically disappear or appear when they are positioned behind or in front of the camera, respectively.
16
+
17
+ ### Removed
18
+
19
+ - ([#1358](https://github.com/procore/bim-webviewer/pull/1358)) [Internal][QA Ignore] Removed `cypress_tests` from circle ci workflow and removed from sonarqube analysis.
20
+
21
+ ### Changed
22
+
23
+ - ([#1360](https://github.com/procore/bim-webviewer/pull/1360)) [Internal][QA Ignore] Lint circleci config: Update orb versions and remove deprecated workflows.version field
24
+ - ([#1361](https://github.com/procore/bim-webviewer/pull/1361)) [Internal][QA Ignore] Publish packages to npm in circle ci
25
+
8
26
  ## [16.3.0] 2024-10-11
9
27
 
10
28
  ### Added
@@ -480,6 +480,17 @@ declare type Manifest = {
480
480
  globalOffset: Vector3;
481
481
  };
482
482
 
483
+ declare interface MeasurementInterface {
484
+ setGlobalOffset(params: {
485
+ offsetX: number;
486
+ offsetY: number;
487
+ offsetZ: number;
488
+ }): void;
489
+ toggle(params: {
490
+ enable: boolean;
491
+ }): void;
492
+ }
493
+
483
494
  declare class MeasurementRenderer {
484
495
  element: HTMLElement;
485
496
  private measurements;
@@ -511,6 +522,7 @@ declare class MeasurementRenderer {
511
522
  private onResize;
512
523
  private onCameraUpdated;
513
524
  private updateDistanceLabelPosition;
525
+ private isDistanceLabelHidden;
514
526
  private areRectsOverlapping;
515
527
  private isOverlapping;
516
528
  private stackElementsVerticallyToFirst;
@@ -1338,17 +1350,17 @@ declare type Point = {
1338
1350
  };
1339
1351
 
1340
1352
  declare class PointToPointController {
1341
- private pickingController;
1342
- private models;
1353
+ private readonly pickingController;
1354
+ private readonly models;
1343
1355
  private readonly camera;
1344
1356
  private currentHoverMeshnodeIndex;
1345
- private meshTopologyCache;
1357
+ private readonly meshTopologyCache;
1346
1358
  private _enabled;
1347
1359
  private readonly globalOffset;
1348
1360
  private prevLastWorldIntersectionSnapResult;
1349
1361
  private lastWorldIntersectionSnapResult;
1350
- private debugGui;
1351
- private viewerRenderer;
1362
+ private readonly debugGui;
1363
+ private readonly viewerRenderer;
1352
1364
  constructor(params: {
1353
1365
  pickingController: PickingController;
1354
1366
  models: Models;
@@ -1367,34 +1379,38 @@ declare class PointToPointController {
1367
1379
  private determineHoverState;
1368
1380
  }
1369
1381
 
1370
- declare class PointToPointManager {
1371
- private svgRenderer;
1372
- private renderControllerProxy;
1373
- private settingsController;
1374
- private measurementRenderer;
1382
+ declare class PointToPointManager implements MeasurementInterface {
1383
+ private readonly svgRenderer;
1384
+ private readonly renderControllerProxy;
1385
+ private readonly settingsController;
1386
+ private readonly measurementRenderer;
1375
1387
  private firstMeasurePoint;
1376
1388
  private secondMeasurePoint;
1377
1389
  private snapPosition;
1378
1390
  private static pointToPointEnabled;
1379
1391
  private outlines;
1380
1392
  private pivot;
1381
- private gui;
1393
+ private readonly gui;
1382
1394
  private globalOffset;
1383
1395
  private temporaryDistanceLabel;
1384
1396
  private camera;
1397
+ private readonly locale;
1398
+ private cursorTooltip;
1399
+ private featureTooltip;
1385
1400
  constructor(params: {
1386
1401
  renderControllerProxy: RenderControllerProxy;
1387
1402
  settingsController: SettingsController;
1388
1403
  svgRenderer: SvgRenderer;
1389
- globalOffset: {
1390
- offsetX: number;
1391
- offsetY: number;
1392
- offsetZ: number;
1393
- };
1394
1404
  measurementRenderer: MeasurementRenderer;
1405
+ locale: string;
1395
1406
  });
1407
+ setGlobalOffset(params: {
1408
+ offsetX: number;
1409
+ offsetY: number;
1410
+ offsetZ: number;
1411
+ }): void;
1412
+ getGlobalOffset(): THREE.Vector3;
1396
1413
  private onCameraUpdated;
1397
- private onSelectTool;
1398
1414
  private onNavigationChanged;
1399
1415
  private onMeasurementObjectMove;
1400
1416
  private updateTemporaryDistanceLabel;
@@ -1402,9 +1418,11 @@ declare class PointToPointManager {
1402
1418
  private onMeasurementObjectClick;
1403
1419
  private resetMeasurement;
1404
1420
  static isEnabled(): boolean;
1405
- togglePointToPoint(params: {
1421
+ toggle(params: {
1406
1422
  enable: boolean;
1407
- }): void;
1423
+ }): Promise<void>;
1424
+ private createCursors;
1425
+ private removeCursors;
1408
1426
  private setCameraAndNavigationControls;
1409
1427
  private updateSvg;
1410
1428
  }
@@ -1546,6 +1564,7 @@ declare namespace PubSubController {
1546
1564
  sectionBoxDisplayHoverUpdated: "sectionBoxDisplayHoverUpdated";
1547
1565
  sectionBoxDisplayResized: "sectionBoxDisplayResized";
1548
1566
  sectionBoxDisplayToggled: "sectionBoxDisplayToggled";
1567
+ measurementToggled: "measurementToggled";
1549
1568
  sectionBoxRemoved: "sectionBoxRemoved";
1550
1569
  sectionBoxSet: "sectionBoxSet";
1551
1570
  sectionPlaneAdded: "sectionPlaneAdded";
@@ -3174,7 +3193,8 @@ export declare type WebFormatExtractionItem = {
3174
3193
  export declare class Webviewer {
3175
3194
  options: Options;
3176
3195
  pointToPointManager: PointToPointManager;
3177
- private measurementRenderer;
3196
+ private readonly measurementRenderer;
3197
+ private readonly measurementManager;
3178
3198
  static readonly tools: {
3179
3199
  readonly ALL: 0;
3180
3200
  readonly BOTTOMTOOL: 1;