@giro3d/piero 1.0.0-beta.0 → 1.0.0-beta.2

package/dist/src/api/DatasetApi.d.ts

@@ -1,8 +1,35 @@
 import { Component } from 'vue';
 import { HighlightFn } from '../services/Highlighter';
 import { AttributeExtractorFn } from '../services/Picker';
+import { DatasetOrGroup } from '../types/Dataset';
 import { EntityBuilder } from '../giro3d/EntityBuilder';
 import { LoadDatasetFromFile } from '../loaders/loader';
+export type DatasetActionRegistrationParams = {
+    /**
+     * The action to execute on the dataset.
+     */
+    action: (dataset: DatasetOrGroup) => void;
+    /**
+     * The icon to display for the action.
+     */
+    icon: string;
+    /**
+     * If true, the action becomes available only when the dataset is pre-loaded.
+     */
+    mustBePreloaded?: boolean;
+    /**
+     * If true, the action becomes available only when the dataset is visible.
+     */
+    mustBeVisible?: boolean;
+    /**
+     * A predicate to filter on which datasets this action applies. By default it applies to all datasets.
+     */
+    predicate?: (dataset: DatasetOrGroup) => boolean;
+    /**
+     * The title of the button.
+     */
+    title: string;
+};
 /**
  * Parameters to register a new Dataset type.
  */
@@ -49,6 +76,7 @@ export type DatasetRegistrationParams = {
  * APIs to manipulate datasets.
  */
 export default interface DatasetApi {
+    registerDatasetAction(params: DatasetActionRegistrationParams): void;
     /**
      * Register a new dataset type.
      */

package/dist/src/api/NotificationApi.d.ts

@@ -0,0 +1,10 @@
+import { NotificationStore } from '../stores/notifications';
+import { default as Notification } from '../types/Notification';
+export declare class NotificationApiImpl implements NotificationApi {
+    private readonly store;
+    constructor(store: NotificationStore);
+    pushNotification(notification: Notification): void;
+}
+export default interface NotificationApi {
+    pushNotification(notification: Notification): void;
+}

package/dist/src/api/ViewApi.d.ts

@@ -1,4 +1,8 @@
+import { default as Instance } from '@giro3d/giro3d/core/Instance';
+import { Box3 } from '../../../../node_modules/three';
 import { default as CameraController } from '../services/CameraController';
 export default interface ViewApi {
+    getBoundingBox(): Box3;
     getCameraController(): CameraController;
+    getInstance(): Instance;
 }

package/dist/src/api/index.d.ts

@@ -1,4 +1,4 @@
 import { default as BookmarkApi } from './BookmarkApi';
-import { default as DatasetApi } from './DatasetApi';
+import { default as DatasetApi, DatasetActionRegistrationParams, DatasetRegistrationParams } from './DatasetApi';
 import { default as ViewApi } from './ViewApi';
-export { BookmarkApi, DatasetApi, ViewApi };
+export { BookmarkApi, DatasetActionRegistrationParams, DatasetApi, DatasetRegistrationParams, ViewApi, };

package/dist/src/components/panels/AnalysisPanel.vue.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, HTMLDivElement>;
+declare const _default: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
 export default _default;

package/dist/src/components/panels/DatasetOrGroupItem.vue.d.ts

@@ -5,13 +5,11 @@ type __VLS_Props = {
 declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
     zoom: (...args: any[]) => void;
     "update:visible": (...args: any[]) => void;
-    clipTo: (...args: any[]) => void;
     "update:toggle-grid": (...args: any[]) => void;
     "update:toggle-mask": (...args: any[]) => void;
 }, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
     onZoom?: ((...args: any[]) => any) | undefined;
     "onUpdate:visible"?: ((...args: any[]) => any) | undefined;
-    onClipTo?: ((...args: any[]) => any) | undefined;
     "onUpdate:toggle-grid"?: ((...args: any[]) => any) | undefined;
     "onUpdate:toggle-mask"?: ((...args: any[]) => any) | undefined;
 }>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLLIElement>;

package/dist/src/components/panels/analysis/ToolWrapper.vue.d.ts

@@ -1,6 +1,5 @@
 type __VLS_Props = {
     collapsible: boolean;
-    expanded: boolean;
     icon?: string;
     id: string;
     title: string;
@@ -14,11 +13,7 @@ declare function __VLS_template(): {
     rootEl: HTMLDivElement;
 };
 type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
-declare const __VLS_component: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
-    "update:expanded": (...args: any[]) => void;
-}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
-    "onUpdate:expanded"?: ((...args: any[]) => any) | undefined;
-}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+declare const __VLS_component: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
 declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
 export default _default;
 type __VLS_WithTemplateSlots<T, S> = T & {

package/dist/src/context.d.ts

@@ -1,6 +1,8 @@
 import { EventDispatcher } from '../../../node_modules/three';
+import { default as AnalysisApi } from './api/AnalysisApi';
 import { default as BookmarkApi } from './api/BookmarkApi';
 import { default as DatasetApi } from './api/DatasetApi';
+import { default as NotificationApi } from './api/NotificationApi';
 import { default as ViewApi } from './api/ViewApi';
 import { PieroEvents } from './events';
 import { Configuration } from './types/Configuration';
@@ -8,6 +10,7 @@ import { Configuration } from './types/Configuration';
  * Piero context.
  */
 export interface PieroContext {
+    analysis: AnalysisApi;
     /**
      * The base URL of the application.
      */
@@ -28,6 +31,10 @@ export interface PieroContext {
      * The global event dispatcher.
      */
     events: EventDispatcher<PieroEvents>;
+    /**
+     * Notification related functions.
+     */
+    notifications: NotificationApi;
     /**
      * 3D View related functions.
      */

package/dist/src/index.d.ts

@@ -14,4 +14,5 @@ import { fillObject3DUserData, UserData } from './loaders/userData';
 import { default as Bookmark } from './types/Bookmark';
 import { default as Fetcher } from './utils/Fetcher';
 import { default as Projections } from './utils/Projections';
-export { Attribute, AttributeExtractorFn, AttributesGroups, Bookmark, BookmarkApi, BookmarkEvents, Configuration, createPieroApp, DatasetApi, EntityBuilder, Fetcher, fillObject3DUserData, LoadDatasetFromFile, Module, PieroContext, PieroEmptyEvent, PieroEvents, PieroGlobalEvents, Projections, UserData, ViewApi, };
+import { default as Notification } from './types/Notification';
+export { Attribute, AttributeExtractorFn, AttributesGroups, Bookmark, BookmarkApi, BookmarkEvents, Configuration, createPieroApp, DatasetApi, EntityBuilder, Fetcher, fillObject3DUserData, LoadDatasetFromFile, Module, Notification, PieroContext, PieroEmptyEvent, PieroEvents, PieroGlobalEvents, Projections, UserData, ViewApi, };

package/dist/src/module.d.ts

@@ -1,5 +1,9 @@
 import { PieroContext } from './context';
 export interface Module {
+    /**
+     * The unique ID of the module.
+     */
+    id: string;
     /**
      * The readable name of the module.
      */

package/dist/src/modules/ClippingBoxAnalysis.d.ts

@@ -0,0 +1,18 @@
+import { Box3 } from '../../../../node_modules/three';
+import { PieroContext } from '../context';
+import { Module } from '../module';
+export declare const moduleId = "builtin-clipping-box-analysis";
+/**
+ * An analysis module that clips objects from a box.
+ */
+export default class ClippingBoxAnalysis implements Module {
+    readonly id = "builtin-clipping-box-analysis";
+    readonly name = "Clipping box";
+    private _manager;
+    private _store;
+    getClippingBox(): Box3;
+    initialize(context: PieroContext): void;
+    isClippingBoxEnabled(): boolean;
+    isClippingBoxInverted(): boolean;
+    setClippingBox(box: Box3): void;
+}

package/dist/src/modules/CrossSectionAnalysis.d.ts

@@ -0,0 +1,11 @@
+import { PieroContext } from '../context';
+import { Module } from '../module';
+/**
+ * An analysis module that displays a cross section.
+ */
+export default class CrossSectionAnalysis implements Module {
+    readonly id = "builtin-cross-section-analysis";
+    readonly name = "Cross section";
+    private _manager;
+    initialize(context: PieroContext): void;
+}

package/dist/src/modules/DownloadDataset.d.ts

@@ -0,0 +1,12 @@
+import { PieroContext } from '../context';
+import { Module } from '../module';
+/**
+ * Adds a button to download a dataset from its URL.
+ */
+export default class DownloadDataset implements Module {
+    readonly id: string;
+    readonly name: string;
+    private _context;
+    initialize(context: PieroContext): void;
+    private download;
+}

package/dist/src/modules/FloodingPlaneAnalysis.d.ts

@@ -0,0 +1,11 @@
+import { PieroContext } from '../context';
+import { Module } from '../module';
+/**
+ * An analysis module that displays a flooding plane with variable altitude.
+ */
+export default class FloodingPlaneAnalysis implements Module {
+    readonly id = "builtin-flooding-plane-analysis";
+    readonly name = "Flooding plane";
+    private _manager;
+    initialize(context: PieroContext): void;
+}

package/dist/src/modules/IFCLoader.d.ts

@@ -4,6 +4,7 @@ import { Module } from '../module';
  * Loads IFC (Industry Foundation Classes) files.
  */
 export default class IFCLoader implements Module {
+    readonly id = "builtin-ifc-loader";
     readonly name = "IFC";
     initialize(context: PieroContext): Promise<void>;
 }

package/dist/src/modules/PLYLoader.d.ts

@@ -4,6 +4,7 @@ import { Module } from '../module';
  * Loads .ply files.
  */
 export default class PLYLoader implements Module {
+    readonly id = "builtin-ply-loader";
     readonly name = "PLY";
     initialize(context: PieroContext): Promise<void> | void;
 }

package/dist/src/modules/PotreeLoader.d.ts

@@ -4,6 +4,7 @@ import { Module } from '../module';
  * Loads [Potree](https://potree.github.io/) datasets.
  */
 export default class PotreeLoader implements Module {
+    readonly id = "builtin-potree-loader";
     readonly name = "Potree";
     initialize(context: PieroContext): Promise<void> | void;
 }

package/dist/src/modules/Tour.d.ts

@@ -4,6 +4,7 @@ import { Module } from '../module';
  * Provides a guided tour of the application.
  */
 export default class TourModule implements Module {
+    readonly id = "builtin-tour";
     readonly name = "Tour";
     private _camera;
     private _cameraCallback;

package/dist/src/{services/analysis → modules/clippingBoxAnalysis}/ClippingBoxManager.d.ts

@@ -1,17 +1,22 @@
-import { default as Instance } from '@giro3d/giro3d/core/Instance';
+import { Box3 } from '../../../../../node_modules/three';
+import { PieroContext } from '../../context';
+import { DatasetOrGroup } from '../../types/Dataset';
 export default class ClippingBoxManager {
+    private readonly context;
     private readonly _cameraStore;
     private _clippingBox;
     private _clippingBoxHelper;
     private _clippingBoxMesh;
     private readonly _datasetStore;
-    private readonly _instance;
     private _previousTransformControls;
     private readonly _store;
     private _transformControls;
     private readonly _volumeHelpers;
-    constructor(instance: Instance);
+    constructor(context: PieroContext);
+    clipToDataset(dataset: DatasetOrGroup): void;
     dispose(): void;
+    isClippingBoxEnabled(): boolean;
+    setClippingBox(box: Box3): void;
     /**
      * Applies defined clipping planes to all entities.
      * This is required after:
@@ -30,6 +35,7 @@ export default class ClippingBoxManager {
      */
     private disposeClippingBox;
     private getPlanesFromBoxSides;
+    private initialize;
     /**
      * Moves an existing clipping box, while keeping its size
      */