@cognite/reveal 2.2.2 → 3.0.0-alpha.0

package/packages/tools/src/Cognite3DViewerToolBase.d.ts

@@ -1,25 +1,25 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-/**
- * Base class for tools attaching to a {@see Cognite3DViewer}.
- */
-export declare abstract class Cognite3DViewerToolBase {
-    private readonly _disposedEvent;
-    private _disposed;
-    /**
-     * Unregisters an event handler for the 'disposed'-event.
-     * @param event
-     * @param handler
-     */
-    off(event: 'disposed', handler: () => void): void;
-    /**
-     * Disposes the element and triggeres the 'disposed' event before clearing the list
-     * of dipose-listeners.
-     */
-    dispose(): void;
-    /**
-     * Throws an error if the instance has been disposed.
-     */
-    protected ensureNotDisposed(): void;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+/**
+ * Base class for tools attaching to a {@see Cognite3DViewer}.
+ */
+export declare abstract class Cognite3DViewerToolBase {
+    private readonly _disposedEvent;
+    private _disposed;
+    /**
+     * Unregisters an event handler for the 'disposed'-event.
+     * @param event
+     * @param handler
+     */
+    off(event: 'disposed', handler: () => void): void;
+    /**
+     * Disposes the element and triggeres the 'disposed' event before clearing the list
+     * of dipose-listeners.
+     */
+    dispose(): void;
+    /**
+     * Throws an error if the instance has been disposed.
+     */
+    protected ensureNotDisposed(): void;
+}

package/packages/tools/src/DebugCameraTool.d.ts

@@ -1,20 +1,20 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { Cognite3DViewer } from '../../../core';
-import { Cognite3DViewerToolBase } from './Cognite3DViewerToolBase';
-export declare class DebugCameraTool extends Cognite3DViewerToolBase {
-    private readonly _viewer;
-    private readonly _onViewerDisposedHandler;
-    private _cameraHelper?;
-    private get viewerCamera();
-    constructor(viewer: Cognite3DViewer);
-    /**
-     * Removes all elements and detaches from the viewer.
-     * @override
-     */
-    dispose(): void;
-    showCameraHelper(): void;
-    hideCameraHelper(): void;
-    private onViewerDisposed;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { Cognite3DViewer } from '../../../core';
+import { Cognite3DViewerToolBase } from './Cognite3DViewerToolBase';
+export declare class DebugCameraTool extends Cognite3DViewerToolBase {
+    private readonly _viewer;
+    private readonly _onViewerDisposedHandler;
+    private _cameraHelper?;
+    private get viewerCamera();
+    constructor(viewer: Cognite3DViewer);
+    /**
+     * Removes all elements and detaches from the viewer.
+     * @override
+     */
+    dispose(): void;
+    showCameraHelper(): void;
+    hideCameraHelper(): void;
+    private onViewerDisposed;
+}

package/packages/tools/src/DebugLoadedSectorsTool.d.ts

@@ -1,23 +1,23 @@
-import { Cognite3DViewer, Cognite3DModel } from '../../../core';
-import { Cognite3DViewerToolBase } from './Cognite3DViewerToolBase';
-export declare type DebugLoadedSectorsToolOptions = {
-    showSimpleSectors?: boolean;
-    showDetailedSectors?: boolean;
-    showDiscardedSectors?: boolean;
-    colorBy?: 'depth' | 'lod' | 'loadedTimestamp' | 'random';
-    leafsOnly?: boolean;
-    sectorPathFilterRegex?: string;
-};
-export declare class DebugLoadedSectorsTool extends Cognite3DViewerToolBase {
-    private readonly _boundingBoxes;
-    private readonly _viewer;
-    private _options;
-    private _model?;
-    constructor(viewer: Cognite3DViewer, options?: DebugLoadedSectorsToolOptions);
-    setOptions(options: DebugLoadedSectorsToolOptions): void;
-    dispose(): void;
-    showSectorBoundingBoxes(model: Cognite3DModel): void;
-    private updateBoundingBoxes;
-    private isSectorAcceptedByCurrentFilter;
-    private createBboxNodeFor;
-}
+import { Cognite3DViewer, Cognite3DModel } from '../../../core';
+import { Cognite3DViewerToolBase } from './Cognite3DViewerToolBase';
+export declare type DebugLoadedSectorsToolOptions = {
+    showSimpleSectors?: boolean;
+    showDetailedSectors?: boolean;
+    showDiscardedSectors?: boolean;
+    colorBy?: 'depth' | 'lod' | 'loadedTimestamp' | 'drawcalls' | 'random';
+    leafsOnly?: boolean;
+    sectorPathFilterRegex?: string;
+};
+export declare class DebugLoadedSectorsTool extends Cognite3DViewerToolBase {
+    private readonly _boundingBoxes;
+    private readonly _viewer;
+    private _options;
+    private _model?;
+    constructor(viewer: Cognite3DViewer, options?: DebugLoadedSectorsToolOptions);
+    setOptions(options: DebugLoadedSectorsToolOptions): void;
+    dispose(): void;
+    showSectorBoundingBoxes(model: Cognite3DModel): void;
+    private updateBoundingBoxes;
+    private isSectorAcceptedByCurrentFilter;
+    private createBboxNodeFor;
+}

package/packages/tools/src/ExplodedViewTool.d.ts

@@ -1,12 +1,12 @@
-import { Cognite3DModel } from '../../../core';
-import { Cognite3DViewerToolBase } from './Cognite3DViewerToolBase';
-export declare class ExplodedViewTool extends Cognite3DViewerToolBase {
-    private readonly _cadModel;
-    private _treeBoundingBoxdata;
-    private readonly _rootTreeIndex;
-    get readyPromise(): Promise<void>;
-    constructor(treeIndex: number, cadModel: Cognite3DModel);
-    expand(expandRadius: number): Promise<void>;
-    reset(): void;
-    private preloadBoundingBoxData;
-}
+import { Cognite3DModel } from '../../../core';
+import { Cognite3DViewerToolBase } from './Cognite3DViewerToolBase';
+export declare class ExplodedViewTool extends Cognite3DViewerToolBase {
+    private readonly _cadModel;
+    private _treeBoundingBoxdata;
+    private readonly _rootTreeIndex;
+    get readyPromise(): Promise<void>;
+    constructor(treeIndex: number, cadModel: Cognite3DModel);
+    expand(expandRadius: number): Promise<void>;
+    reset(): void;
+    private preloadBoundingBoxData;
+}

package/packages/tools/src/Geomap/Geomap.d.ts

@@ -1,17 +1,17 @@
-import { Cognite3DViewer } from '../../../../core';
-import { LatLongPosition, MapConfig } from './MapConfig';
-export declare class Geomap {
-    private readonly _viewer;
-    private readonly _map;
-    private _intervalId;
-    private readonly _onCameraChange;
-    constructor(viewer: Cognite3DViewer, mapConfig: MapConfig);
-    private requestRedraw;
-    private getMapProvider;
-    latLongToWorldCoordinates(latLong: LatLongPosition): {
-        x: number;
-        y: number;
-    };
-    private handleCameraChange;
-    dispose(): void;
-}
+import { Cognite3DViewer } from '../../../../core';
+import { LatLongPosition, MapConfig } from './MapConfig';
+export declare class Geomap {
+    private readonly _viewer;
+    private readonly _map;
+    private _intervalId;
+    private readonly _onCameraChange;
+    constructor(viewer: Cognite3DViewer, mapConfig: MapConfig);
+    private requestRedraw;
+    private getMapProvider;
+    latLongToWorldCoordinates(latLong: LatLongPosition): {
+        x: number;
+        y: number;
+    };
+    private handleCameraChange;
+    dispose(): void;
+}

package/packages/tools/src/Geomap/GeomapTool.d.ts

@@ -1,24 +1,24 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { Cognite3DViewerToolBase } from '../Cognite3DViewerToolBase';
-import { LatLongPosition, MapConfig } from './MapConfig';
-import { Cognite3DViewer } from '../../../../core';
-/**
- * The `GeomapTool` is a geolocation for the models and allow the user to place them on the maps.
- * @version New since 2.1.
- */
-export declare class GeomapTool extends Cognite3DViewerToolBase {
-    private readonly _viewer;
-    private readonly _maps;
-    constructor(viewer: Cognite3DViewer, config: MapConfig);
-    /**
-     * Converts Latitude & Longitude into Vector2 World coordinates on the Map
-     * @param latLong Latitude & Longitude
-     */
-    latLongToWorldCoordinates(latLong: LatLongPosition): {
-        x: number;
-        y: number;
-    };
-    dispose(): void;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { Cognite3DViewerToolBase } from '../Cognite3DViewerToolBase';
+import { LatLongPosition, MapConfig } from './MapConfig';
+import { Cognite3DViewer } from '../../../../core';
+/**
+ * The `GeomapTool` is a geolocation for the models and allow the user to place them on the maps.
+ * @version New since 2.1.
+ */
+export declare class GeomapTool extends Cognite3DViewerToolBase {
+    private readonly _viewer;
+    private readonly _maps;
+    constructor(viewer: Cognite3DViewer, config: MapConfig);
+    /**
+     * Converts Latitude & Longitude into Vector2 World coordinates on the Map
+     * @param latLong Latitude & Longitude
+     */
+    latLongToWorldCoordinates(latLong: LatLongPosition): {
+        x: number;
+        y: number;
+    };
+    dispose(): void;
+}

package/packages/tools/src/Geomap/MapConfig.d.ts

@@ -1,195 +1,195 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-/**
- * Supported map Providers Bing, Here & Mapbox
- */
-export declare enum MapProviders {
-    BingMap = "BingMap",
-    HereMap = "HereMap",
-    MapboxMap = "MapboxMap",
-    OpenStreetMap = "OpenStreetMap"
-}
-/**
- * Map data for Mapbox
- */
-export declare enum MapboxMode {
-    /**
-     * Access the map data using a map style. For details see https://docs.mapbox.com/api/maps/styles/
-     */
-    Style = 100,
-    /**
-     * Access the map data using a map id or Tileset id. For details see https://docs.mapbox.com/help/glossary/tileset-id/
-     */
-    Map_Id = 101
-}
-/**
- * Mapbox Map Style, these are pre-defined styles using map/tileset id, created in Mapbox Studio style editor.
- * This is used when MapboxMode.Style is used for mode.
- */
-export declare enum MapboxStyle {
-    Streets = "mapbox/streets-v10",
-    Outdoor = "mapbox/outdoors-v10",
-    Light = "mapbox/light-v9",
-    Dark = "mapbox/dark-v9",
-    Satellite = "mapbox/satellite-v9",
-    Satellite_Streets = "mapbox/satellite-streets-v10",
-    Navigation_Day = "mapbox/navigation-preview-day-v4",
-    Navigation_Night = "mapbox/navigation-preview-night-v4",
-    Navigation_Guide_Day = "mapbox/navigation-guidance-day-v4",
-    Navigation_Guide_Night = "mapbox/navigation-guidance-night-v4"
-}
-/**
- * A map/tileset ID is a unique identifier given to every tileset, used when MapboxMode.Map_Id is choosen for mode.
- */
-export declare enum MapboxId {
-    Streets = "mapbox.mapbox-streets-v7",
-    Satellite = "mapbox.satellite",
-    Terrain = "mapbox.mapbox-terrain-v2",
-    Traffic = "mapbox.mapbox-traffic-v1",
-    TerrainRGB = "mapbox.terrain-rgb"
-}
-/**
- * Mapbox Map image tile format
- */
-export declare enum MapboxImageFormat {
-    PNG = "png",
-    PNG32 = "png32",
-    PNG64 = "png64",
-    PNG128 = "png128",
-    PNG256 = "png256",
-    JPG70 = "jpg70",
-    JPG80 = "jpg80",
-    JPG90 = "jpg90",
-    PNGRAW = "pngraw"
-}
-/**
- * Bing Map View (aerial, road, bird's eye view of the map)
- */
-export declare enum BingMapType {
-    Aerial = "a",
-    Road = "r",
-    Aerial_Labels = "h",
-    Oblique = "o",
-    Oblique_Labels = "b"
-}
-/**
- * Bing Map Tile Image formats
- */
-export declare enum BingMapImageFormat {
-    GIF = "gif",
-    JPEG = "jpeg",
-    PNG = "png"
-}
-/**
- * Here Map types
- */
-export declare enum HereMapType {
-    Aerial = "aerial",
-    Base = "base",
-    Pano = "pano",
-    Traffic = "traffic"
-}
-/**
- * Here Map View Scheme like day, night, satellite, terrain
- */
-export declare enum HereMapScheme {
-    Day = "normal.day",
-    Night = "normal.night",
-    Terrain = "terrain.day",
-    Satellite = "satellite.day"
-}
-/**
- * Here Map Tiles Image Format
- */
-export declare enum HereMapImageFormat {
-    PNG = "png",
-    PNG8 = "png8",
-    JPG = "jpg"
-}
-export declare type BingMapConfig = {
-    provider: MapProviders.BingMap;
-    /**
-     * Bing Map API Key
-     */
-    APIKey: string;
-    /**
-     * The type of the map used.
-     */
-    type?: BingMapType;
-};
-export declare type HereMapConfig = {
-    provider: MapProviders.HereMap;
-    /**
-     * Here map API Key
-     */
-    APIKey: string;
-    /**
-     * Service application code token.
-     */
-    appCode?: string;
-    /**
-     * The type of maps to be used.
-     */
-    style?: HereMapType;
-    /**
-     * Specifies the view scheme
-     */
-    scheme?: string;
-    /**
-     * Map image tile format
-     */
-    imageFormat?: HereMapImageFormat;
-    /**
-     Returned tile map image size.
-     The following sizes are supported:
-      - 256
-      - 512
-      - 128 (deprecated, although usage is still accepted)
-     */
-    size?: number;
-};
-export declare type OpenStreetMapConfig = {
-    provider: MapProviders.OpenStreetMap;
-};
-export declare type MapboxConfig = {
-    provider: MapProviders.MapboxMap;
-    /**
-     * Mapbox API Key
-     */
-    APIKey: string;
-    /**
-     * Map style or map ID if the mode is set to MAP_ID
-     */
-    id: string;
-    /**
-     Map tile access mode
-      - MapboxMode.STYLE
-      - MapboxMode.MAP_ID
-     */
-    mode?: MapboxMode;
-    /**
-     * Map image tile format
-     */
-    tileFormat?: MapboxImageFormat;
-    /**
-     * Flag to indicate if should use high resolution tiles
-     */
-    useHDPI?: boolean;
-};
-/**
- * Maps Configuration of {@link GeomapTool}.
- */
-export declare type MapConfig = {
-    /**
-     * Latitude, Longitude position
-     */
-    latlong: LatLongPosition;
-} & (BingMapConfig | HereMapConfig | MapboxConfig | OpenStreetMapConfig);
-/**
- * Latitude, Longitude position.
- */
-export declare type LatLongPosition = {
-    latitude: number;
-    longitude: number;
-};
+/*!
+ * Copyright 2021 Cognite AS
+ */
+/**
+ * Supported map Providers Bing, Here & Mapbox
+ */
+export declare enum MapProviders {
+    BingMap = "BingMap",
+    HereMap = "HereMap",
+    MapboxMap = "MapboxMap",
+    OpenStreetMap = "OpenStreetMap"
+}
+/**
+ * Map data for Mapbox
+ */
+export declare enum MapboxMode {
+    /**
+     * Access the map data using a map style. For details see https://docs.mapbox.com/api/maps/styles/
+     */
+    Style = 100,
+    /**
+     * Access the map data using a map id or Tileset id. For details see https://docs.mapbox.com/help/glossary/tileset-id/
+     */
+    Map_Id = 101
+}
+/**
+ * Mapbox Map Style, these are pre-defined styles using map/tileset id, created in Mapbox Studio style editor.
+ * This is used when MapboxMode.Style is used for mode.
+ */
+export declare enum MapboxStyle {
+    Streets = "mapbox/streets-v10",
+    Outdoor = "mapbox/outdoors-v10",
+    Light = "mapbox/light-v9",
+    Dark = "mapbox/dark-v9",
+    Satellite = "mapbox/satellite-v9",
+    Satellite_Streets = "mapbox/satellite-streets-v10",
+    Navigation_Day = "mapbox/navigation-preview-day-v4",
+    Navigation_Night = "mapbox/navigation-preview-night-v4",
+    Navigation_Guide_Day = "mapbox/navigation-guidance-day-v4",
+    Navigation_Guide_Night = "mapbox/navigation-guidance-night-v4"
+}
+/**
+ * A map/tileset ID is a unique identifier given to every tileset, used when MapboxMode.Map_Id is choosen for mode.
+ */
+export declare enum MapboxId {
+    Streets = "mapbox.mapbox-streets-v7",
+    Satellite = "mapbox.satellite",
+    Terrain = "mapbox.mapbox-terrain-v2",
+    Traffic = "mapbox.mapbox-traffic-v1",
+    TerrainRGB = "mapbox.terrain-rgb"
+}
+/**
+ * Mapbox Map image tile format
+ */
+export declare enum MapboxImageFormat {
+    PNG = "png",
+    PNG32 = "png32",
+    PNG64 = "png64",
+    PNG128 = "png128",
+    PNG256 = "png256",
+    JPG70 = "jpg70",
+    JPG80 = "jpg80",
+    JPG90 = "jpg90",
+    PNGRAW = "pngraw"
+}
+/**
+ * Bing Map View (aerial, road, bird's eye view of the map)
+ */
+export declare enum BingMapType {
+    Aerial = "a",
+    Road = "r",
+    Aerial_Labels = "h",
+    Oblique = "o",
+    Oblique_Labels = "b"
+}
+/**
+ * Bing Map Tile Image formats
+ */
+export declare enum BingMapImageFormat {
+    GIF = "gif",
+    JPEG = "jpeg",
+    PNG = "png"
+}
+/**
+ * Here Map types
+ */
+export declare enum HereMapType {
+    Aerial = "aerial",
+    Base = "base",
+    Pano = "pano",
+    Traffic = "traffic"
+}
+/**
+ * Here Map View Scheme like day, night, satellite, terrain
+ */
+export declare enum HereMapScheme {
+    Day = "normal.day",
+    Night = "normal.night",
+    Terrain = "terrain.day",
+    Satellite = "satellite.day"
+}
+/**
+ * Here Map Tiles Image Format
+ */
+export declare enum HereMapImageFormat {
+    PNG = "png",
+    PNG8 = "png8",
+    JPG = "jpg"
+}
+export declare type BingMapConfig = {
+    provider: MapProviders.BingMap;
+    /**
+     * Bing Map API Key
+     */
+    APIKey: string;
+    /**
+     * The type of the map used.
+     */
+    type?: BingMapType;
+};
+export declare type HereMapConfig = {
+    provider: MapProviders.HereMap;
+    /**
+     * Here map API Key
+     */
+    APIKey: string;
+    /**
+     * Service application code token.
+     */
+    appCode?: string;
+    /**
+     * The type of maps to be used.
+     */
+    style?: HereMapType;
+    /**
+     * Specifies the view scheme
+     */
+    scheme?: string;
+    /**
+     * Map image tile format
+     */
+    imageFormat?: HereMapImageFormat;
+    /**
+     Returned tile map image size.
+     The following sizes are supported:
+      - 256
+      - 512
+      - 128 (deprecated, although usage is still accepted)
+     */
+    size?: number;
+};
+export declare type OpenStreetMapConfig = {
+    provider: MapProviders.OpenStreetMap;
+};
+export declare type MapboxConfig = {
+    provider: MapProviders.MapboxMap;
+    /**
+     * Mapbox API Key
+     */
+    APIKey: string;
+    /**
+     * Map style or map ID if the mode is set to MAP_ID
+     */
+    id: string;
+    /**
+     Map tile access mode
+      - MapboxMode.STYLE
+      - MapboxMode.MAP_ID
+     */
+    mode?: MapboxMode;
+    /**
+     * Map image tile format
+     */
+    tileFormat?: MapboxImageFormat;
+    /**
+     * Flag to indicate if should use high resolution tiles
+     */
+    useHDPI?: boolean;
+};
+/**
+ * Maps Configuration of {@link GeomapTool}.
+ */
+export declare type MapConfig = {
+    /**
+     * Latitude, Longitude position
+     */
+    latlong: LatLongPosition;
+} & (BingMapConfig | HereMapConfig | MapboxConfig | OpenStreetMapConfig);
+/**
+ * Latitude, Longitude position.
+ */
+export declare type LatLongPosition = {
+    latitude: number;
+    longitude: number;
+};