@types/forge-viewer 7.58.0 → 7.61.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.
forge-viewer/README.md CHANGED
@@ -8,7 +8,7 @@ This package contains type definitions for Forge Viewer (https://forge.autodesk.
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/forge-viewer.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Wed, 29 Dec 2021 07:01:22 GMT
11
+ * Last updated: Wed, 18 May 2022 16:31:39 GMT
12
12
  * Dependencies: none
13
13
  * Global values: `Autodesk`, `THREE`
14
14
 
forge-viewer/index.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- // Type definitions for non-npm package Forge Viewer 7.58
1
+ // Type definitions for non-npm package Forge Viewer 7.61
2
2
  // Project: https://forge.autodesk.com/en/docs/viewer/v7/developers_guide/overview/
3
3
  // Definitions by: Autodesk Forge Partner Development <https://github.com/Autodesk-Forge>
4
4
  // Alan Smith <https://github.com/alansmithnbs>
@@ -263,6 +263,8 @@ declare namespace Autodesk {
263
263
  loadOptions?: object | undefined;
264
264
  sharedPropertyDbPath?: string | undefined;
265
265
  ids?: string | undefined;
266
+ applyScaling?: string | { from: string, to: string };
267
+ modelNameOverride?: string;
266
268
  [key: string]: any;
267
269
  }
268
270
 
@@ -427,7 +429,7 @@ declare namespace Autodesk {
427
429
  fetchAlignmentsForNodes(nodes: BubbleNode[]): any;
428
430
  getFloorSelector(): any;
429
431
  getModel(node: BubbleNode): Model;
430
- getModelAndWait(node: BubbleNode): Promise<Model>;
432
+ getModelAndWait(node: BubbleNode, checkIfVisible?: boolean): Promise<Model>;
431
433
  getVisibleNodes(): BubbleNode[];
432
434
  hide(node: BubbleNode): void;
433
435
  hideAll(): void;
@@ -549,6 +551,9 @@ declare namespace Autodesk {
549
551
  accessToken?: string | undefined;
550
552
  useADP?: boolean | undefined;
551
553
  useConsolidation?: boolean | undefined;
554
+ optOutTrackingByDefault?: boolean;
555
+ shouldInitializeAuth?: boolean;
556
+ useCredentials?: boolean;
552
557
  [key: string]: any;
553
558
  }
554
559
 
@@ -603,6 +608,7 @@ declare namespace Autodesk {
603
608
  }
604
609
 
605
610
  class Extension {
611
+ container: HTMLDivElement;
606
612
  viewer: GuiViewer3D;
607
613
  options: any;
608
614
  constructor(viewer: GuiViewer3D, options: any);
@@ -613,12 +619,12 @@ declare namespace Autodesk {
613
619
  getCache(): object;
614
620
  getName(): string;
615
621
  getModes(): string[];
616
- getState(viewerState: object): void;
622
+ getState(viewerState: Private.ViewerStateOptions): void;
617
623
  isActive(mode: string): boolean;
618
624
  load(): boolean | Promise<boolean>;
619
625
  unload(): boolean;
620
626
  onToolbarCreated(toolbar?: UI.ToolBar): void;
621
- restoreState(viewerState: object, immediate: boolean): boolean;
627
+ restoreState(viewerState: Private.ViewerStateOptions, immediate: boolean): boolean;
622
628
  setActive(enable: boolean, mode: string): void;
623
629
  }
624
630
 
@@ -1062,14 +1068,19 @@ declare namespace Autodesk {
1062
1068
  constructor(container: HTMLElement, config?: Viewer3DConfig);
1063
1069
 
1064
1070
  canvas: HTMLCanvasElement;
1071
+ canvasWrap: HTMLElement;
1072
+ clientContainer: HTMLElement;
1065
1073
  config: Viewer3DConfig;
1066
1074
  container: HTMLElement;
1067
1075
  navigation: Navigation;
1068
1076
  id: number;
1069
1077
  impl: Private.Viewer3DImpl;
1078
+ loadedExtensions: { [key: string]: Extension };
1070
1079
  model: Model;
1071
1080
  prefs: Private.ViewerPreferences;
1081
+ running: boolean;
1072
1082
  started: boolean;
1083
+ theme: string;
1073
1084
  toolbar: UI.ToolBar;
1074
1085
 
1075
1086
  start(urn?: string, onSuccesfullCallback?: () => void, onErrorCallback?: (errorCode: number, errorMessage: string, statusCode: number, statusText: string) => void): any;
@@ -1257,12 +1268,12 @@ declare namespace Autodesk {
1257
1268
  }
1258
1269
 
1259
1270
  class GuiViewer3D extends Viewer3D {
1260
- toolController: ToolController;
1261
1271
  autocam: any;
1262
- progressbar: any;
1263
- utilities: ViewingUtilities;
1264
1272
  dockingPanels: any;
1265
1273
  overlays: OverlayManager;
1274
+ progressbar: Private.ProgressBar;
1275
+ toolController: ToolController;
1276
+ utilities: ViewingUtilities;
1266
1277
 
1267
1278
  addPanel(panel: UI.DockingPanel): boolean;
1268
1279
  createDebugSubmenu(button: UI.Button): void;
@@ -1375,6 +1386,36 @@ declare namespace Autodesk {
1375
1386
  currentNodeIds: object[];
1376
1387
  }
1377
1388
 
1389
+ namespace Multipage {
1390
+ namespace Events {
1391
+ const FocusedPageChanged = 'focusedPageChanged';
1392
+ const PageLoaded = 'pageLoaded';
1393
+ }
1394
+
1395
+ class MultipageExtension extends Extension {
1396
+ constructor(viewer: Viewer3D, options?: any);
1397
+
1398
+ focusedPage: any;
1399
+ mode: string;
1400
+ modes: string[];
1401
+ multipageTool: ToolInterface;
1402
+ name: string;
1403
+
1404
+ focusFirstPage(): string;
1405
+ focusLastPage(): string;
1406
+ focusNextPage(): string;
1407
+ focusOnPage(pageToFocus: any, immediate?: boolean): string;
1408
+ focusPrevPage(): string;
1409
+ getAllPages(): any[];
1410
+ getCurrentPageIndex(): number;
1411
+ getFocusedPage(): any;
1412
+ getNearestPages(): any[];
1413
+ isPageLoaded(page: any): boolean;
1414
+ isPageInView(page: any): boolean;
1415
+ loadFocusedPage(): Promise<void>;
1416
+ }
1417
+ }
1418
+
1378
1419
  namespace PDF {
1379
1420
  class PDFExtension extends Extension {
1380
1421
  constructor(viewer: Viewer3D, options?: {
@@ -1688,6 +1729,12 @@ declare namespace Autodesk {
1688
1729
  webStorage(name: string, value: any): any;
1689
1730
  }
1690
1731
 
1732
+ class ProgressBar {
1733
+ lastValue: number;
1734
+
1735
+ setPercent(pct: number): void;
1736
+ }
1737
+
1691
1738
  class BoundsCallback implements GeometryCallback {
1692
1739
  constructor(bounds: THREE.Box3);
1693
1740
 
@@ -1797,6 +1844,61 @@ declare namespace Autodesk {
1797
1844
  restoreState(viewerState: object, filter?: object, immediate?: boolean): boolean;
1798
1845
  }
1799
1846
 
1847
+ interface ViewerStateOptions {
1848
+ guid?: string;
1849
+ seedURN?: string;
1850
+ overrides?: [];
1851
+ objectSet?: ObjectSetItem[];
1852
+
1853
+ cutplanes?: number[][];
1854
+
1855
+ viewport?: {
1856
+ name: string;
1857
+ eye: [number, number, number];
1858
+ target: [number, number, number];
1859
+ up: [number, number, number];
1860
+ worldUpVector: [number, number, number];
1861
+ pivotPoint: [number, number, number];
1862
+ distanceToOrbit: number;
1863
+ aspectRatio: number;
1864
+ projection: 'perspective' | 'orthographic';
1865
+ isOrthographic: boolean;
1866
+ fieldOfView?: number;
1867
+ orthographicHeight?: number;
1868
+ };
1869
+
1870
+ renderOptions?: {
1871
+ environment: string;
1872
+ ambientOcclusion: {
1873
+ enabled: boolean;
1874
+ radius: number;
1875
+ intensity: number;
1876
+ };
1877
+ toneMap: {
1878
+ method: number;
1879
+ exposure: number;
1880
+ lightMultiplier: number;
1881
+ };
1882
+ appearance: {
1883
+ ghostHidden: boolean;
1884
+ ambientShadow: boolean;
1885
+ antiAliasing: boolean;
1886
+ progressiveDisplay: boolean;
1887
+ swapBlackAndWhite: boolean;
1888
+ displayLines: boolean;
1889
+ displayPoints: boolean;
1890
+ };
1891
+ };
1892
+ }
1893
+
1894
+ interface ObjectSetItem {
1895
+ id: number[];
1896
+ isolated: number[];
1897
+ hidden: number[];
1898
+ explodeScale: number;
1899
+ seedUrn: string;
1900
+ }
1901
+
1800
1902
  interface HitTestResult {
1801
1903
  dbId: number;
1802
1904
  distance: number;
@@ -2845,7 +2947,8 @@ declare namespace Autodesk {
2845
2947
  datavizDotOverlay: any;
2846
2948
  deviceDepthOcclusion: boolean;
2847
2949
  hasViewables: boolean;
2848
- surfaceShading: DataVisualization.Core.SurfaceShading;
2950
+ model: Viewing.Model;
2951
+ surfaceShading: { [key: number]: any; };
2849
2952
  streamLineBuilder: DataVisualization.Core.StreamLineBuilder;
2850
2953
 
2851
2954
  constructor(viewer: Viewing.Viewer3D, options?: {
@@ -2869,16 +2972,22 @@ declare namespace Autodesk {
2869
2972
  scale?: number | undefined,
2870
2973
  url?: string | undefined
2871
2974
  }): void;
2872
- registerSurfaceShadingColors(sensorType: string, colors: number[], alpha?: number): void;
2975
+ registerSurfaceShadingColors(sensorType: string, colors: number[], options?: {
2976
+ alpha?: number;
2977
+ model?: Viewing.Model;
2978
+ }): void;
2873
2979
  removeAllViewables(): void;
2874
- removeSurfaceShading(): void;
2980
+ removeSurfaceShading(model?: Viewing.Model): void;
2875
2981
  renderSurfaceShading(nodeIds: string|string[],
2876
2982
  sensorType: string,
2877
2983
  valueCallback: (device: DataVisualization.Core.SurfaceShadingPoint, sensorType: string) => number,
2878
- heatmapConfig?: {
2879
- confidence?: number | undefined;
2880
- powerParameter?: number | undefined;
2881
- alpha?: number | undefined;
2984
+ options?: {
2985
+ heatmapConfig?: {
2986
+ confidence?: number | undefined;
2987
+ powerParameter?: number | undefined;
2988
+ alpha?: number | undefined;
2989
+ };
2990
+ model?: Viewing.Model;
2882
2991
  }): void;
2883
2992
  setupSurfaceShading(model: Viewing.Model, shadingData: DataVisualization.Core.SurfaceShadingData,
2884
2993
  options?: {
@@ -2893,10 +3002,13 @@ declare namespace Autodesk {
2893
3002
  showTextures(): void;
2894
3003
  updateSurfaceShading(valueCallback: (device: DataVisualization.Core.SurfaceShadingPoint,
2895
3004
  sensorType: string) => number,
2896
- heatmapConfig?: {
2897
- confidence?: number | undefined;
2898
- powerParameter?: number | undefined;
2899
- alpha?: number | undefined;
3005
+ options?: {
3006
+ heatmapConfig?: {
3007
+ confidence?: number | undefined;
3008
+ powerParameter?: number | undefined;
3009
+ alpha?: number | undefined;
3010
+ };
3011
+ model?: Viewing.Model;
2900
3012
  }): void;
2901
3013
  }
2902
3014
 
forge-viewer/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/forge-viewer",
3
- "version": "7.58.0",
3
+ "version": "7.61.1",
4
4
  "description": "TypeScript definitions for Forge Viewer",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/forge-viewer",
6
6
  "license": "MIT",
@@ -40,6 +40,6 @@
40
40
  },
41
41
  "scripts": {},
42
42
  "dependencies": {},
43
- "typesPublisherContentHash": "fb1898861769fd1e2ec20a2689b927789353688541809dc23f97573b45e0d03c",
44
- "typeScriptVersion": "3.8"
43
+ "typesPublisherContentHash": "1687c0433767ef42f0a3c113e2499d22076bc42c374f0d2d9163826347d023ac",
44
+ "typeScriptVersion": "3.9"
45
45
  }