@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
@@ -1,12 +1,13 @@
1
1
  import { Vector3 } from 'three/src/math/Vector3';
2
2
  import { Matrix4 } from 'three/src/math/Matrix4';
3
- import { Meshnode } from '../pwfreader/shared/Meshnode';
3
+ import { Meshnode } from '../../pwfreader/shared/Meshnode';
4
4
  export declare class KDTree {
5
5
  private MAX_CHILDREN_PER_NODE;
6
6
  private readonly root;
7
7
  private frustum;
8
8
  private queue;
9
9
  private readonly result;
10
+ meshnodes: Meshnode[];
10
11
  constructor();
11
12
  cullTree(cameraPosition: Vector3, frustumMatrix: Matrix4, detailsParam: number): {
12
13
  opaques: Set<Meshnode>;
@@ -1,4 +1,4 @@
1
- import { Meshnode } from '../pwfreader/shared/Meshnode';
1
+ import { Meshnode } from '../../pwfreader/shared/Meshnode';
2
2
  export declare class KDTreeNode {
3
3
  private meshnodeValue;
4
4
  private childrenArray;
@@ -0,0 +1,2 @@
1
+ import { Meshnode } from '../../pwfreader/shared/Meshnode';
2
+ export declare function isMeshnodeTooSmall(meshnode: Meshnode): boolean;
@@ -1,10 +1,8 @@
1
- import { KDTree } from './KDTree';
2
- import { WASMTree } from './WASMTree';
3
- import { Meshnode } from '../pwfreader/shared/Meshnode';
1
+ import type { RenderMode } from '../utils/constants';
4
2
  import { ColorServices } from './ColorServices';
5
- import { RenderMode } from '../utils/constants';
3
+ import type { Models } from './Models';
6
4
  export interface ViewerRenderer {
7
- initialize(sceneGraph: WASMTree | KDTree, meshnodes: Meshnode[], measureSet: number[], colorServices: ColorServices): void;
5
+ initialize(measureSet: number[], models: Models, colorService: ColorServices): void;
8
6
  autoClear: boolean;
9
7
  domElement: HTMLCanvasElement;
10
8
  clippingPlanes: any[];
@@ -28,7 +26,7 @@ export interface ViewerRenderer {
28
26
  readRenderTargetPixels(renderTarget: THREE.WebGLRenderTarget, x: number, y: number, width: number, height: number, buffer: Uint8Array): void;
29
27
  setRenderMode(mode: RenderMode): void;
30
28
  getRenderMode(): string;
31
- setDetailsParam(detailsParam: {
29
+ setDetailsParams(detailsParam: {
32
30
  detailsInMotion: number;
33
31
  detailsAtRest: number;
34
32
  }): void;
@@ -8,5 +8,6 @@ export declare class MockMeshnode {
8
8
  constructor(box3: THREE.Box3, meshnodeIndex: number, opaque: boolean);
9
9
  box3(): THREE.Box3;
10
10
  index(): number;
11
+ virtualIndex(): number;
11
12
  opaque(): boolean;
12
13
  }
@@ -1,5 +1,4 @@
1
1
  export class PWF {
2
- static SMALLEST_OBJECT_AT_10_FEET: number;
3
2
  static timeSince(time: any): string;
4
3
  static isPartitionProxiesAB(meshAB: any): boolean;
5
4
  constructor(params: any);
@@ -9,7 +8,6 @@ export class PWF {
9
8
  offsetY: number;
10
9
  offsetZ: number;
11
10
  };
12
- sceneGraphName: any;
13
11
  isLogging: any;
14
12
  locale: any;
15
13
  downloadMetaData: any;
@@ -17,7 +15,6 @@ export class PWF {
17
15
  nodeServices: NodeServices | null;
18
16
  meshnodeServices: StreamedMeshnodeServices | MeshnodeServices | null;
19
17
  meshServices: StreamedMeshServices | MeshServices | null;
20
- sceneGraph: WASMTree | KDTree | null;
21
18
  bvhTree: BVHTree | null;
22
19
  measureSet: any[];
23
20
  _gl: any;
@@ -27,6 +24,13 @@ export class PWF {
27
24
  detailsInMotion: number;
28
25
  detailsAtRest: number;
29
26
  };
27
+ virtualMeshnodeIndexOffset: number;
28
+ resourceId: any;
29
+ pwfModel: {
30
+ nodes: never[];
31
+ meshnodes: never[];
32
+ meshes: never[];
33
+ };
30
34
  loadPWFVersion(version: any): void;
31
35
  version: typeof V1 | typeof V2 | undefined;
32
36
  setArrayBuffers(nodeAB: any, meshnodeAB: any, meshAB: any): void;
@@ -36,25 +40,10 @@ export class PWF {
36
40
  meshAB: any;
37
41
  setPartitionedModelBuffers(nodeAB: any, meshnodeAB: any, partitionProxiesAB: any): void;
38
42
  partitionProxiesAB: ArrayBuffer | undefined;
39
- MODEL_PERFORMANCE_DATA: {
40
- model: string;
41
- numFaces: number;
42
- detailsInMotion: number;
43
- }[];
44
- interpolateDetailsFactor(faceCount: any): number | null;
45
- computeDetailsParam(totalFaces: any): {
46
- detailsInMotion: number | null;
47
- detailsAtRest: number;
48
- };
49
43
  getNumPartitions(): number;
50
44
  initPwfParser(): void;
51
45
  pwfModelParser: PWFModelParser | undefined;
52
46
  _numMeshes: number | undefined;
53
- pwfModel: {
54
- nodes: never[];
55
- meshnodes: never[];
56
- meshes: never[];
57
- } | undefined;
58
47
  parsePwfNodes(): {
59
48
  isComplete: boolean;
60
49
  };
@@ -67,36 +56,24 @@ export class PWF {
67
56
  initMeshnodeServices(): void;
68
57
  initNodeTree(): {
69
58
  nodes: {
70
- [key: string]: import("./shared/Node").Node | import("./shared/Meshnode").Meshnode;
59
+ [key: string]: import("./shared/Meshnode").Meshnode | import("./shared/Node").Node;
71
60
  };
72
61
  isComplete: boolean;
73
62
  };
74
63
  initNodeTreeBoundingBoxes(): {
75
64
  isComplete: boolean;
76
65
  };
77
- meshnodes: null;
78
- initSceneGraph(sceneGraphName: any): {
79
- isComplete: boolean;
80
- };
81
- sceneGraphFactory(impl: any): WASMTree | KDTree;
82
66
  allMeshnodes(): import("./shared/Meshnode").Meshnode[];
83
67
  getNodeServices(): NodeServices | null;
84
- getSceneGraph(): WASMTree | KDTree | null;
85
68
  getMeshnodeFromIndex(index: any): import("./shared/Meshnode").Meshnode;
86
69
  getParentNodeIds(nodeId: any): any[];
87
70
  getSubtreeNodeIds(nodeId: any): any[];
88
- getSubtreeMeshnodeIndex(nodeId: any): any[];
71
+ getVirtualMeshnodeIndexesByNodeId(nodeId: any): any[];
89
72
  getNamedNode(nodeId: any): import("./shared/Node").Node | undefined;
90
- getSubObjects(node: any, subArr: any): void;
91
- getMeasureIds(): any[];
92
- addMeasureIds(meshnodeIndices: any): void;
93
- clearMeasureIds(): void;
94
- refresh: boolean | undefined;
95
- hasMeasureIds(arr: any): boolean;
96
- removeMeasureIds(meshnodeIndices: any): void;
97
- getMeshnodeFromNodeId(nodeId: any): import("./shared/Node").Node | import("./shared/Meshnode").Meshnode;
73
+ getSubTreeVirtualMeshnodeIndexes(node: any, subArr: any): void;
74
+ getMeshnodeFromNodeId(nodeId: any): import("./shared/Meshnode").Meshnode | import("./shared/Node").Node;
98
75
  getMeshnode(offset: any): import("./shared/Meshnode").Meshnode;
99
- getNode(offset: any): import("./shared/Node").Node | import("./shared/Meshnode").Meshnode;
76
+ getNode(offset: any): import("./shared/Meshnode").Meshnode | import("./shared/Node").Node;
100
77
  numNodes(): number;
101
78
  numMeshnodes(): number;
102
79
  numMeshes(): number;
@@ -120,14 +97,9 @@ export class PWF {
120
97
  root(): import("./shared/Node").Node;
121
98
  forEachMeshnode(callback: any): void;
122
99
  forEachNode(callback: any): void;
123
- getMeshVerticesAndFaces(meshRef: any, meshnodeOffset: any): import("./shared/MeshServices").MeshVerticesAndFaces;
124
- findFirstObject(meshnodeIndex: any): import("./shared/Node").Node;
125
- captureModelStats(): {
126
- [key: string]: any;
127
- };
128
- detailsParam: {
129
- [key: string]: any;
130
- } | undefined;
100
+ getMeshVerticesAndFaces(meshRef: any): import("./shared/MeshServices").MeshVerticesAndFaces;
101
+ findFirstObject(virtualMeshnodeIndex: any): import("./shared/Node").Node;
102
+ captureModelStats(): number;
131
103
  captureStandardModelStats(pwfModel: any): number;
132
104
  capturePartitionedModelStats(pwfModel: any): number | undefined;
133
105
  numFirstObjects(): number;
@@ -138,8 +110,6 @@ import { StreamedMeshnodeServices } from "./streaming";
138
110
  import { MeshnodeServices } from "./shared";
139
111
  import { StreamedMeshServices } from "./streaming";
140
112
  import { MeshServices } from "./shared";
141
- import { WASMTree } from "../procoregl/WASMTree";
142
- import { KDTree } from "../procoregl/KDTree";
143
113
  import { BVHTree } from "../procoregl/BVHTree";
144
114
  import * as V1 from "./v1";
145
115
  import * as V2 from "./v2";
@@ -27,6 +27,6 @@ export declare class MeshServices {
27
27
  isComplete: boolean;
28
28
  };
29
29
  private loadToGPU;
30
- getMeshVerticesAndFaces(meshOffset: number, _meshnodeOffset: number): MeshVerticesAndFaces;
30
+ getMeshVerticesAndFaces(meshOffset: number): MeshVerticesAndFaces;
31
31
  private loadMeshGeometryToGPU;
32
32
  }
@@ -44,6 +44,7 @@ export declare class Meshnode {
44
44
  isNode(): boolean;
45
45
  isMeshnode(): this is Meshnode;
46
46
  index(): number;
47
+ virtualIndex(): number;
47
48
  meshGeometries(): MeshGeometry[];
48
49
  protected geometries(): MeshGeometry[];
49
50
  private meshData;
@@ -4,7 +4,7 @@ import { MeshServices, MeshVerticesAndFaces } from '../shared/MeshServices';
4
4
  import type { StreamedMeshnode } from './StreamedMeshnode';
5
5
  export declare class StreamedMeshServices extends MeshServices {
6
6
  constructor(pwf: PWF);
7
- getMeshVerticesAndFaces(meshOffset: number, _meshnodeOffset: number): MeshVerticesAndFaces;
7
+ getMeshVerticesAndFaces(meshOffset: number): MeshVerticesAndFaces;
8
8
  loadPartitionContainingMeshnode(streamedMeshnode: StreamedMeshnode): Promise<void>;
9
9
  getMeshGeometryForOffsets(meshOffset: number, meshnodeOffset: number): StreamedMeshGeometry | undefined;
10
10
  }
@@ -4,7 +4,6 @@ declare const Cache: {
4
4
  };
5
5
  export { Cache };
6
6
  export { Webviewer } from './Webviewer';
7
- export type { ResourceDiscriminator } from './Webviewer';
8
7
  export { BenchmarkReporter as Benchmark } from './utils/Benchmark';
9
8
  export { TestRoutineRecorder } from './utils/Benchmark';
10
9
  export type { Options, GeometryBundle, FileExtractionModePwfV1OverrideOptions, FileExtractionModePwfV2OverrideOptions, FileExtractionModeOptions, ModelRevisionModePwfV2Options, ModelRevisionModePwfV1Options, Resource, ResourceOptions, FileExtractionModePwfV1OverrideResource, FileExtractionModePwfV2OverrideResource, FileExtractionModeResource, ModelRevisionModePwfV1Resource, ModelRevisionModePwfV2Resource, PwfV1Bundle, PwfV2Bundle, CommonOptions, FeatureFlags, } from './types/WebviewerOptions';
@@ -3,7 +3,7 @@ type Target = {
3
3
  [key: string]: any;
4
4
  };
5
5
  export declare namespace MainThreadDebugGui {
6
- const add: (obj: Target, configureStore?: ((store: GuiStore) => void) | undefined, onChange?: ((...args: any[]) => void) | undefined) => Target;
6
+ const add: <T extends Target>(obj: T, configureStore?: ((store: GuiStore<T>) => void) | undefined, onChange?: ((...args: any[]) => void) | undefined) => T;
7
7
  const destroy: () => void;
8
8
  }
9
9
  export {};
@@ -4,7 +4,7 @@ type Target = {
4
4
  [key: string]: any;
5
5
  };
6
6
  export declare namespace WorkerDebugGui {
7
- export const add: (obj: Target, configureStore?: ((store: GuiStore) => void) | undefined, onChange?: ((...args: any[]) => void) | undefined) => Target;
7
+ export const add: <T extends Target>(obj: T, configureStore?: ((store: GuiStore<T>) => void) | undefined, onChange?: ((...args: any[]) => void) | undefined) => T;
8
8
  type UpdateParams = {
9
9
  id: ProxyId;
10
10
  keyPath: string[];
@@ -1,6 +1,12 @@
1
- export type GuiStore = {
2
- __folder?: dat.GUI;
3
- [key: string]: dat.GUIController | GuiStore | dat.GUI | undefined;
1
+ import type { GUIController } from 'dat.gui';
2
+ type OverwriteNonObjectTypes<T, S> = {
3
+ [K in keyof T]: T[K] extends Record<string, any> ? OverwriteNonObjectTypes<T[K], S> : S;
4
4
  };
5
+ type InternalStore = {
6
+ __folder: dat.GUI;
7
+ [key: string]: any;
8
+ };
9
+ export type GuiStore<T extends Record<string, any> = Record<string, any>> = T & InternalStore & OverwriteNonObjectTypes<T, GUIController>;
5
10
  export declare const _recursiveGuifyObject: (obj: Record<string, unknown>, parentGui: dat.GUI, rootGui: dat.GUI) => GuiStore;
6
11
  export declare const guifyObject: (obj: Record<string, unknown>, parentGui: dat.GUI) => GuiStore;
12
+ export {};
@@ -1,24 +1,29 @@
1
- import type { Vector3 } from '../../types/Math';
1
+ import type { BoundingBox, Vector3 } from '../../types/Math';
2
+ import type { Meshnode } from '../../pwfreader/shared/Meshnode';
2
3
  export declare class GlobalBoundingBox {
3
- private _refinedGlobalBbox?;
4
- private _userDefinedGlobalBbox?;
5
- private _pwfGlobalBbox?;
6
- private _pwfGlobalOffset?;
7
- private hasPublishedInitialized;
8
- set pwfGlobalOffset(value: THREE.Vector3 | undefined);
9
- get pwfGlobalOffset(): THREE.Vector3 | undefined;
10
- set refinedGlobalBbox(value: THREE.Box3 | undefined | null);
11
- get refinedGlobalBbox(): THREE.Box3 | undefined | null;
12
- get userDefinedGlobalBbox(): THREE.Box3 | undefined | null;
13
- set pwfGlobalBbox(value: THREE.Box3 | undefined);
14
- get pwfGlobalBbox(): THREE.Box3 | undefined;
15
- private isInitialized;
16
- private maybePublishInitialized;
17
- setUserDefinedBoundingBox(params: {
18
- min: Vector3;
19
- max: Vector3;
20
- rotation: Vector3;
21
- } | null): void;
4
+ private _refinedGlobalBbox;
5
+ private userDefinedGlobalBbox;
6
+ private pwfGlobalOffset;
7
+ private pwfGlobalBbox;
8
+ private zoomToGlobalParams;
9
+ private meshnodes;
10
+ private get refinedGlobalBbox();
11
+ resetRefinedGlobalBbox(): void;
12
+ constructor(params: {
13
+ readonly meshnodes: Meshnode[];
14
+ readonly globalOffset: Vector3;
15
+ readonly globalBbox: BoundingBox;
16
+ readonly userDefinedGlobalBbox: {
17
+ min: Vector3;
18
+ max: Vector3;
19
+ rotation: Vector3;
20
+ } | null;
21
+ readonly zoomToGlobalParams: {
22
+ spaceJunkEliminationThreshold: number;
23
+ };
24
+ });
22
25
  getGlobalBoundingBox(): THREE.Box3;
23
26
  }
24
- export declare const globalBoundingBox: GlobalBoundingBox;
27
+ export declare let globalBoundingBox: GlobalBoundingBox;
28
+ export declare function initGlobalBoundingBoxSingleton(...params: ConstructorParameters<typeof GlobalBoundingBox>): void;
29
+ export declare function disposeGlobalBoundingBoxSingleton(): void;
@@ -1 +1 @@
1
- export { globalBoundingBox } from './globalBoundingBox';
1
+ export { globalBoundingBox, initGlobalBoundingBoxSingleton, disposeGlobalBoundingBoxSingleton, } from './globalBoundingBox';
@@ -1,8 +1,15 @@
1
- import { PWF } from '../../pwfreader/PWF';
2
- type ComputeRefinedBboxParams = {
1
+ import { THREE } from '../../threeShaking';
2
+ import type { Meshnode } from '../../pwfreader/shared/Meshnode';
3
+ export declare const computeRefinedBbox: (params: {
3
4
  bbox: THREE.Box3;
4
- pwf: PWF;
5
+ meshnodes: Meshnode[];
5
6
  spaceJunkEliminationThreshold: number;
7
+ }) => THREE.Box3;
8
+ declare const _default: {
9
+ computeRefinedBbox: (params: {
10
+ bbox: import("three").Box3;
11
+ meshnodes: Meshnode[];
12
+ spaceJunkEliminationThreshold: number;
13
+ }) => import("three").Box3;
6
14
  };
7
- export declare const computeRefinedBbox: ({ bbox: globalBbox, pwf, spaceJunkEliminationThreshold, }: ComputeRefinedBboxParams) => import("three").Box3;
8
- export {};
15
+ export default _default;
@@ -1,10 +1,17 @@
1
- type CreateZoomExtentsDebugGuiParams = {
2
- onChange: () => void;
3
- };
4
- export declare const createZoomExtentsDebugGui: (params: CreateZoomExtentsDebugGuiParams) => {
5
- [key: string]: any;
1
+ declare const DEFAULT_ZOOM_EXTENTS_DEBUG_GUI: {
2
+ zoomExtents: {
3
+ zenith: number;
4
+ azimuth: number;
5
+ distanceFromCenterFactor: number;
6
+ };
6
7
  };
7
- export declare const createZoomToGlobalDebugGui: (params: CreateZoomExtentsDebugGuiParams) => {
8
- [key: string]: any;
8
+ export declare const createZoomExtentsDebugGui: (params: {
9
+ onChange: () => void;
10
+ }) => typeof DEFAULT_ZOOM_EXTENTS_DEBUG_GUI;
11
+ declare const DEFAULT_SPACE_JUNK_DEBUG_GUI: {
12
+ spaceJunkEliminationThreshold: number;
9
13
  };
14
+ export declare const createZoomToGlobalDebugGui: (params: {
15
+ onChange: () => void;
16
+ }) => typeof DEFAULT_SPACE_JUNK_DEBUG_GUI;
10
17
  export {};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@procore/bim-webviewer-sdk",
3
- "version": "15.4.0",
3
+ "version": "15.5.0-plane-mapping.1",
4
4
  "description": "Procore BIM Webviewer SDK",
5
5
  "main": "dist/Procore.Bim.Webviewer.js",
6
6
  "types": "dist/Procore.Bim.Webviewer.d.ts",