@procore/bim-webviewer-sdk 17.6.0-rc.1 → 17.6.0-rc.11

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 (58) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/dist/Procore.Bim.Webviewer.d.ts +52 -31
  3. package/dist/Procore.Bim.Webviewer.js +1 -1
  4. package/dist/types/src/api/analytic_events/payloadFactories.d.ts +3 -1
  5. package/dist/types/src/components/LoadingComponent/LoadingComponent.d.ts +8 -6
  6. package/dist/types/src/components/RootComponent.d.ts +1 -1
  7. package/dist/types/src/components/StatsJS.d.ts +8 -3
  8. package/dist/types/src/controllers/Bootstrapper.d.ts +18 -9
  9. package/dist/types/src/controllers/PubSubController.d.ts +2 -1
  10. package/dist/types/src/controllers/RenderController.d.ts +3 -2
  11. package/dist/types/src/controllers/RenderControllerProxy.d.ts +2 -2
  12. package/dist/types/src/controllers/RenderControllerWorker.d.ts +1 -0
  13. package/dist/types/src/controllers/RendererFactory.d.ts +2 -1
  14. package/dist/types/src/procoregl/Models/Models.d.ts +2 -2
  15. package/dist/types/src/procoregl/PartitionsRenderer.d.ts +3 -0
  16. package/dist/types/src/procoregl/PartitionsRendererImpl.d.ts +4 -0
  17. package/dist/types/src/procoregl/StreamedGeometryFactory.d.ts +0 -1
  18. package/dist/types/src/procoregl/ViewerRenderer.d.ts +2 -0
  19. package/dist/types/src/pwfreader/PWF.d.ts +3 -2
  20. package/dist/types/src/pwfreader/PWFProxy.d.ts +3 -2
  21. package/dist/types/src/pwfreader/Utils.d.ts +6 -2
  22. package/dist/types/src/pwfreader/v1/PWFV1.d.ts +3 -1
  23. package/dist/types/src/pwfreader/v1/impl/bufferReader/HPartitionProxyBufferReader.d.ts +8 -0
  24. package/dist/types/src/pwfreader/v1/impl/bufferReader/PartitionProxyBufferReader.d.ts +1 -3
  25. package/dist/types/src/pwfreader/v1/impl/bufferReader/__tests__/HPartitionProxyBufferReader.test.d.ts +1 -0
  26. package/dist/types/src/pwfreader/v1/impl/pwfNoCache/PWFHPartitionProxyNoCache.d.ts +14 -0
  27. package/dist/types/src/pwfreader/v1/impl/recordReader/PWFHPartitionProxyReader.d.ts +19 -0
  28. package/dist/types/src/pwfreader/v1/interface/PWFHPartitionProxy.d.ts +7 -0
  29. package/dist/types/src/pwfreader/v1/standard/MeshServices.d.ts +1 -0
  30. package/dist/types/src/pwfreader/v1/standard/Meshnode.d.ts +7 -1
  31. package/dist/types/src/pwfreader/v1/standard/MeshnodeServices.d.ts +3 -1
  32. package/dist/types/src/pwfreader/v1/streaming/HPartitionProxy.d.ts +20 -0
  33. package/dist/types/src/pwfreader/v1/streaming/MeshData.d.ts +2 -3
  34. package/dist/types/src/pwfreader/v1/streaming/Partition.d.ts +1 -1
  35. package/dist/types/src/pwfreader/v1/streaming/PartitionDownloadManager.d.ts +7 -0
  36. package/dist/types/src/pwfreader/v1/streaming/PartitionProxy.d.ts +13 -7
  37. package/dist/types/src/pwfreader/v1/streaming/StreamedMeshServices.d.ts +3 -2
  38. package/dist/types/src/pwfreader/v1/streaming/StreamedMeshnode.d.ts +10 -2
  39. package/dist/types/src/pwfreader/v1/streaming/StreamedMeshnodeServices.d.ts +1 -1
  40. package/dist/types/src/pwfreader/v1/streaming/__tests__/HPartitionProxy.test.d.ts +1 -0
  41. package/dist/types/src/pwfreader/v1/streaming/__tests__/PartitionDownloadManager.test.d.ts +1 -0
  42. package/dist/types/src/pwfreader/v2/PWFV2.d.ts +2 -1
  43. package/dist/types/src/pwfreader/v2/impl/bufferReader/PartitionProxyBufferReader.d.ts +0 -3
  44. package/dist/types/src/pwfreader/v2/standard/Meshnode.d.ts +1 -0
  45. package/dist/types/src/pwfreader/v2/streaming/MeshData.d.ts +2 -3
  46. package/dist/types/src/pwfreader/v2/streaming/Partition.d.ts +1 -1
  47. package/dist/types/src/pwfreader/v2/streaming/PartitionProxy.d.ts +1 -3
  48. package/dist/types/src/pwfreader/v2/streaming/StreamedMeshServices.d.ts +1 -2
  49. package/dist/types/src/pwfreader/v2/streaming/StreamedMeshnode.d.ts +1 -3
  50. package/dist/types/src/threeShaking.d.ts +2 -0
  51. package/dist/types/src/types/WebviewerOptions.d.ts +1 -0
  52. package/dist/types/src/utils/constants.d.ts +1 -0
  53. package/dist/types/src/utils/requestPersistentStorage/__tests__/requestPersistentStorage.test.d.ts +1 -0
  54. package/dist/types/src/utils/requestPersistentStorage/index.d.ts +1 -0
  55. package/dist/types/src/utils/requestPersistentStorage/requestPersistentStorage.d.ts +1 -0
  56. package/dist/types/src/workers/PartitionDownload.worker.d.ts +1 -0
  57. package/package.json +1 -1
  58. package/dist/types/src/procoregl/SceneGraph/utils.d.ts +0 -2
@@ -3,12 +3,20 @@ import { Meshnode } from '../standard/Meshnode';
3
3
  import { MeshnodeObject } from '../objects/MeshnodeObject';
4
4
  import { PartitionProxy } from './PartitionProxy';
5
5
  import { StreamedMeshGeometry } from '../../../procoregl/StreamedMeshGeometry';
6
+ import { PWFMeshnode } from '../interface/PWFMeshnode';
7
+ import type { PWFV1 } from '../PWFV1';
6
8
  export declare class StreamedMeshnode extends Meshnode {
7
- private _partitionProxy?;
8
- private _meshGeometries;
9
+ _partitionProxy?: PartitionProxy;
10
+ _meshGeometries: Map<number, StreamedMeshGeometry>;
11
+ protected meshGeometriesValue: MeshGeometry[];
12
+ uploadedToGPU: boolean;
13
+ prefetching: boolean;
14
+ constructor(pwfMeshnode: PWFMeshnode, pwf: PWFV1, prefetching: boolean);
15
+ isPrefetching(): boolean;
9
16
  setPartitionProxy(partitionProxy: PartitionProxy): void;
10
17
  partitionProxy(): PartitionProxy;
11
18
  meshGeometries(): MeshGeometry[];
19
+ uploadMeshDataToGPU(): Promise<void>;
12
20
  setMeshGeometry(meshIndex: number, meshGeometry: StreamedMeshGeometry): void;
13
21
  getMeshGeometry(meshIndex: number): StreamedMeshGeometry | undefined;
14
22
  asObject(): MeshnodeObject;
@@ -1,4 +1,4 @@
1
- import { MeshnodeServices } from '../standard/MeshnodeServices';
1
+ import { MeshnodeServices } from '../standard';
2
2
  import { Meshnode } from '../standard/Meshnode';
3
3
  import { PWFMeshnode } from '../interface/PWFMeshnode';
4
4
  export declare class StreamedMeshnodeServices extends MeshnodeServices {
@@ -65,7 +65,8 @@ export declare class PWFV2 implements PWF {
65
65
  });
66
66
  setStandardModelBuffers(nodeAB: ArrayBuffer, meshnodeAB: ArrayBuffer, meshAB: ArrayBuffer): void;
67
67
  setPartitionedModelBuffers(nodeAB: ArrayBuffer, meshnodeAB: ArrayBuffer, partitionProxiesAB: ArrayBuffer): void;
68
- getPwfPartitionContentUrls(): string[];
68
+ setHPartitionedModelBuffers(_nodeAB: ArrayBuffer, _meshnodeAB: ArrayBuffer, _partitionProxiesAB: ArrayBuffer): void;
69
+ getPwfPartitionContentUrls(): Promise<string[]>;
69
70
  initPwfParser(): void;
70
71
  parsePwfNodes(): BootstrapperResult;
71
72
  parsePwfMeshnodes(): BootstrapperResult;
@@ -1,10 +1,7 @@
1
1
  import { PWFPartitionProxy } from '../../interface/PWFPartitionProxy';
2
2
  export declare class PartitionProxyBufferReader {
3
3
  private buffer;
4
- private numPartitionProxies;
5
4
  constructor(buffer: ArrayBuffer);
6
- getNumPartitionProxies(): number;
7
5
  parse(): PWFPartitionProxy[];
8
6
  private forEach;
9
- static numProxies(partitionProxiesAB: ArrayBuffer): number;
10
7
  }
@@ -4,6 +4,7 @@ import { PWFMeshnode } from '../interface/PWFMeshnode';
4
4
  import type { PWFV2 } from '../PWFV2';
5
5
  import { MeshnodeObject } from '../objects/MeshnodeObject';
6
6
  export declare class Meshnode {
7
+ uploadedToGPU: boolean;
7
8
  protected pwfMeshnode: PWFMeshnode;
8
9
  private hiddenValue;
9
10
  private box3Value?;
@@ -1,8 +1,8 @@
1
1
  import { StreamedMeshGeometry } from '../../../procoregl/StreamedMeshGeometry';
2
2
  import { StreamedGeometryFactory } from '../../../procoregl/StreamedGeometryFactory';
3
3
  export declare class MeshData {
4
- private _meshIndex;
5
- private compressedMeshData;
4
+ private readonly _meshIndex;
5
+ private readonly compressedMeshData;
6
6
  private uncompressedMeshData?;
7
7
  private meshGeometry?;
8
8
  constructor(meshIndex: number, compressedMeshData: ArrayBuffer);
@@ -13,7 +13,6 @@ export declare class MeshData {
13
13
  vertices(): Float32Array;
14
14
  faces(): Uint16Array;
15
15
  uploadToGPU(geometryFactory: StreamedGeometryFactory): StreamedMeshGeometry;
16
- uploadToGPUPreFetching(geometryFactory: StreamedGeometryFactory): StreamedMeshGeometry;
17
16
  getCompressedMeshData(): ArrayBuffer;
18
17
  getUncompressedMeshData(): ArrayBuffer;
19
18
  }
@@ -4,5 +4,5 @@ export declare class Partition {
4
4
  private pwfPartition;
5
5
  constructor(pwfPartition: PWFPartition);
6
6
  partitionId(): number;
7
- meshData(): MeshData[];
7
+ meshDatum(): MeshData[];
8
8
  }
@@ -5,11 +5,9 @@ import { StreamedGeometryFactory } from '../../../procoregl/StreamedGeometryFact
5
5
  import { StreamedMeshServices } from './StreamedMeshServices';
6
6
  export declare class PartitionProxy {
7
7
  private pwfPartitionProxy;
8
- private meshServices;
9
8
  static numberOfPartitions: number;
10
9
  static numberOfPartitionsLoaded: number;
11
10
  static currentNumberOfDownloading: number;
12
- static prefetchingPartitions: boolean;
13
11
  loadedToGPU: boolean;
14
12
  isLoading: boolean;
15
13
  private _meshnodes;
@@ -32,7 +30,7 @@ export declare class PartitionProxy {
32
30
  meshnodes(): StreamedMeshnode[];
33
31
  setMeshnodes(meshnodes: StreamedMeshnode[]): void;
34
32
  loadPartitionData(callbackFn: (partition: Partition) => void): Promise<void>;
35
- loadPartition(factory: StreamedGeometryFactory): Promise<void>;
33
+ loadPartition(_factory: StreamedGeometryFactory): Promise<void>;
36
34
  size(): {
37
35
  compressed: number;
38
36
  size: number;
@@ -1,7 +1,6 @@
1
1
  import { StreamedMeshGeometry } from '../../../procoregl/StreamedMeshGeometry';
2
2
  import type { PWFV2 } from '../PWFV2';
3
3
  import { MeshServices } from '../standard';
4
- import type { StreamedMeshnode } from './StreamedMeshnode';
5
4
  import { MeshObject } from '../objects/MeshObject';
6
5
  import { MeshData } from './MeshData';
7
6
  import { Mesh } from '../standard/Mesh';
@@ -25,7 +24,7 @@ export declare class StreamedMeshServices extends MeshServices {
25
24
  closeOPFS(): Promise<void>;
26
25
  writeMeshDataToOPFS(meshData: MeshData): Promise<void>;
27
26
  getMeshObject(meshIndex: number): MeshObject;
28
- loadPartitionContainingMeshnode(streamedMeshnode: StreamedMeshnode): Promise<void>;
27
+ loadPartitionContainingMeshnode(): void;
29
28
  getMeshGeometryForOffsets(meshOffset: number, meshnodeOffset: number): StreamedMeshGeometry | undefined;
30
29
  meshFromOffset(meshIndex: number): Mesh;
31
30
  private getCompressedMeshDataFromOPFS;
@@ -5,12 +5,10 @@ import { PartitionProxy } from './PartitionProxy';
5
5
  import { StreamedMeshGeometry } from '../../../procoregl/StreamedMeshGeometry';
6
6
  export declare class StreamedMeshnode extends Meshnode {
7
7
  private _partitionProxy?;
8
- private _meshGeometries;
9
8
  setPartitionProxy(partitionProxy: PartitionProxy): void;
10
9
  partitionProxy(): PartitionProxy;
11
10
  meshGeometries(): MeshGeometry[];
12
- setMeshGeometry(meshIndex: number, meshGeometry: StreamedMeshGeometry): void;
13
- getMeshGeometry(meshIndex: number): StreamedMeshGeometry | undefined;
11
+ getMeshGeometry(_meshIndex: number): StreamedMeshGeometry | undefined;
14
12
  asObject(): MeshnodeObject;
15
13
  private getMeshObject;
16
14
  }
@@ -39,6 +39,7 @@ export namespace THREE {
39
39
  export { RGBAFormat };
40
40
  export { Scene };
41
41
  export { ShaderMaterial };
42
+ export { Sphere };
42
43
  export { Spherical };
43
44
  export { Triangle };
44
45
  export { Vector2 };
@@ -87,6 +88,7 @@ import { Raycaster } from 'three/src/core/Raycaster';
87
88
  import { RGBAFormat } from 'three/src/constants';
88
89
  import { Scene } from 'three/src/scenes/Scene';
89
90
  import { ShaderMaterial } from 'three/src/materials/ShaderMaterial';
91
+ import { Sphere } from 'three/src/math/Sphere';
90
92
  import { Spherical } from 'three/src/math/Spherical';
91
93
  import { Triangle } from 'three/src/math/Triangle';
92
94
  import { Vector2 } from 'three/src/math/Vector2';
@@ -8,6 +8,7 @@ export type FeatureFlags = {
8
8
  * @beta Enables writing mesh data to OPFS for partitioned models, which allows users to use features that use mesh data, notably Point to Point.
9
9
  */
10
10
  enableMeshDataOnOPFS: boolean;
11
+ enableProgressiveLoading: boolean;
11
12
  };
12
13
  export type ValidatedFeatureFlags = Readonly<FeatureFlags>;
13
14
  export type CommonOptions = {
@@ -7,3 +7,4 @@ export declare const RENDER_MODE: {
7
7
  readonly XRAY: "xray";
8
8
  };
9
9
  export type RenderMode = (typeof RENDER_MODE)[keyof typeof RENDER_MODE];
10
+ export declare const LOG_RENDERER_MESHNODES_STATS = false;
@@ -0,0 +1 @@
1
+ export { requestPersistentStorage } from './requestPersistentStorage';
@@ -0,0 +1 @@
1
+ export declare function requestPersistentStorage(quickResolveTimeout?: number): Promise<void>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@procore/bim-webviewer-sdk",
3
- "version": "17.6.0-rc.1",
3
+ "version": "17.6.0-rc.11",
4
4
  "description": "Procore BIM Webviewer SDK",
5
5
  "main": "dist/Procore.Bim.Webviewer.js",
6
6
  "types": "dist/Procore.Bim.Webviewer.d.ts",
@@ -1,2 +0,0 @@
1
- import type { Meshnode } from '../../pwfreader/PWFTypes';
2
- export declare function isMeshnodeTooSmall(meshnode: Meshnode): boolean;