@bimdata/viewer 2.0.0-beta.13 → 2.0.0-beta.131

package/types/state.d.ts

@@ -3,55 +3,106 @@ declare namespace BDV {
     hub: EventHandler<StateEvents>;
 
     /**** models ****/
-    models: StateModel[];
-    modelsMap: Map<number, StateModel>;
-    loadModels(modelIds: string[]): Promise<StateModel[]>;
-    unloadModels(modelIds: string[]);
-    getModel(id: number): StateModel;
+    readonly models: StateModel[];
+    readonly modelsMap: Map<number, StateModel>;
+    loadModels(modelIds: number[]): Promise<StateModel[]>;
+    unloadModels(modelIds: number[]): void;
+    getStoreyFromAbsoluteElevation(model: StateModel, elevation: number): StateStorey;
 
     /**** objects ****/
-    objects: StateObject[];
-    objectsMap: Map<number, StateObject>;
-    uuidsMap: { get(uuid: string): StateObject[]; };
-    selectedObjects: StateObject[];
-    colorizedObjects: StateObject[];
-    deselectedObjects: StateObject[];
-    highlightedObjects: StateObject[];
-    unhighlightedObjects: StateObject[];
-    visibleObjects: StateObject[];
-    unvisibleObjects: StateObject[];
-    xrayedObjects: StateObject[];
-    unxrayedObjects: StateObject[];
+    readonly objects: StateObject[];
+    readonly objectsIds: number[];
+    readonly objectsUuids: string[];
+    readonly objectsMap: Map<number, StateObject>;
+    readonly uuidsMap: { get(uuid: string): StateObject[]; };
     getObject(id: number): StateObject;
     getObjectsByUuids(uuids: string[]): StateObject[];
-    selectObjects(ids: number[]): void;
-    colorizeObjects(ids: number[], color?: string): void;
-    deselectObjects(ids: number[]): void;
-    highlightObjects(ids: number[]): void;
-    unhighlightObjects(ids: number[]): void;
-    showObjects(ids: number[]): void;
-    hideObjects(ids: number[]): void;
-    xrayObjects(ids: number[]): void;
-    unxrayObjects(ids: number[]): void;
-    isolateObjects(ids: number[]): void;
-    reintegrateObjects(): void;
+    getObjectsOfType(type: string): StateObject[];
+    getObjectsWithTheSameTypeAs(ids: number[]): StateObject[];
+    getTypesOf(ids: number[]): string[];
+
+    readonly visibleObjects: StateObject[];
+    readonly visibleObjectsIds: number[];
+    readonly visibleObjectsUuids: string[];
+    showObjects(ids: number[], options?: any): void;
+    showObjectsByUuids(uuids: string[], options?: any): void;
+
+    readonly unvisibleObjects: StateObject[];
+    readonly unvisibleObjectsIds: number[];
+    readonly unvisibleObjectsUuids: string[];
+    hideObjects(ids: number[], options?: any): void;
+    hideObjectsByUuids(uuids: string[], options?: any): void;
+
+    readonly pickableObjects: StateObject[];
+    readonly pickableObjectsIds: number[];
+    readonly pickableObjectsUuids: string[];
+    setObjectsPickable(ids: number[], options?: any): void;
+    setObjectsPickableByUuids(uuids: string[], options?: any): void;
+
+    readonly unpickableObjects: StateObject[];
+    readonly unpickableObjectsIds: number[];
+    readonly unpickableObjectsUuids: string[];
+    setObjectsUnpickable(ids: number[], options?: any): void;
+    setObjectsUnpickableByUuids(uuids: string[], options?: any): void;
+
+    readonly selectedObjects: StateObject[];
+    readonly selectedObjectsIds: number[];
+    readonly selectedObjectsUuids: string[];
+    selectObjects(ids: number[], options?: any): void;
+    selectObjectsByUuids(uuids: string[], options?: any): void;
+
+    readonly deselectedObjects: StateObject[];
+    readonly deselectedObjectsIds: number[];
+    readonly deselectedObjectsUuids: string[];
+    deselectObjects(ids: number[], options?: any): void;
+    deselectObjectsByUuids(uuids: string[], options?: any): void;
+
+    readonly highlightedObjects: StateObject[];
+    readonly highlightedObjectsIds: number[];
+    readonly highlightedObjectsUuids: string[];
+    highlightObjects(ids: number[], options?: any): void;
+    highlightObjectsByUuids(uuids: string[], options?: any): void;
+
+    readonly unhighlightedObjects: StateObject[];
+    readonly unhighlightedObjectsIds: number[];
+    readonly unhighlightedObjectsUuids: string[];
+    unhighlightObjects(ids: number[], options?: any): void;
+    unhighlightObjectsByUuids(uuids: string[], options?: any): void;
+
+    readonly xrayedObjects: StateObject[];
+    readonly xrayedObjectsIds: number[];
+    readonly xrayedObjectsUuids: string[];
+    xrayObjects(ids: number[], options?: any): void;
+    xrayObjectsByUuids(uuids: string[], options?: any): void;
+
+    readonly unxrayedObjects: StateObject[];
+    readonly unxrayedObjectsIds: number[];
+    readonly unxrayedObjectsUuids: string[];
+    unxrayObjects(ids: number[], options?: any): void;
+    unxrayObjectsByUuids(uuids: string[], options?: any): void;
+
+    readonly colorizedObjects: StateObject[];
+    readonly colorizedObjectsIds: number[];
+    readonly colorizedObjectsUuids: string[];
+    colorizeObjects(ids: number[], color?: string, options?: any): void;
+    colorizeObjectsByUuids(uuids: string[], color?: string, options?: any): void;
 
     /**** annotations ****/
     readonly annotations: StateAnnotation[];
-    addAnnotation(annotation: StateAnnotation, options: any): StateAnnotation;
-    removeAnnotation(annotation: any, options: any): boolean;
+    addAnnotation(annotation: StateAnnotation, options?: any): StateAnnotation;
+    removeAnnotation(annotation: StateAnnotation, options?: any): boolean;
     clearAnnotations(): void;
 
     // ---
 
     /** @deprecated use `models` instead */
-    ifcs: StateModel[];
+    readonly ifcs: StateModel[];
     /** @deprecated use `modelsMap` instead */
-    ifcsMap: Map<number, StateModel>;
+    readonly ifcsMap: Map<number, StateModel>;
     /** @deprecated use `loadModels` instead */
     loadIfcs(ifcIds: string[]): Promise<StateModel[]>;
     /** @deprecated use `unloadModels` instead */
-    unloadIfcs(ifcIds: string[]);
+    unloadIfcs(ifcIds: string[]): void;
     /** @deprecated use `getModel` instead */
     getIfc(id: number): StateModel;
   }
@@ -71,55 +122,63 @@ declare namespace BDV {
     "objects-removed": {
       objects: StateObject[];
     };
-    "objects-selected": {
+    "objects-shown": {
       objects: StateObject[];
-      options?: Object;
+      options?: any;
     };
-    "objects-deselected": {
+    "objects-hidden": {
       objects: StateObject[];
-      options?: Object;
+      options?: any;
     };
-    "objects-highlighted": {
+    "objects-pickable": {
       objects: StateObject[];
-      options?: Object;
+      options?: any;
     };
-    "objects-unhighlighted": {
+    "objects-unpickable": {
       objects: StateObject[];
-      options?: Object;
+      options?: any;
     };
-    "objects-shown": {
+    "objects-selected": {
       objects: StateObject[];
-      options?: Object;
+      options?: any;
     };
-    "objects-hidden": {
+    "objects-deselected": {
+      objects: StateObject[];
+      options?: any;
+    };
+    "objects-highlighted": {
       objects: StateObject[];
-      $options?: Object;
+      options?: any;
+    };
+    "objects-unhighlighted": {
+      objects: StateObject[];
+      options?: any;
     };
     "objects-xrayed": {
       objects: StateObject[];
-      options?: Object;
+      options?: any;
     };
     "objects-unxrayed": {
       objects: StateObject[];
-      options?: Object;
+      options?: any;
     };
     "objects-colorized": {
       objects: StateObject[];
       color: number;
-      options?: Object;
+      options?: any;
     };
     // annotations events
     "annotation-added": {
-      annotation: Object;
-      options?: Object;
+      annotation: StateAnnotation;
+      options?: any;
     };
     "annotation-updated": {
-      annotation: Object;
-      options?: Object;
+      annotation: StateAnnotation;
+      options?: any;
     };
     "annotation-removed": {
-      annotation: Object;
-      options?: Object;
+      annotation: StateAnnotation;
+      options?: any;
     };
 
     // ---
@@ -134,20 +193,18 @@ declare namespace BDV {
     };
   };
 
-  interface StateModel {
-    id: number;
-    name: string;
-    type: ModelType;
-    status: ModelStatus;
+  interface StateModel extends ApiModel {
     structure: Object;
-    objects: StateObject[];
     uuids: Map<string, StateObject>;
+    objects: StateObject[];
     storeys: StateStorey[];
   }
 
   interface StateObject extends ApiObject {
     id: number;
     model: StateModel;
+
+    // Object state
     visible: boolean;
     pickable: boolean;
     selected: boolean;
@@ -158,9 +215,12 @@ declare namespace BDV {
     // Advanced getters
     readonly descendants: StateObject[];
     readonly ancestors: StateObject[];
+    readonly site: StateObject;
+    readonly building: StateObject;
+    readonly storey: StateObject;
+    readonly layout: StateObject;
+    readonly space: StateObject;
     getFirstAncestorWithType: (type: string) => StateObject;
-    storey: StateObject;
-    space: StateObject;
 
     // ---
 
@@ -184,24 +244,20 @@ declare namespace BDV {
     selected: boolean;
   }
 
-  interface StatePlan extends ApiPlan {
+  interface StatePlan extends StatePositionning {
     model: StateModel;
     storey: StateStorey;
-    positioning: StatePositionning;
-
-    key: string;
     index: number;
-    loading: boolean;
-    editing: boolean;
-    selected: boolean;
+    key: string;
   }
 
   interface StatePositionning {
-    x: number;
-    y: number;
-    angle: number;
+    translation_x: number;
+    translation_y: number;
+    rotate_z: number;
     scale: number;
     opacity: number;
+    plan?: ApiPlan;
   }
 
   interface StateAnnotation {
@@ -209,6 +265,6 @@ declare namespace BDV {
     y: number;
     z: number;
     component: any;
-    props: any;
+    props?: any;
   }
 }

package/types/$viewer.d.ts

@@ -1,17 +0,0 @@
-declare namespace BDV {
-  interface $Viewer {
-    cfg: ViewerConfig;
-    i18n: any;
-    readonly api: Api;
-    readonly state: State;
-
-    readonly pluginManager: PluginManager;
-    readonly shortcutManager: ShortcutManager;
-    readonly globalContext: GlobalContext;
-    readonly localContext: LocalContext;
-    getLocalContexts(window: string): LocalContext[];
-
-    currentContext: any;
-    contextMenu: ContextMenu;
-  }
-}

package/types/events.d.ts

@@ -1,23 +0,0 @@
-type Events = {
-  [eventName: string]: Object;
-};
-
-interface EventOptions {
-  getLastEvent?: boolean;
-}
-
-interface EventHandler<T extends Events> {
-  on<N extends keyof T>(
-    eventName: N,
-    callback: (arg: T[N]) => void,
-    options?: EventOptions
-  ): number;
-  once<N extends keyof T>(
-    eventName: N,
-    callback: (arg: T[N]) => void,
-    options?: EventOptions
-  ): number;
-  off(subscriptionId: number): void;
-  emit<N extends keyof T>(eventName: N, payload: T[N]): void;
-  clear(): void;
-}

package/types/global-context.d.ts

@@ -1,43 +0,0 @@
-declare namespace BDV {
-  interface GlobalContext {
-    hub: EventHandler<LocalContextEvents & GlobalContextEvents>;
-
-    areas: any;
-    areasSettingsDisplayed: boolean;
-    areasSwapEnabled: boolean;
-    areasSettingsFullOption: boolean;
-    bcfManagerDisplayed: boolean;
-    mouseover: boolean;
-
-    /** @deprecated */
-    getPlugins(name: string): Plugin[];
-    plugins: Map<string, Plugin>;
-
-    // ---
-
-    loading: boolean;
-    loadingProcessStart(): void;
-    loadingProcessEnd(): void;
-
-    registerShortcut(shortcut: Shortcut, context: GlobalContext): boolean;
-    unregisterShortcut(name: string, context: GlobalContext): boolean;
-
-    modals: {
-      pushModal(component: Object, options?: { args: Object }): void;
-      clearModal(): void;
-    };
-  }
-
-  type GlobalContextEvents = {
-    "plan-model-loaded": {
-      model: ApiModel;
-      plugin: ViewerDwg.Plugin;
-    };
-    "plan-model-unloaded": {
-      model: ApiModel;
-      plugin: ViewerDwg.Plugin;
-    };
-    "window-open": Window;
-    "window-close": Window;
-  };
-}

package/types/local-context.d.ts

@@ -1,91 +0,0 @@
-declare namespace BDV {
-  interface LocalContext {
-    hub: EventHandler<LocalContextEvents>;
-
-    area: any;
-    el: Element;
-    width: number;
-    height: number;
-
-    /** @deprecated */
-    getPlugin(name: string): Plugin;
-    plugins: Map<string, Plugin>;
-
-    // ---
-
-    loading: boolean;
-    loadingProcessStart(): void;
-    loadingProcessEnd(): void;
-
-    registerShortcut(shortcut: Shortcut, context: LocalContext): boolean;
-    unregisterShortcut(name: string, context: LocalContext): boolean;
-
-    modals: {
-      pushModal(component: Object, options?: { args: Object }): void;
-      clearModal(): void;
-    };
-  }
-
-  type LocalContextEvents = {
-    "3d-model-loaded": {
-      model: StateModel;
-      plugin: ViewerIfc3D.Plugin;
-      /** @deprecated use `model` instead */
-      ifc: StateModel;
-    };
-    "3d-model-unloaded": {
-      model: StateModel;
-      plugin: ViewerIfc3D.Plugin;
-      /** @deprecated use `model` instead */
-      ifc: StateModel;
-    };
-    "2d-model-loaded": {
-      model: StateModel;
-      plugin: ViewerIfc2D.Plugin;
-      /** @deprecated use `model` instead */
-      ifc: StateModel;
-    };
-    "2d-model-unloaded": {
-      model: StateModel;
-      plugin: ViewerIfc2D.Plugin;
-      /** @deprecated use `model` instead */
-      ifc: StateModel;
-    };
-    "dwg-model-loaded": {
-      dwg: Document;
-      model: StateModel;
-      plugin: ViewerDwg.Plugin;
-    };
-    "dwg-model-unloaded": {
-      plugin: ViewerDwg.Plugin;
-    };
-    "dxf-model-loaded": {
-      dxf: Document;
-      model: StateModel;
-      plugin: ViewerDwg.Plugin;
-    };
-    "dxf-model-unloaded": {
-      plugin: ViewerDwg.Plugin;
-    };
-    "plan-model-loaded": {
-      model: ApiModel;
-      plugin: ViewerDwg.Plugin;
-    };
-    "plan-model-unloaded": {
-      model: ApiModel;
-      plugin: ViewerDwg.Plugin;
-    };
-    "plugin-created": {
-      pluginName: string;
-      plugin: Plugin;
-    };
-    "plugin-destroyed": {
-      pluginName: string;
-      plugin: Plugin;
-    };
-    "plugin-menu-open": Plugin;
-    "plugin-menu-close": Plugin;
-    "context-resize": { width: number; height: number };
-    alert: { type: string; message: string };
-  };
-}

package/types/plugins-unit.d.ts

@@ -1,5 +0,0 @@
-declare namespace BDV {
-  interface PluginsUnit {
-    localContext: LocalContext;
-  }
-}

package/types/plugins.d.ts

@@ -1,77 +0,0 @@
-declare namespace BDV {
-  interface PluginConfig {
-    name: string;
-    isViewer?: boolean;
-    i18n: Object;
-    component?: Object;
-    button?: {
-      position: string;
-      stance?: number;
-      tooltip: string;
-      content: "free" | "simple" | "panel";
-      keepOpen?: boolean;
-      icon: {
-        imgUri?: string;
-        component?: Object;
-        options?: {
-          props: Object;
-        };
-      };
-    };
-    startupScript?: ($viewer: $Viewer) => void;
-    addToWindows?: string[];
-    window?: Window;
-  }
-
-  interface Plugin {
-    name: string;
-    $cfg: any;
-    $plugin: any;
-    $viewer: $Viewer;
-    viewer?: any;
-    $open?: () => void;
-    onOpen?: () => void;
-    $close?: () => void;
-    onClose?: () => void;
-  }
-
-  interface PluginViewer extends Plugin {
-    modelTypes?: string[];
-
-    getLoadedModels: () => StateModel[];
-    loadModels: (models: StateModel[]) => Promise<void>;
-    unloadModels: (models: StateModel[]) => Promise<void>;
-
-    getViewpoint: () => void | Promise<void>;
-    setViewpoint: (viewpoint: any, options?: any) => void | Promise<void>;
-
-    annotationMode: boolean;
-    startAnnotationMode: (callback: AnnotationCallback) => void;
-    stopAnnotationMode: () => void;
-
-    fitView: (args?: any) => void;
-    showUI: () => void;
-    hideUI: (options: { exceptions: string[] }) => void;
-  }
-
-  interface PluginManager {
-    cfg: ViewerConfigPlugins; // ?
-    windows: Window[];
-    pluginsUnits: PluginsUnit[];
-    readonly pluginsUnit: PluginsUnit;
-    readonly registeredPlugins: Plugin[];
-
-    getWindow(name: string): Window;
-    registerWindow(window: Window): Window;
-    unregisterWindow(name: string): boolean;
-    getPluginCopy(name: string, silent?: boolean): Plugin;
-    registerPlugin(plugin: Plugin, cfg: PluginConfig): void;
-    registerPluginsTranslations(i18nPlugin: any): void;
-    runPluginsScripts($viewer: $Viewer): void;
-
-    getLocalContext(component: any): LocalContext;
-  }
-
-  type AnnotationCallback = (params: AnnotationParams) => void;
-  type AnnotationParams = { x: number, y: number, z: number, models: StateModel[], storey?: StateStorey, page?: number };
-}

package/types/windows.d.ts

@@ -1,9 +0,0 @@
-declare namespace BDV {
-  interface Window {
-    name: string;
-    label: string;
-    icon: { imgUri: string; };
-    plugins?: string[];
-    menu?: boolean;
-  }
-}