@cognite/reveal 2.1.0 → 2.2.2

package/core/src/datamodels/base/MetadataRepository.d.ts

@@ -1,6 +0,0 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-export interface MetadataRepository<Input, Output> {
-    loadData(input: Input): Output;
-}

package/core/src/datamodels/cad/CadModelMetadataRepository.d.ts

@@ -1,15 +0,0 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { CadMetadataParser } from './parsers/CadMetadataParser';
-import { CadModelMetadata } from './CadModelMetadata';
-import { MetadataRepository } from '../base';
-import { ModelDataClient } from '../../utilities/networking/types';
-export declare class CadModelMetadataRepository<TModelIdentifier> implements MetadataRepository<TModelIdentifier, Promise<CadModelMetadata>> {
-    private readonly _modelMetadataProvider;
-    private readonly _cadSceneParser;
-    private readonly _blobFileName;
-    private _currentModelIdentifier;
-    constructor(modelMetadataProvider: ModelDataClient<TModelIdentifier>, cadMetadataParser: CadMetadataParser, blobFileName?: string);
-    loadData(model: TModelIdentifier): Promise<CadModelMetadata>;
-}

package/core/src/datamodels/cad/index.d.ts

@@ -1,8 +0,0 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { CadNode, SuggestedCameraConfig } from './CadNode';
-import { CadModelMetadata } from './CadModelMetadata';
-import { SectorMetadata } from './sector/types';
-import { NodeAppearance, NodeOutlineColor, DefaultNodeAppearance } from './NodeAppearance';
-export { CadNode, NodeAppearance, NodeOutlineColor, DefaultNodeAppearance, CadModelMetadata, SectorMetadata, SuggestedCameraConfig };

package/core/src/datamodels/cad/rendering/types.d.ts

@@ -1,25 +0,0 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-export declare type TriangleMesh = {
-    readonly fileId: number;
-    readonly indices: Uint32Array;
-    readonly treeIndices: Float32Array;
-    readonly vertices: Float32Array;
-    readonly normals: Float32Array | undefined;
-    readonly colors: Uint8Array;
-};
-export declare type InstancedMeshFile = {
-    readonly fileId: number;
-    readonly indices: Uint32Array;
-    readonly vertices: Float32Array;
-    readonly instances: InstancedMesh[];
-};
-export declare type InstancedMesh = {
-    readonly triangleCount: number;
-    readonly triangleOffset: number;
-    readonly colors: Uint8Array;
-    readonly instanceMatrices: Float32Array;
-    readonly treeIndices: Float32Array;
-};
-export { SectorQuads } from '@cognite/reveal-parser-worker';

package/core/src/datamodels/cad/sector/types.d.ts

@@ -1,115 +0,0 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-import * as THREEext from '../../../utilities/three';
-import { LevelOfDetail } from './LevelOfDetail';
-import { InstancedMeshFile, TriangleMesh, SectorQuads } from '../rendering/types';
-import { ParsedPrimitives, ParseSectorResult, ParseCtmResult } from '@cognite/reveal-parser-worker';
-/**
- * Conversion factors from a given unit to meters.
- */
-export declare const WellKnownDistanceToMeterConversionFactors: Map<string, number>;
-export interface ConsumedSector {
-    modelIdentifier: string;
-    metadata: SectorMetadata;
-    levelOfDetail: LevelOfDetail;
-    group: THREEext.AutoDisposeGroup | undefined;
-    instancedMeshes: InstancedMeshFile[] | undefined;
-}
-export interface ParsedSector {
-    modelIdentifier: string;
-    metadata: SectorMetadata;
-    data: null | ParseSectorResult | ParseCtmResult | SectorGeometry | SectorQuads;
-    levelOfDetail: LevelOfDetail;
-}
-export interface WantedSector {
-    modelIdentifier: string;
-    modelBaseUrl: string;
-    geometryClipBox: THREE.Box3 | null;
-    levelOfDetail: LevelOfDetail;
-    metadata: SectorMetadata;
-}
-export interface SectorScene {
-    readonly version: number;
-    readonly maxTreeIndex: number;
-    readonly root: SectorMetadata;
-    readonly unit: string;
-    readonly sectorCount: number;
-    getSectorById(sectorId: number): SectorMetadata | undefined;
-    getSectorsContainingPoint(p: THREE.Vector3): SectorMetadata[];
-    getSectorsIntersectingBox(b: THREE.Box3): SectorMetadata[];
-    /**
-     * Returns bounds that contains "most geometry". This bounds is an
-     * attempt to remove junk geometry from the bounds to allow e.g. setting
-     * a good camera position.
-     */
-    getBoundsOfMostGeometry(): THREE.Box3;
-    /**
-     * Gets the sectors intersecting the frustum provided from the projection and inverse
-     * camera matrix. Note that this function expects matrices in the the coordinate system
-     * of the metadata. See below how to convert ThreeJS camera matrices to the correct format.
-     *
-     * @example Converting a ThreeJS camera to a frustum
-     * ```
-     * const cameraMatrixWorldInverse = camera.matrixWorldInverse;
-     * const cameraProjectionMatrix = camera.projectionMatrix;
-     *
-     * const transformedCameraMatrixWorldInverse =
-     *  new THREE.Matrix4().multiplyMatrices(cameraMatrixWorldInverse, model.modelMatrix)
-     *
-     * const intersectingSectors = model.scene.getSectorsIntersectingFrustum(
-     *   cameraProjectionMatrix,
-     *   transformedCameraMatrixWorldInverse
-     * );
-     * ```
-     * @param projectionMatrix
-     * @param inverseCameraModelMatrix
-     */
-    getSectorsIntersectingFrustum(projectionMatrix: THREE.Matrix4, inverseCameraModelMatrix: THREE.Matrix4): SectorMetadata[];
-    getAllSectors(): SectorMetadata[];
-}
-export interface SectorMetadataIndexFileSection {
-    readonly fileName: string;
-    readonly peripheralFiles: string[];
-    readonly downloadSize: number;
-}
-export interface SectorMetadataFacesFileSection {
-    readonly quadSize: number;
-    /**
-     * Coverage factors for the sector without children.
-     */
-    readonly coverageFactors: {
-        xy: number;
-        yz: number;
-        xz: number;
-    };
-    /**
-     * Coverage factor for the sectors including children.
-     */
-    readonly recursiveCoverageFactors: {
-        xy: number;
-        yz: number;
-        xz: number;
-    };
-    readonly fileName: string | null;
-    readonly downloadSize: number;
-}
-export interface SectorMetadata {
-    readonly id: number;
-    readonly path: string;
-    readonly depth: number;
-    readonly bounds: THREE.Box3;
-    readonly indexFile: SectorMetadataIndexFileSection;
-    readonly facesFile: SectorMetadataFacesFileSection;
-    readonly children: SectorMetadata[];
-    readonly estimatedDrawCallCount: number;
-    readonly estimatedRenderCost: number;
-}
-export interface SectorGeometry {
-    readonly nodeIdToTreeIndexMap: Map<number, number>;
-    readonly treeIndexToNodeIdMap: Map<number, number>;
-    readonly primitives: ParsedPrimitives;
-    readonly instanceMeshes: InstancedMeshFile[];
-    readonly triangleMeshes: TriangleMesh[];
-}

package/core/src/utilities/events/clickOrTouchEventOffset.d.ts

@@ -1,4 +0,0 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-export {};

package/core/src/utilities/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 {};

package/core/src/utilities/networking/CdfModelDataClient.d.ts

@@ -1,45 +0,0 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-import { CogniteClient } from '@cognite/sdk';
-import { ModelDataClient } from './types';
-import { Model3DOutputList } from './Model3DOutputList';
-import { File3dFormat, CameraConfiguration } from '../types';
-/**
- * Provides 3D V2 specific extensions for the standard CogniteClient used by Reveal.
- */
-export declare class CdfModelDataClient implements ModelDataClient<{
-    modelId: number;
-    revisionId: number;
-    format: File3dFormat;
-}> {
-    private readonly client;
-    private appId;
-    constructor(client: CogniteClient);
-    get headers(): import("@cognite/sdk").HttpHeaders;
-    getBinaryFile(baseUrl: string, fileName: string): Promise<ArrayBuffer>;
-    getJsonFile(baseUrl: string, fileName: string): Promise<any>;
-    getModelUrl(modelIdentififer: {
-        modelId: number;
-        revisionId: number;
-        format: File3dFormat | string;
-    }): Promise<string>;
-    getOutputs(modelIdentifier: {
-        modelId: number;
-        revisionId: number;
-        format?: File3dFormat | string;
-    }): Promise<Model3DOutputList>;
-    getModelMatrix(modelIdentifier: {
-        modelId: number;
-        revisionId: number;
-        format: File3dFormat | string;
-    }): Promise<THREE.Matrix4>;
-    getModelCamera(modelIdentifier: {
-        modelId: number;
-        revisionId: number;
-        format: File3dFormat | string;
-    }): Promise<CameraConfiguration | undefined>;
-    getApplicationIdentifier(): string;
-    private buildBlobRequestPath;
-}

package/core/src/utilities/networking/HttpHeadersProvider.d.ts

@@ -1,7 +0,0 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { HttpHeaders } from '@cognite/sdk-core';
-export interface HttpHeadersProvider {
-    readonly headers: HttpHeaders;
-}

package/core/src/utilities/networking/LocalModelDataClient.d.ts

@@ -1,23 +0,0 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-import { ModelDataClient } from './types';
-import { CameraConfiguration } from '../types';
-export declare class LocalModelDataClient implements ModelDataClient<{
-    fileName: string;
-}> {
-    getModelUrl(params: {
-        fileName: string;
-    }): Promise<string>;
-    get headers(): {};
-    getBinaryFile(baseUrl: string, fileName: string): Promise<ArrayBuffer>;
-    getJsonFile(baseUrl: string, fileName: string): Promise<any>;
-    getModelMatrix(_identifier: {
-        fileName: string;
-    }): Promise<THREE.Matrix4>;
-    getModelCamera(_identifier: {
-        fileName: string;
-    }): Promise<CameraConfiguration | undefined>;
-    getApplicationIdentifier(): string;
-}

package/core/src/utilities/networking/types.d.ts

@@ -1,37 +0,0 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-import { File3dFormat, CameraConfiguration } from '../types';
-import { HttpHeadersProvider } from './HttpHeadersProvider';
-export interface BlobOutputMetadata {
-    blobId: number;
-    format: File3dFormat | string;
-    version: number;
-}
-export interface LocalModelIdentifier {
-    fileName: string;
-}
-export interface CdfModelIdentifier {
-    modelId: number;
-    revisionId: number;
-}
-export interface JsonFileProvider {
-    getJsonFile(baseUrl: string, fileName: string): Promise<any>;
-}
-export interface BinaryFileProvider {
-    getBinaryFile(baseUrl: string, fileName: string): Promise<ArrayBuffer>;
-}
-export interface ModelMetadataProvider<TModelIdentifier> {
-    getModelUrl(identifier: TModelIdentifier): Promise<string>;
-    getModelCamera(identifier: TModelIdentifier): Promise<CameraConfiguration | undefined>;
-    getModelMatrix(identifier: TModelIdentifier): Promise<THREE.Matrix4>;
-}
-export interface ModelDataClient<TModelIdentifier> extends HttpHeadersProvider, ModelMetadataProvider<TModelIdentifier>, JsonFileProvider, BinaryFileProvider {
-    getJsonFile(baseUrl: string, fileName: string): Promise<any>;
-    getBinaryFile(baseUrl: string, fileName: string): Promise<ArrayBuffer>;
-    /**
-     * Returns an identifier that can be used to identify the application Reveal is used in.
-     */
-    getApplicationIdentifier(): string;
-}

package/core/src/utilities/networking/utilities.d.ts

@@ -1,13 +0,0 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { CogniteClient, Versioned3DFile } from '@cognite/sdk';
-export declare const supportedVersions: number[];
-export declare function getNewestVersionedFile(files: Versioned3DFile[]): Versioned3DFile;
-export declare function fetchWithStatusCheck(url: string): Promise<Response>;
-/**
- * Determines the `appId` of the `CogniteClient` provided.
- * @param sdk Instance of `CogniteClient`.
- * @returns Application ID or 'unknown' if not found.
- */
-export declare function getSdkApplicationId(sdk: CogniteClient): string;

package/core/src/utilities/rxOperations.d.ts

@@ -1,5 +0,0 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-export declare const emissionLastMillis: (millis: number) => import("rxjs").UnaryFunction<import("rxjs").Observable<unknown>, import("rxjs").Observable<boolean>>;
-export declare const delayedSwitch: (millis: number) => import("rxjs").Observable<boolean>;

package/core/src/utilities/three/dumpRendererToImage.d.ts

@@ -1,5 +0,0 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-export declare function dumpRendererToImage(renderer: THREE.WebGLRenderer, renderTarget: THREE.WebGLRenderTarget): Promise<string>;

package/core/src/utilities/three/index.d.ts

@@ -1,7 +0,0 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-export { AutoDisposeGroup } from './AutoDisposeGroup';
-export { BoundingBoxLOD } from './BoundingBoxLOD';
-export { getBox3CornerPoints } from './getBox3CornerPoints';
-export { dumpRendererToImage } from './dumpRendererToImage';

package/core/src/utilities/types.d.ts

@@ -1,67 +0,0 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-export declare enum File3dFormat {
-    EptPointCloud = "ept-pointcloud",
-    RevealCadModel = "reveal-directory",
-    AnyFormat = "all-outputs"
-}
-/**
- * Colors from the Cognite theme.
- */
-export declare class CogniteColors {
-    static readonly Black: THREE.Color;
-    static readonly White: THREE.Color;
-    static readonly Cyan: THREE.Color;
-    static readonly Blue: THREE.Color;
-    static readonly Purple: THREE.Color;
-    static readonly Pink: THREE.Color;
-    static readonly Orange: THREE.Color;
-    static readonly Yellow: THREE.Color;
-    static readonly VeryLightGray: THREE.Color;
-    static readonly LightGray: THREE.Color;
-}
-/**
- * Some additional colors to supplement {@link CogniteColors}.
- */
-export declare class RevealColors {
-    static readonly Red: THREE.Color;
-    static readonly Green: THREE.Color;
-}
-/**
- * State holding information about data being loaded.
- */
-export declare type LoadingState = {
-    /**
-     * Indicates if we are currently loading more data.
-     */
-    isLoading: boolean;
-    /**
-     * Items loaded so far in this batch.
-     */
-    itemsLoaded: number;
-    /**
-     * Totals number of items to load in this batch.
-     */
-    itemsRequested: number;
-    /**
-     * Number of items that has been 'culled' (i.e. deemed not necessary
-     * to load) so far in this batch.
-     */
-    itemsCulled: number;
-};
-/**
- * Represents a camera configuration, consisting of a camera position and target.
- */
-export declare type CameraConfiguration = {
-    readonly position: THREE.Vector3;
-    readonly target: THREE.Vector3;
-};
-/**
- * General typed array.
- *
- * Note that this doesn't include BigInt64Array and BigUint64Array as
- * the type of these is not number which causes some type interference problems.
- */
-export declare type TypedArray = Int8Array | Uint8Array | Int16Array | Uint16Array | Int32Array | Uint32Array | Uint8ClampedArray | Float32Array | Float64Array;

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

@@ -1,88 +0,0 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-import { Cognite3DViewer } from '@reveal/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;
-}