@pilotdev/pilot-web-3d 1.0.0

package/LICENCE

@@ -0,0 +1,21 @@
+    MIT License
+
+    Copyright (c) Microsoft Corporation.
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE

package/README.md

@@ -0,0 +1,9 @@
+# Installation
+> `npm install --save @team-pilot/pilot-web-3d`
+
+# Summary
+This package contains type definitions for Ascon pilot-web-3d.js library (https://pilotcloud.ascon.net/).
+
+### Additional Details
+ * Last updated: Thu, 25 Aug 2022 14:10:25 GMT
+ * Global values: `PilotWeb3d`

package/index.d.ts

@@ -0,0 +1,261 @@
+ export namespace PilotWeb3D {  
+  
+  export type InitializeSuccessCallback = () => void;
+  export declare function Initializer(options: any, callback: InitializeSuccessCallback): void;
+  export declare function shutdown(): void;
+  export type ErrorCallback = (message: string) => void;
+  export type SuccessCallback = (modelId: any) => void;
+  export enum DocumentType {
+      UNKNOWN = 0,
+      DOCUMENT_2D = 1,
+      DOCUMENT_3D = 2
+  }
+
+  export class GuiViewer3D extends Viewer3D {
+      loadModel(buffer: ArrayBuffer, options: {}, onSuccessCallback: SuccessCallback, onErrorCallback: ErrorCallback): void;
+      getToolbar(): ViewerToolbar;
+      onPostExtensionLoad(extension: Extension): void;
+  }
+  
+  export class ModelPart {
+      get id(): string;
+      get elementTree(): ModelElementTree;
+      dispose(): void;
+  }
+
+  export class Selection {
+      modelId: string;
+      selected: string[];
+  }
+  
+  export class ModelElementTree {
+    enumElementChildren(element: string | ModelElement, callback: (guid: string) => void, recursive?: boolean): void;
+    getRootElement(): ModelElement;
+    getAllElements(): ModelElement[];
+    isViewableElement(element: string | ModelElement): boolean;
+    isDetachedElement(element: string | ModelElement): boolean;
+    getChildLevelNumber(element: string | ModelElement): number;
+  }
+
+  export class ModelElement {
+    get id(): string;
+    get parent(): ModelElement | undefined;
+    get type(): string;
+    get name(): string;
+    get children(): ModelElement[];
+  }
+
+  export class CoreEventTypes {
+    static VIEWER_RESIZE_EVENT: string;
+    static VIEWER_MOUSE_DOWN_EVENT: string;
+    static VIEWER_MOUSE_MOVE_EVENT: string;
+    static VIEWER_MOUSE_UP_EVENT: string;
+    static VIEWER_MOUSE_LONG_TOUCH_EVENT: string;
+  }
+  export class EventTypes extends CoreEventTypes {
+      static SELECTION_CHANGED_EVENT: string;
+  }
+  export class SelectionEvent extends Event {
+      selected: string[];
+      modelId: string;
+  }
+
+  export interface EventsDispatcher {
+    addEventListener(event: string, listener: EventListener, options?: any): void;
+    removeEventListener(event: string, listener: EventListener): void;
+    hasEventListener(event: string, listener: EventListener): boolean;
+    dispatchEvent(event: string | Event): void;
+    clearListeners(): void;
+  }
+  
+  export class Viewer3D extends ViewerBase {
+      start(): number;
+      finish(): void;
+      loadModel(buffer: ArrayBuffer, options: {}, onSuccessCallback: SuccessCallback, onErrorCallback: ErrorCallback): void;
+      unloadModel(model: string | ModelPart): void;
+      /**
+       * Returns all models loaded in the viewer.
+       * @returns {ModelPart[]} - An array of visible and hidden models
+       */
+      getAllModels(): ModelPart[];
+      /**
+      * @returns {ModelPart[]} - An array of visible models
+      */
+      getVisibleModels(): ModelPart[];
+      /**
+      * @returns {ModelPart[]} - An array of hidden models
+      */
+      getHiddenModels(): ModelPart[];
+      /**
+       * Temporarily remove a model from the Viewer, but keep loaders, materials, and geometry alive.
+       * @param {string | ModelPart} model - model id or ModelPart object
+       * @returns {boolean} true indicates success, i.e., modelId referred to a visible model that is now hidden
+       */
+      hideModel(model: string | ModelPart): void;
+      /**
+       *
+       * @param {string | ModelPart} model - model id or ModelPart object
+       */
+      showModel(model: string | ModelPart): void;
+      /**
+       * Returns the current selection.
+       * @returns {Selection[]} Array of the currently selected nodes.
+       */
+      getSelection(): Selection[];
+      /**
+       * Hide elements
+       * @param {string[]|string} elementIds - An array of elements (elementIds) or just a single element.
+       * @param {string | ModelPart} model - id of the model that contains the elementIds. By default uses the initial model loaded into the scene.
+       */
+      hide(elementIds: string[] | string, model?: string | ModelPart): void;
+      /**
+       *
+       */
+      hideAll(): void;
+      /**
+       * Ensures the passed in elements (elementIds) are shown.
+       *
+       * @param {string[] | string} elementIds - An array of elements (elementIds) or just a single node.
+       * @param {string | ModelPart} model - id of the model that contains the elementId. By default uses the initial model loaded into the scene.
+       *
+       */
+      show(elementIds: string[] | string, model?: string | ModelPart): void;
+      /**
+       *
+       */
+      showAll(): void;
+      /**
+       * Toggles the selection for a given elementIds.
+       * If it was unselected, it is selected.
+       * If it was selected, it is unselected.
+       *
+       * @param {string} elementIds
+       * @param {string | ModelPart} model - model that contains the elementIds. Uses the initial model loaded by default.
+       */
+      toggleSelect(elementIds: string[] | string, model?: string | ModelPart): void;
+      /**
+       * Selects the array of ids. You can also pass in a single id instead of an array.
+       *
+       * @param {string[] | string} elementIds - element or array of elements to select.
+       * @param {string | ModelPart} model - model id or the model instance containing the ids.
+       *
+       */
+      select(elementIds: string[] | string, model?: string | ModelPart): void;
+      /**
+       *  Unselect all nodes in all models
+       */
+      clearSelection(): void;
+      /**
+       *
+       * @param {string[] | string} elementIds - element or array of elements to change color.
+       * @param color -
+       * @param {string | ModelPart} model - id of the model or model instance containing the ids.
+       */
+      setColor(elementIds: string[] | string, color: THREE.Color, model?: string | ModelPart): void;
+      /**
+       *
+       * @param {string | ModelPart} model - id of the model or model instance.
+       */
+      clearColors(model?: string | ModelPart): void;
+  }
+
+  export  abstract class ViewerBase {
+    container: HTMLElement;
+    layerManagers: Map<number, ILayerManager>;
+    extensionsLoader: ExtensionLoader;
+    get events(): EventsDispatcher;
+    /**
+     *
+     * @returns
+     */
+    start(): number;
+    /**
+     *
+     */
+    finish(): void;
+    /**
+   *
+   * @param buffer
+   * @param options
+   * @param onSuccessCallback
+   * @param onErrorCallback
+   */
+    loadModel(buffer: ArrayBuffer, options: {}, onSuccessCallback: SuccessCallback, onErrorCallback: ErrorCallback): void;
+    onPostExtensionLoad(extension: Extension): void;
+  }
+
+  export  class ExtensionLoader {
+    loadExtension(extensionId: string): Promise<Extension>;
+    unloadExtension(extensionId: string): Promise<boolean>;
+    getExtensions(): Extension[];
+  }
+
+  export function CreateViewer(container: HTMLDivElement): GuiViewer3D;
+
+  export interface ILayerManager {
+    createLayer(name: string): ILayer;
+    deleteLayer(name: string): boolean;
+    getLayer(name: string): ILayer | null;
+    hasLayer(name: string): boolean;
+  }
+  export interface ILayer {
+    addOverlay(overlay: Overlay): boolean;
+    removeOverlay(overlay: Overlay): boolean;
+    getOverlays(): Overlay[];
+    getContainer(): LayerContainer;
+    getViewBox(): LayerViewBox;
+    dispose(): void;
+  }
+  export  type Overlay = HTMLElement | any;
+  export  type LayerContainer = HTMLElement | any;
+  export  type LayerViewBox = DOMRect | any;
+
+  export  class Toolbar extends Control {
+    addControl(control: Control): void;
+    removeControl(id: string): void;
+  }
+
+  export  class Control {
+    container: HTMLElement;
+    id: string;
+    addClass(cssClass: string): void;
+    removeClass(cssClass: string): void;
+  }
+
+  export  class ViewerToolbar extends Toolbar {
+  }
+
+  export  class ToolbarBuilder {
+    addButton(id: string): ButtonBuilder;
+    removeItem(id: string): void;
+  }
+  export  class ButtonBuilder {
+      withCaption(caption: string): ButtonBuilder;
+      withIcon(icon: string): ButtonBuilder;
+      withClickAction(action: EventListener): ButtonBuilder;
+      withIsChecked(value: boolean): ButtonBuilder;
+  }
+
+  export  class Extension {
+    constructor(viewer3D: ViewerBase, options?: object);
+    load(): boolean | Promise<boolean>;
+    unload(): boolean;
+    /**
+    * Gets the name of the extension.
+    * @returns {string} Returns the name of the extension.
+      */
+    getName(): string;
+    onMouseDown(event: MouseEvent): void;
+    onMouseMove(event: MouseEvent): void;
+    onMouseUp(event: MouseEvent): void;
+    onMouseLongTouch(event: MouseEvent): void;
+    onToolbarCreated(builder: ToolbarBuilder): void;
+  }
+
+  export class ExtensionManager {
+    registerExtensionType(extensionId: string, extension: typeof Extension): boolean;
+    unregisterExtensionType(extensionId: string): boolean;
+    getExtensionType(extensionId: string): typeof Extension;
+  }
+  export const theExtensionManager: ExtensionManager;
+}

package/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "@pilotdev/pilot-web-3d",
+  "version": "1.0.0",
+  "description": "TypeScript definitions for ASCON pilotweb3d.js library",
+  "main": "",
+  "types": "index.d.ts",
+  "scripts": {},
+  "author": "",
+  "license": "ISC",
+  "typeScriptVersion": "4.4.3",
+  "devDependencies": {
+    "@types/three": "0.135.0"
+  }
+}