@cognite/reveal 2.1.0 → 2.2.2

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;
+};

package/packages/tools/src/HtmlOverlay/BucketGrid2D.d.ts

@@ -0,0 +1,28 @@
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+/**
+ * Data structure that splits a 2D region into cells where each cell can contain zero to many
+ * elements. Elements can be stored in several cells. This data structure make overlap lookups
+ * efficient.
+ *
+ * Note! This class is tailored for usage with {@link HtmlOverlayTool} and has a few restrictions
+ * and assumptions associated with the usage. If used elsewhere, take care as to how this affects
+ * performance and behaviour.
+ */
+export declare class BucketGrid2D<T> {
+    private readonly _dimensions;
+    private readonly _bounds;
+    private readonly _cells;
+    /**
+     * Holds elements that has been removed from the collection using {@link removeOverlappingElements}.
+     * This is used to avoid expensive re-allocations of cells when removing elements.
+     */
+    private readonly _removedElements;
+    constructor(bounds: THREE.Box2, dimensions: [width: number, height: number]);
+    insert(bounds: THREE.Box2, element: T): void;
+    overlappingElements(bounds: THREE.Box2): Generator<T>;
+    removeOverlappingElements(bounds: THREE.Box2): Generator<T>;
+    private cellsIntersecting;
+}

package/packages/tools/src/HtmlOverlay/HtmlOverlayTool.d.ts

@@ -0,0 +1,159 @@
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+import { Cognite3DViewerToolBase } from '../Cognite3DViewerToolBase';
+import { Cognite3DViewer } from '../../../../core';
+/**
+ * Callback that is triggered whenever the 2D position of an overlay is updated
+ * in {@link HtmlOverlayTool}.
+ */
+export declare type HtmlOverlayPositionUpdatedDelegate = (element: HTMLElement, position2D: THREE.Vector2, position3D: THREE.Vector3, distanceToCamera: number, userData: any) => void;
+/**
+ * Callback that is triggered when a set of overlays are clustered together in
+ * {@link HtmlOverlayTool}.
+ */
+export declare type HtmlOverlayCreateClusterDelegate = (overlayElements: {
+    htmlElement: HTMLElement;
+    userData: any;
+}[]) => HTMLElement;
+/**
+ * Options for an overlay added using {@link HtmlOverlayTool.add}.
+ */
+export declare type HtmlOverlayOptions = {
+    /**
+     * Callback that is triggered whenever the position of the overlay is updated. Optional.
+     */
+    positionUpdatedCallback?: HtmlOverlayPositionUpdatedDelegate;
+    /**
+     * Optional user specified data that is provided to the {@link HtmlOverlayCreateClusterDelegate} and
+     * {@link HtmlOverlayPositionUpdatedDelegate}.
+     */
+    userData?: any;
+};
+/**
+ * Controls how close overlay elements are clustered together.
+ */
+export declare type HtmlOverlayToolClusteringOptions = {
+    /**
+     * Currently only 'overlapInScreenSpace' is supported. In this mode,
+     * overlays are clustered together into a single element as defined by
+     * the {@link createClusterElementCallback} and hidden when they overlap
+     * in screen space. The composite element is placed at the midpoint of
+     * all clustered elements.
+     *
+     * Clustered elements are faded in/out using CSS styling `transition`,
+     * `opacity` and `visibility`.
+     */
+    mode: 'overlapInScreenSpace';
+    /**
+     * Callback that is triggered when a set of overlays are clustered together
+     * to create a "composite" element as a placeholder for the clustered elements.
+     * Note that this callback will be triggered every frame for each cluster so it
+     * must be performant.
+     */
+    createClusterElementCallback: HtmlOverlayCreateClusterDelegate;
+};
+export declare type HtmlOverlayToolOptions = {
+    clusteringOptions?: HtmlOverlayToolClusteringOptions;
+};
+/**
+ * Manages HTMLoverlays for {@see Cognite3DViewer}. Attaches HTML elements to a
+ * 3D position and updates its position/visibility as user moves the camera. This is
+ * useful to create HTML overlays to highlight information about key positions in the 3D model.
+ *
+ * Attached elements *must* have CSS style 'position: absolute'. It's also recommended
+ * in most cases to have styles 'pointer-events: none' and 'touch-action: none' to avoid
+ * interfering with 3D navigation. Consider also applying 'transform: translate(-50%, -50%)'
+ * to anchor the center of the element rather than the top-left corner. In some cases the
+ * `zIndex`-attribute is necessary for the element to appear on top of the viewer.
+ *
+ * @example
+ * ```js
+ * const el = document.createElement('div');
+ * el.style.position = 'absolute'; // Required!
+ * // Anchor to center of element
+ * el.style.transform = 'translate(-50%, -50%)';
+ * // Avoid being target for events
+ * el.style.pointerEvents = 'none;
+ * el.style.touchAction = 'none';
+ * // Render in front of other elements
+ * el.style.zIndex = 10;
+ *
+ * el.style.color = 'red';
+ * el.innerHtml = '<h1>Overlay</h1>';
+ *
+ * const overlayTool = new HtmlOverlayTool(viewer);
+ * overlayTool.add(el, new THREE.Vector3(10, 10, 10));
+ * // ...
+ * overlayTool.remove(el);
+ * // or, to remove all attached elements
+ * overlayTool.clear();
+ *
+ * // detach the tool from the viewer
+ * overlayTool.dispose();
+ * ```
+ */
+export declare class HtmlOverlayTool extends Cognite3DViewerToolBase {
+    private readonly _viewer;
+    private readonly _options;
+    private readonly _htmlOverlays;
+    private readonly _compositeOverlays;
+    private readonly _onSceneRenderedHandler;
+    private readonly _onViewerDisposedHandler;
+    private readonly _preallocatedVariables;
+    private readonly scheduleUpdate;
+    private get viewerDomElement();
+    private get viewerCamera();
+    private get viewerRenderer();
+    constructor(viewer: Cognite3DViewer, options?: HtmlOverlayToolOptions);
+    /**
+     * Returns all added HTML elements along with their 3D positions.
+     */
+    get elements(): {
+        element: HTMLElement;
+        position3D: THREE.Vector3;
+    }[];
+    /**
+     * Removes all elements and detaches from the viewer.
+     * @override
+     */
+    dispose(): void;
+    /**
+     * Registers a HTML overlay that will be updated on rendering.
+     *
+     * @param htmlElement
+     * @param position3D
+     * @param options
+     */
+    add(htmlElement: HTMLElement, position3D: THREE.Vector3, options?: HtmlOverlayOptions): void;
+    /**
+     * Removes a overlay and removes it from the DOM.
+     * @param htmlElement
+     */
+    remove(htmlElement: HTMLElement): void;
+    /**
+     * Removes all attached HTML overlay elements.
+     */
+    clear(): void;
+    /**
+     * Updates positions of all overlays. This is automatically managed and there
+     * shouldn't be any reason to trigger this unless the attached elements are
+     * modified externally.
+     *
+     * Calling this function often might cause degraded performance.
+     */
+    forceUpdate(): void;
+    /**
+     * Update size of new elements. This is only done once as this causes
+     * layout to be invalidated which is an expensive operation.
+     */
+    private updateNewElementSizes;
+    private commitDOMChanges;
+    private clusterElements;
+    private cleanupClusterElements;
+    private clusterByOverlapInScreenSpace;
+    private addComposite;
+    private onSceneRendered;
+    private onViewerDisposed;
+}

package/packages/tools/src/Timeline/Keyframe.d.ts

@@ -0,0 +1,38 @@
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { NodeCollectionBase, NodeAppearance } from '../../../../core/src';
+import { Cognite3DModel } from '../../../../core';
+/**
+ * Timeline Key Frames contains parameters to access Nodes, Styles for the Timeline
+ */
+export declare class Keyframe {
+    private readonly _date;
+    private readonly _model;
+    private readonly _nodeCollectionAndAppearance;
+    constructor(model: Cognite3DModel, date: Date);
+    /**
+     * Get date of the Keyframe
+     * @returns date
+     */
+    getKeyframeDate(): Date;
+    /**
+     * Assigns the styles for the node set for the model for this Keyframe
+     */
+    activate(): void;
+    /**
+     * Removes the style for the model
+     */
+    deactivate(): void;
+    /**
+     * Add node & style to the collection
+     * @param nodeCollection Node set to apply the Styles
+     * @param nodeAppearance Style to assign to the node collection
+     */
+    assignStyledNodeCollection(nodeCollection: NodeCollectionBase, nodeAppearance: NodeAppearance): void;
+    /**
+     * Remove Node & Style for this keyframe's nodeCollection and nodeAppearance
+     * @param nodeCollection Nodes to be unassign from node collection
+     */
+    unassignStyledNodeCollection(nodeCollection: NodeCollectionBase): void;
+}