@pilotdev/pilot-web-3d 1.0.3 → 1.0.4

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/README.md CHANGED
@@ -1,9 +1,9 @@
1
1
  # Installation
2
- > `npm install --save-dev @pilotdev/pilot-web-3d`
2
+ > `npm install --save @pilotdev/pilot-web-3d`
3
3
 
4
4
  # Summary
5
- This package contains type definitions for Ascon pilot-web-3d.js library (https://pilotcloud.ascon.net/).
5
+ This package contains type definitions for Ascon Pilot.Web.3D component (https://pilotcloud.ascon.net/).
6
6
 
7
7
  ### Additional Details
8
- * Last updated: Thu, 25 Aug 2022 17:10:25 GMT
8
+ * Last updated: Thu, 2 Sept 2022 10:10:25 GMT
9
9
  * Global values: `PilotWeb3d`
package/index.d.ts CHANGED
@@ -1,23 +1,23 @@
1
- export namespace PilotWeb3D {
1
+ /// <reference path="./three/three.d.ts" />
2
+ declare namespace PilotWeb3D {
2
3
 
3
- export type InitializeSuccessCallback = () => void;
4
- export function Initializer(options: any, callback: InitializeSuccessCallback): void;
5
- export function shutdown(): void;
6
- export type ErrorCallback = (message: string) => void;
7
- export type SuccessCallback = (modelId: any) => void;
8
- export enum DocumentType {
4
+ type InitializeSuccessCallback = () => void;
5
+ function Initializer(options: any, callback: InitializeSuccessCallback): void;
6
+ function shutdown(): void;
7
+ type ErrorCallback = (message: string) => void;
8
+ type SuccessCallback = (modelId: any) => void;
9
+ enum DocumentType {
9
10
  UNKNOWN = 0,
10
11
  DOCUMENT_2D = 1,
11
12
  DOCUMENT_3D = 2
12
13
  }
13
14
 
14
- export class GuiViewer3D extends Viewer3D {
15
- loadModel(buffer: ArrayBuffer, options: {}, onSuccessCallback: SuccessCallback, onErrorCallback: ErrorCallback): void;
15
+ class GuiViewer3D extends Viewer3D {
16
16
  getToolbar(): ViewerToolbar;
17
17
  onPostExtensionLoad(extension: Extension): void;
18
18
  }
19
19
 
20
- export class Model {
20
+ class Model {
21
21
  /**
22
22
  * Returns all model parts loaded in the viewer.
23
23
  * @returns {ModelPart[]} - An array of visible and hidden model parts
@@ -99,18 +99,18 @@
99
99
  clearColors(model?: string | ModelPart): void;
100
100
  }
101
101
 
102
- export class ModelPart {
102
+ class ModelPart {
103
103
  get id(): string;
104
104
  get elementTree(): ModelElementTree;
105
105
  dispose(): void;
106
106
  }
107
107
 
108
- export class ModelElementIds {
108
+ class ModelElementIds {
109
109
  modelPartId: string;
110
110
  elementIds: string[];
111
111
  }
112
112
 
113
- export class ModelElementTree {
113
+ class ModelElementTree {
114
114
  enumElementChildren(element: string | ModelElement, callback: (guid: string) => void, recursive?: boolean): void;
115
115
  getRootElement(): ModelElement;
116
116
  getAllElements(): ModelElement[];
@@ -119,7 +119,7 @@
119
119
  getChildLevelNumber(element: string | ModelElement): number;
120
120
  }
121
121
 
122
- export class ModelElement {
122
+ class ModelElement {
123
123
  get id(): string;
124
124
  get parent(): ModelElement | undefined;
125
125
  get type(): string;
@@ -127,22 +127,22 @@
127
127
  get children(): ModelElement[];
128
128
  }
129
129
 
130
- export class CoreEventTypes {
130
+ class CoreEventTypes {
131
131
  static VIEWER_RESIZE_EVENT: string;
132
132
  static VIEWER_MOUSE_DOWN_EVENT: string;
133
133
  static VIEWER_MOUSE_MOVE_EVENT: string;
134
134
  static VIEWER_MOUSE_UP_EVENT: string;
135
135
  static VIEWER_MOUSE_LONG_TOUCH_EVENT: string;
136
136
  }
137
- export class EventTypes extends CoreEventTypes {
137
+ class EventTypes extends CoreEventTypes {
138
138
  static SELECTION_CHANGED_EVENT: string;
139
139
  }
140
- export class SelectionEvent extends Event {
140
+ class SelectionEvent extends Event {
141
141
  selected: string[];
142
142
  modelId: string;
143
143
  }
144
144
 
145
- export interface EventsDispatcher {
145
+ interface EventsDispatcher {
146
146
  addEventListener(event: string, listener: EventListener, options?: any): void;
147
147
  removeEventListener(event: string, listener: EventListener): void;
148
148
  hasEventListener(event: string, listener: EventListener): boolean;
@@ -150,12 +150,12 @@
150
150
  clearListeners(): void;
151
151
  }
152
152
 
153
- export type CameraPosition = {
153
+ type CameraPosition = {
154
154
  position: THREE.Vector3;
155
155
  direction: THREE.Vector3;
156
156
  };
157
- export var ViewerInstance: Viewer3D;
158
- export class Viewer3D extends ViewerBase {
157
+ var ViewerInstance: Viewer3D;
158
+ class Viewer3D extends ViewerBase {
159
159
  start(): number;
160
160
  finish(): void;
161
161
  /**
@@ -195,7 +195,7 @@
195
195
  makeScreenshot(mimeType?: string, quality?: number): Promise<Blob>;
196
196
  }
197
197
 
198
- export abstract class ViewerBase {
198
+ abstract class ViewerBase {
199
199
  container: HTMLElement;
200
200
  layerManagers: Map<number, ILayerManager>;
201
201
  extensionsLoader: ExtensionLoader;
@@ -213,21 +213,21 @@
213
213
  onPostExtensionLoad(extension: Extension): void;
214
214
  }
215
215
 
216
- export class ExtensionLoader {
216
+ class ExtensionLoader {
217
217
  loadExtension(extensionId: string): Promise<Extension>;
218
218
  unloadExtension(extensionId: string): Promise<boolean>;
219
219
  getExtensions(): Extension[];
220
220
  }
221
221
 
222
- export function CreateViewer(container: HTMLDivElement): GuiViewer3D;
222
+ function CreateViewer(container: HTMLElement): GuiViewer3D;
223
223
 
224
- export interface ILayerManager {
224
+ interface ILayerManager {
225
225
  createLayer(name: string): ILayer;
226
226
  deleteLayer(name: string): boolean;
227
227
  getLayer(name: string): ILayer | null;
228
228
  hasLayer(name: string): boolean;
229
229
  }
230
- export interface ILayer {
230
+ interface ILayer {
231
231
  addOverlay(overlay: Overlay): boolean;
232
232
  removeOverlay(overlay: Overlay): boolean;
233
233
  getOverlays(): Overlay[];
@@ -235,37 +235,37 @@
235
235
  getViewBox(): LayerViewBox;
236
236
  dispose(): void;
237
237
  }
238
- export type Overlay = HTMLElement | any;
239
- export type LayerContainer = HTMLElement | any;
240
- export type LayerViewBox = DOMRect | any;
238
+ type Overlay = HTMLElement | any;
239
+ type LayerContainer = HTMLElement | any;
240
+ type LayerViewBox = DOMRect | any;
241
241
 
242
- export class Toolbar extends Control {
242
+ class Toolbar extends Control {
243
243
  addControl(control: Control): void;
244
244
  removeControl(id: string): void;
245
245
  }
246
246
 
247
- export class Control {
247
+ class Control {
248
248
  container: HTMLElement;
249
249
  id: string;
250
250
  addClass(cssClass: string): void;
251
251
  removeClass(cssClass: string): void;
252
252
  }
253
253
 
254
- export class ViewerToolbar extends Toolbar {
254
+ class ViewerToolbar extends Toolbar {
255
255
  }
256
256
 
257
- export class ToolbarBuilder {
257
+ class ToolbarBuilder {
258
258
  addButton(id: string): ButtonBuilder;
259
259
  removeItem(id: string): void;
260
260
  }
261
- export class ButtonBuilder {
261
+ class ButtonBuilder {
262
262
  withCaption(caption: string): ButtonBuilder;
263
263
  withIcon(icon: string): ButtonBuilder;
264
264
  withClickAction(action: EventListener): ButtonBuilder;
265
265
  withIsChecked(value: boolean): ButtonBuilder;
266
266
  }
267
267
 
268
- export class Extension {
268
+ class Extension {
269
269
  constructor(viewer3D: ViewerBase, options?: object);
270
270
  load(): boolean | Promise<boolean>;
271
271
  unload(): boolean;
@@ -281,10 +281,10 @@
281
281
  onToolbarCreated(builder: ToolbarBuilder): void;
282
282
  }
283
283
 
284
- export class ExtensionManager {
284
+ class ExtensionManager {
285
285
  registerExtensionType(extensionId: string, extension: typeof Extension): boolean;
286
286
  unregisterExtensionType(extensionId: string): boolean;
287
287
  getExtensionType(extensionId: string): typeof Extension;
288
288
  }
289
- export const theExtensionManager: ExtensionManager;
289
+ const theExtensionManager: ExtensionManager;
290
290
  }
package/package.json CHANGED
@@ -1,13 +1,11 @@
1
1
  {
2
2
  "name": "@pilotdev/pilot-web-3d",
3
- "version": "1.0.3",
3
+ "version": "1.0.4",
4
4
  "description": "TypeScript definitions for ASCON Pilot.Web.3D component",
5
5
  "main": "",
6
6
  "types": "index.d.ts",
7
7
  "scripts": {},
8
8
  "license": "MIT",
9
9
  "typeScriptVersion": "4.4.3",
10
- "dependencies": {
11
- "@types/three": "0.135.0"
12
- }
10
+ "dependencies": {}
13
11
  }