@cognite/reveal 2.1.2 → 2.2.0

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

@@ -1,88 +0,0 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-import { Cognite3DViewer } from '../../../core';
-import { Cognite3DViewerToolBase } from './Cognite3DViewerToolBase';
-export declare type HtmlOverlayPositionUpdatedDelegate = (element: HTMLElement, position2D: THREE.Vector2, position3D: THREE.Vector3, distanceToCamera: number) => void;
-export declare type HtmlOverlayOptions = {
-    positionUpdatedCallback?: HtmlOverlayPositionUpdatedDelegate;
-};
-/**
- * Manages HTMLoverlays for {@see Cognite3DViewer}. Attaches HTML elements to a
- * 3D position and updates it's 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 'pointerEvents: none' and 'touchAction: 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 _htmlOverlays;
-    private readonly _onSceneRenderedHandler;
-    private readonly _onViewerDisposedHandler;
-    private readonly _preallocatedVariables;
-    private get viewerDomElement();
-    private get viewerCamera();
-    private get viewerRenderer();
-    constructor(viewer: Cognite3DViewer);
-    /**
-     * 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.
-     */
-    forceUpdate(): void;
-    private onSceneRendered;
-    private onViewerDisposed;
-}

package/packages/utilities/src/metrics.d.ts

@@ -1,15 +0,0 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-declare type TrackedEvents = 'init' | 'construct3dViewer' | 'loadModel' | 'error' | 'cameraNavigated';
-declare type EventProps = {
-    [key: string]: any;
-    moduleName: 'RevealManager' | 'createRevealManager' | 'Cognite3DViewer' | 'CadManager' | 'CachedRepository' | 'Cognite3DModel' | 'sectorUtilities';
-    methodName: string;
-};
-export declare function initMetrics(logMetrics: boolean, project: string, applicationId: string, eventProps: EventProps): void;
-export declare function trackEvent(eventName: TrackedEvents, eventProps: EventProps): void;
-export declare function trackLoadModel(eventProps: EventProps, modelIdentifier: any): void;
-export declare function trackError(error: Error, eventProps: EventProps): void;
-export declare function trackCameraNavigation(eventProps: EventProps): void;
-export {};