@cognite/reveal 3.1.0 → 4.0.0-dev.20221025

package/packages/sector-parser/src/reveal-glb-parser/GlbMetadataParser.d.ts

@@ -1,14 +1,14 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { GlbHeaderData } from '../types';
-export declare class GlbMetadataParser {
-    private readonly _textDecoder;
-    private static readonly GLB_HEADER_BYTE_SIZE;
-    private static readonly CHUNK_HEADER_BYTE_SIZE;
-    constructor();
-    parseGlbMetadata(glbByteData: ArrayBuffer): GlbHeaderData;
-    private verifyGlbHeaders;
-    private parseJson;
-    private parseBinHeaders;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { GlbHeaderData } from '../types';
+export declare class GlbMetadataParser {
+    private readonly _textDecoder;
+    private static readonly GLB_HEADER_BYTE_SIZE;
+    private static readonly CHUNK_HEADER_BYTE_SIZE;
+    constructor();
+    parseGlbMetadata(glbByteData: ArrayBuffer): GlbHeaderData;
+    private verifyGlbHeaders;
+    private parseJson;
+    private parseBinHeaders;
+}

package/packages/sector-parser/src/reveal-glb-parser/primitiveGeometries.d.ts

@@ -1,12 +1,12 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-import { RevealGeometryCollectionType } from '../types';
-export declare function setBoxGeometry(geometry: THREE.BufferGeometry): THREE.Box3;
-export declare function setQuadGeometry(geometry: THREE.BufferGeometry, includeNormal?: boolean): THREE.Box3;
-export declare function setTrapeziumGeometry(geometry: THREE.BufferGeometry): THREE.Box3;
-export declare function setConeGeometry(geometry: THREE.BufferGeometry): THREE.Box3;
-export declare function setTorusGeometry(geometry: THREE.BufferGeometry): THREE.Box3;
-export declare function setNutGeometry(geometry: THREE.BufferGeometry): THREE.Box3;
-export declare function setPrimitiveTopology(primitiveCollectionName: RevealGeometryCollectionType, geometry: THREE.BufferGeometry): void;
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+import { RevealGeometryCollectionType } from '../types';
+export declare function setBoxGeometry(geometry: THREE.BufferGeometry): THREE.Box3;
+export declare function setQuadGeometry(geometry: THREE.BufferGeometry, includeNormal?: boolean): THREE.Box3;
+export declare function setTrapeziumGeometry(geometry: THREE.BufferGeometry): THREE.Box3;
+export declare function setConeGeometry(geometry: THREE.BufferGeometry): THREE.Box3;
+export declare function setTorusGeometry(geometry: THREE.BufferGeometry): THREE.Box3;
+export declare function setNutGeometry(geometry: THREE.BufferGeometry): THREE.Box3;
+export declare function setPrimitiveTopology(primitiveCollectionName: RevealGeometryCollectionType, geometry: THREE.BufferGeometry): void;

package/packages/sector-parser/src/types.d.ts

@@ -1,106 +1,106 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-export declare type GltfJson = {
-    accessors: Accessor[];
-    asset: Asset;
-    bufferViews: BufferView[];
-    buffers: Buffer[];
-    extensionsUsed: string[];
-    meshes: Mesh[];
-    nodes: Node[];
-    scene: number;
-    scenes: Scene[];
-};
-export declare type Scene = {
-    nodes: number[];
-};
-export declare type Accessor = {
-    bufferView: number;
-    byteOffset: number | undefined;
-    componentType: number;
-    count: number;
-    type: string;
-};
-export declare type Asset = {
-    copyright: string;
-    generator: string;
-    version: string;
-};
-export declare type Buffer = {
-    byteLength: number;
-};
-export declare type BufferView = {
-    buffer: number;
-    byteLength: number;
-    byteOffset: number | undefined;
-    byteStride: number;
-};
-export declare type Node = {
-    name: string;
-    mesh: number | undefined;
-    extensions: {
-        EXT_mesh_gpu_instancing: {
-            attributes: {
-                [key: string]: number;
-            };
-        } | undefined;
-    };
-};
-export declare type Mesh = {
-    primitives: Primitive[];
-    extras: {
-        [key: string]: any;
-    } | undefined;
-};
-export declare type Primitive = {
-    attributes: {
-        [key: string]: number;
-    };
-    indices: number;
-    extensions: {
-        KHR_draco_mesh_compression: {
-            attributes: {
-                [key: string]: number;
-            };
-            bufferView: number;
-        } | undefined;
-    };
-};
-export declare enum RevealGeometryCollectionType {
-    BoxCollection = 0,
-    CircleCollection = 1,
-    ConeCollection = 2,
-    EccentricConeCollection = 3,
-    EllipsoidSegmentCollection = 4,
-    GeneralCylinderCollection = 5,
-    GeneralRingCollection = 6,
-    QuadCollection = 7,
-    TorusSegmentCollection = 8,
-    TrapeziumCollection = 9,
-    NutCollection = 10,
-    TriangleMesh = 11,
-    InstanceMesh = 12
-}
-export declare type GlbHeaderData = {
-    json: GltfJson;
-    binContentLength: number;
-    byteOffsetToBinContent: number;
-};
-export declare type GeometryProcessingPayload = {
-    geometryType: RevealGeometryCollectionType;
-    bufferGeometry: THREE.InstancedBufferGeometry | THREE.BufferGeometry;
-    instancingExtension: {
-        attributes: {
-            [key: string]: number;
-        };
-    } | undefined;
-    meshId: number | undefined;
-    glbHeaderData: GlbHeaderData;
-    data: ArrayBuffer;
-};
-export declare type ParsedGeometry = {
-    type: RevealGeometryCollectionType;
-    geometryBuffer: THREE.BufferGeometry;
-    instanceId?: string;
-};
+/*!
+ * Copyright 2021 Cognite AS
+ */
+export declare type GltfJson = {
+    accessors: Accessor[];
+    asset: Asset;
+    bufferViews: BufferView[];
+    buffers: Buffer[];
+    extensionsUsed: string[];
+    meshes: Mesh[];
+    nodes: Node[];
+    scene: number;
+    scenes: Scene[];
+};
+export declare type Scene = {
+    nodes: number[];
+};
+export declare type Accessor = {
+    bufferView: number;
+    byteOffset: number | undefined;
+    componentType: number;
+    count: number;
+    type: string;
+};
+export declare type Asset = {
+    copyright: string;
+    generator: string;
+    version: string;
+};
+export declare type Buffer = {
+    byteLength: number;
+};
+export declare type BufferView = {
+    buffer: number;
+    byteLength: number;
+    byteOffset: number | undefined;
+    byteStride: number;
+};
+export declare type Node = {
+    name: string;
+    mesh: number | undefined;
+    extensions: {
+        EXT_mesh_gpu_instancing: {
+            attributes: {
+                [key: string]: number;
+            };
+        } | undefined;
+    };
+};
+export declare type Mesh = {
+    primitives: Primitive[];
+    extras: {
+        [key: string]: any;
+    } | undefined;
+};
+export declare type Primitive = {
+    attributes: {
+        [key: string]: number;
+    };
+    indices: number;
+    extensions: {
+        KHR_draco_mesh_compression: {
+            attributes: {
+                [key: string]: number;
+            };
+            bufferView: number;
+        } | undefined;
+    };
+};
+export declare enum RevealGeometryCollectionType {
+    BoxCollection = 0,
+    CircleCollection = 1,
+    ConeCollection = 2,
+    EccentricConeCollection = 3,
+    EllipsoidSegmentCollection = 4,
+    GeneralCylinderCollection = 5,
+    GeneralRingCollection = 6,
+    QuadCollection = 7,
+    TorusSegmentCollection = 8,
+    TrapeziumCollection = 9,
+    NutCollection = 10,
+    TriangleMesh = 11,
+    InstanceMesh = 12
+}
+export declare type GlbHeaderData = {
+    json: GltfJson;
+    binContentLength: number;
+    byteOffsetToBinContent: number;
+};
+export declare type GeometryProcessingPayload = {
+    geometryType: RevealGeometryCollectionType;
+    bufferGeometry: THREE.InstancedBufferGeometry | THREE.BufferGeometry;
+    instancingExtension: {
+        attributes: {
+            [key: string]: number;
+        };
+    } | undefined;
+    meshId: number | undefined;
+    glbHeaderData: GlbHeaderData;
+    data: ArrayBuffer;
+};
+export declare type ParsedGeometry = {
+    type: RevealGeometryCollectionType;
+    geometryBuffer: THREE.BufferGeometry;
+    instanceId?: string;
+};

package/packages/tools/index.d.ts

@@ -1,15 +1,15 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-export { HtmlOverlayTool, HtmlOverlayOptions, HtmlOverlayPositionUpdatedDelegate, HtmlOverlayCreateClusterDelegate } from './src/HtmlOverlay/HtmlOverlayTool';
-export { ExplodedViewTool } from './src/ExplodedViewTool';
-export { DebugCameraTool } from './src/DebugCameraTool';
-export { AxisViewTool } from './src/AxisView/AxisViewTool';
-export { AxisBoxConfig, AxisBoxCompassConfig, AxisBoxFaceConfig, Corner, AbsolutePosition, RelativePosition } from './src/AxisView/types';
-export { GeomapTool } from './src/Geomap/GeomapTool';
-export { MapConfig, MapProviders, BingMapConfig, HereMapConfig, MapboxConfig, MapboxMode, MapboxStyle, MapboxImageFormat, BingMapType, BingMapImageFormat, HereMapType, HereMapScheme, HereMapImageFormat } from './src/Geomap/MapConfig';
-export { TimelineTool } from './src/Timeline/TimelineTool';
-export { Keyframe } from './src/Timeline/Keyframe';
-export { TimelineDateUpdateDelegate } from './src/Timeline/types';
-export { Cognite3DViewerToolBase } from './src/Cognite3DViewerToolBase';
-export { DebugLoadedSectorsTool, DebugLoadedSectorsToolOptions } from './src/DebugLoadedSectorsTool';
+/*!
+ * Copyright 2021 Cognite AS
+ */
+export { HtmlOverlayTool, HtmlOverlayOptions, HtmlOverlayPositionUpdatedDelegate, HtmlOverlayCreateClusterDelegate } from './src/HtmlOverlay/HtmlOverlayTool';
+export { ExplodedViewTool } from './src/ExplodedViewTool';
+export { DebugCameraTool } from './src/DebugCameraTool';
+export { AxisViewTool } from './src/AxisView/AxisViewTool';
+export { AxisBoxConfig, AxisBoxCompassConfig, AxisBoxFaceConfig, Corner, AbsolutePosition, RelativePosition } from './src/AxisView/types';
+export { TimelineTool } from './src/Timeline/TimelineTool';
+export { Keyframe } from './src/Timeline/Keyframe';
+export { TimelineDateUpdateDelegate } from './src/Timeline/types';
+export { Cognite3DViewerToolBase } from './src/Cognite3DViewerToolBase';
+export { MeasurementTool } from './src/Measurement/MeasurementTool';
+export { Measurement } from './src/Measurement/MeasurementManager';
+export { MeasurementOptions, MeasurementAddedDelegate, MeasurementStartedDelegate, MeasurementEndedDelegate } from './src/Measurement/types';

package/packages/tools/src/AxisView/AxisViewTool.d.ts

@@ -1,31 +1,31 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { Cognite3DViewerToolBase } from '../Cognite3DViewerToolBase';
-import { AxisBoxConfig } from './types';
-import { Cognite3DViewer } from '../../../../core';
-export declare class AxisViewTool extends Cognite3DViewerToolBase {
-    private readonly _layoutConfig;
-    private readonly _boxFaceGeometry;
-    private readonly _viewer;
-    private readonly _axisGroup;
-    private readonly _interactiveObjects;
-    private readonly _raycaster;
-    private readonly _screenPosition;
-    private readonly _disposeClickDiv;
-    private _dynamicUpdatePosition;
-    private readonly _updateClickDiv;
-    constructor(viewer: Cognite3DViewer, config?: AxisBoxConfig);
-    dispose(): void;
-    private createClickDiv;
-    private addAxisBoxToViewer;
-    private handleClick;
-    private createAxisCross;
-    private setupTransformOnRender;
-    private createBoxFaces;
-    private createCompass;
-    private createCompassTexture;
-    private getFaceTexture;
-    private createBoxFace;
-    private moveCameraTo;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { Cognite3DViewerToolBase } from '../Cognite3DViewerToolBase';
+import { AxisBoxConfig } from './types';
+import { Cognite3DViewer } from '../../../api';
+export declare class AxisViewTool extends Cognite3DViewerToolBase {
+    private readonly _layoutConfig;
+    private readonly _boxFaceGeometry;
+    private readonly _viewer;
+    private readonly _axisGroup;
+    private readonly _interactiveObjects;
+    private readonly _raycaster;
+    private readonly _screenPosition;
+    private readonly _disposeClickDiv;
+    private _dynamicUpdatePosition;
+    private readonly _updateClickDiv;
+    constructor(viewer: Cognite3DViewer, config?: AxisBoxConfig);
+    dispose(): void;
+    private createClickDiv;
+    private addAxisBoxToViewer;
+    private handleClick;
+    private createAxisCross;
+    private setupTransformOnRender;
+    private createBoxFaces;
+    private createCompass;
+    private createCompassTexture;
+    private getFaceTexture;
+    private createBoxFace;
+    private moveCameraTo;
+}

package/packages/tools/src/AxisView/types.d.ts

@@ -1,98 +1,98 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-/**
- * Configuration of {@link AxisViewTool}.
- */
-export declare type AxisBoxConfig = {
-    /**
-     * Size in pixels of the axis tool.
-     */
-    size?: number;
-    /**
-     * Position, either absolute or relative.
-     */
-    position?: AbsolutePosition | RelativePosition;
-    /**
-     * How long the camera animation lasts when
-     * clicking a face of the orientation box.
-     */
-    animationSpeed?: number;
-    /**
-     * Configuration for each of the faces of the orientation box.
-     * Note that Reveal uses a right-handed Y up coordinate system,
-     * which might differ from the original model space. To account
-     * for this, you might want to reassign labels of the faces.
-     */
-    faces?: {
-        xPositiveFace?: AxisBoxFaceConfig;
-        xNegativeFace?: AxisBoxFaceConfig;
-        yPositiveFace?: AxisBoxFaceConfig;
-        yNegativeFace?: AxisBoxFaceConfig;
-        zPositiveFace?: AxisBoxFaceConfig;
-        zNegativeFace?: AxisBoxFaceConfig;
-    };
-    /**
-     * Configuration of the compass "base" of the tool.
-     */
-    compass?: AxisBoxCompassConfig;
-};
-/**
- * Absolute position in pixels.
- */
-export declare type AbsolutePosition = {
-    xAbsolute: number;
-    yAbsolute: number;
-};
-/**
- * Relative position from a corner of the viewer
- * and a given padding.
- */
-export declare type RelativePosition = {
-    corner: Corner;
-    padding: THREE.Vector2;
-};
-/**
- * Configuration of each face of the orientation box.
- */
-export declare type AxisBoxFaceConfig = {
-    /**
-     * Label of the respective face, e.g. 'X' or 'Right'.
-     */
-    label?: string;
-    fontSize?: number;
-    fontColor?: THREE.Color;
-    outlineSize?: number;
-    outlineColor?: THREE.Color;
-    faceColor?: THREE.Color;
-};
-/**
- * Configuration of the compass.
- */
-export declare type AxisBoxCompassConfig = {
-    /**
-     * Label of the orientation indicator. Defaults
-     * to 'N' for north.
-     */
-    ringLabel?: string;
-    /**
-     * Offset in radians of the orientation indicator.
-     */
-    labelDelta?: number;
-    fontSize?: number;
-    fontColor?: THREE.Color;
-    tickColor?: THREE.Color;
-};
-/**
- * A corner of the viewer.
- */
-export declare enum Corner {
-    TopRight = 0,
-    TopLeft = 1,
-    BottomLeft = 2,
-    BottomRight = 3
-}
-export declare const defaultAxisBoxCompassConfig: AxisBoxCompassConfig;
-export declare const defaultFaceConfig: AxisBoxFaceConfig;
-export declare const defaultAxisBoxConfig: Required<AxisBoxConfig>;
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+/**
+ * Configuration of {@link AxisViewTool}.
+ */
+export declare type AxisBoxConfig = {
+    /**
+     * Size in pixels of the axis tool.
+     */
+    size?: number;
+    /**
+     * Position, either absolute or relative.
+     */
+    position?: AbsolutePosition | RelativePosition;
+    /**
+     * How long the camera animation lasts when
+     * clicking a face of the orientation box.
+     */
+    animationSpeed?: number;
+    /**
+     * Configuration for each of the faces of the orientation box.
+     * Note that Reveal uses a right-handed Y up coordinate system,
+     * which might differ from the original model space. To account
+     * for this, you might want to reassign labels of the faces.
+     */
+    faces?: {
+        xPositiveFace?: AxisBoxFaceConfig;
+        xNegativeFace?: AxisBoxFaceConfig;
+        yPositiveFace?: AxisBoxFaceConfig;
+        yNegativeFace?: AxisBoxFaceConfig;
+        zPositiveFace?: AxisBoxFaceConfig;
+        zNegativeFace?: AxisBoxFaceConfig;
+    };
+    /**
+     * Configuration of the compass "base" of the tool.
+     */
+    compass?: AxisBoxCompassConfig;
+};
+/**
+ * Absolute position in pixels.
+ */
+export declare type AbsolutePosition = {
+    xAbsolute: number;
+    yAbsolute: number;
+};
+/**
+ * Relative position from a corner of the viewer
+ * and a given padding.
+ */
+export declare type RelativePosition = {
+    corner: Corner;
+    padding: THREE.Vector2;
+};
+/**
+ * Configuration of each face of the orientation box.
+ */
+export declare type AxisBoxFaceConfig = {
+    /**
+     * Label of the respective face, e.g. 'X' or 'Right'.
+     */
+    label?: string;
+    fontSize?: number;
+    fontColor?: THREE.Color;
+    outlineSize?: number;
+    outlineColor?: THREE.Color;
+    faceColor?: THREE.Color;
+};
+/**
+ * Configuration of the compass.
+ */
+export declare type AxisBoxCompassConfig = {
+    /**
+     * Label of the orientation indicator. Defaults
+     * to 'N' for north.
+     */
+    ringLabel?: string;
+    /**
+     * Offset in radians of the orientation indicator.
+     */
+    labelDelta?: number;
+    fontSize?: number;
+    fontColor?: THREE.Color;
+    tickColor?: THREE.Color;
+};
+/**
+ * A corner of the viewer.
+ */
+export declare enum Corner {
+    TopRight = 0,
+    TopLeft = 1,
+    BottomLeft = 2,
+    BottomRight = 3
+}
+export declare const defaultAxisBoxCompassConfig: AxisBoxCompassConfig;
+export declare const defaultFaceConfig: AxisBoxFaceConfig;
+export declare const defaultAxisBoxConfig: Required<AxisBoxConfig>;

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 {@link 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 { Cognite3DViewerToolBase } from './Cognite3DViewerToolBase';
+import { Cognite3DViewer } from '../../api';
+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;
+}