@cognite/reveal 2.1.2 → 2.2.0

package/packages/{cad-parsers/src/cad → rendering/src/rendering}/shaders.d.ts

@@ -1,101 +1,101 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-/**
- * Defines used to enable debugging features in shaders.
- */
-export declare const shaderDefines: {
-    defines: {
-        COGNITE_COLOR_BY_TREE_INDEX: boolean;
-    };
-};
-export declare const sectorShaders: {
-    simpleMesh: {
-        fragment: string;
-        vertex: string;
-    };
-    detailedMesh: {
-        fragment: string;
-        vertex: string;
-    };
-    instancedMesh: {
-        fragment: string;
-        vertex: string;
-    };
-    boxPrimitive: {
-        fragment: string;
-        vertex: string;
-    };
-    circlePrimitive: {
-        fragment: string;
-        vertex: string;
-    };
-    conePrimitive: {
-        fragment: string;
-        vertex: string;
-    };
-    eccentricConePrimitive: {
-        fragment: string;
-        vertex: string;
-    };
-    ellipsoidSegmentPrimitive: {
-        fragment: string;
-        vertex: string;
-    };
-    generalCylinderPrimitive: {
-        fragment: string;
-        vertex: string;
-    };
-    generalRingPrimitive: {
-        fragment: string;
-        vertex: string;
-    };
-    nutPrimitive: {
-        fragment: string;
-        vertex: string;
-    };
-    quadPrimitive: {
-        fragment: string;
-        vertex: string;
-    };
-    torusSegmentPrimitive: {
-        fragment: string;
-        vertex: string;
-    };
-    trapeziumPrimitive: {
-        fragment: string;
-        vertex: string;
-    };
-};
-export declare const outlineDetectionShaders: {
-    fragment: string;
-    vertex: string;
-};
-/**
- * FXAA anti-aliasing shader
- */
-export declare const fxaaShaders: {
-    fragment: string;
-    vertex: string;
-};
-/**
- * Screen space ambient occlusion shader
- */
-export declare const ssaoShaders: {
-    fragment: string;
-    vertex: string;
-};
-/**
- * Shader to blur ambient occlusion texture and combine with diffuse
- */
-export declare const ssaoBlurCombineShaders: {
-    fragment: string;
-    vertex: string;
-};
-/**
- * Shaders use to estimate how many pixels a sector covers on screen.
- */
-export declare const coverageShaders: {
-    fragment: string;
-    vertex: string;
-};
+/*!
+ * Copyright 2021 Cognite AS
+ */
+/**
+ * Defines used to enable debugging features in shaders.
+ */
+export declare const shaderDefines: {
+    defines: {
+        COGNITE_COLOR_BY_TREE_INDEX: boolean;
+    };
+};
+export declare const sectorShaders: {
+    simpleMesh: {
+        fragment: string;
+        vertex: string;
+    };
+    detailedMesh: {
+        fragment: string;
+        vertex: string;
+    };
+    instancedMesh: {
+        fragment: string;
+        vertex: string;
+    };
+    boxPrimitive: {
+        fragment: string;
+        vertex: string;
+    };
+    circlePrimitive: {
+        fragment: string;
+        vertex: string;
+    };
+    conePrimitive: {
+        fragment: string;
+        vertex: string;
+    };
+    eccentricConePrimitive: {
+        fragment: string;
+        vertex: string;
+    };
+    ellipsoidSegmentPrimitive: {
+        fragment: string;
+        vertex: string;
+    };
+    generalCylinderPrimitive: {
+        fragment: string;
+        vertex: string;
+    };
+    generalRingPrimitive: {
+        fragment: string;
+        vertex: string;
+    };
+    nutPrimitive: {
+        fragment: string;
+        vertex: string;
+    };
+    quadPrimitive: {
+        fragment: string;
+        vertex: string;
+    };
+    torusSegmentPrimitive: {
+        fragment: string;
+        vertex: string;
+    };
+    trapeziumPrimitive: {
+        fragment: string;
+        vertex: string;
+    };
+};
+export declare const outlineDetectionShaders: {
+    fragment: string;
+    vertex: string;
+};
+/**
+ * FXAA anti-aliasing shader
+ */
+export declare const fxaaShaders: {
+    fragment: string;
+    vertex: string;
+};
+/**
+ * Screen space ambient occlusion shader
+ */
+export declare const ssaoShaders: {
+    fragment: string;
+    vertex: string;
+};
+/**
+ * Full one-pass SSAO blur shader
+ */
+export declare const ssaoBlurCombineShaders: {
+    fragment: string;
+    vertex: string;
+};
+/**
+ * Shaders use to estimate how many pixels a sector covers on screen.
+ */
+export declare const coverageShaders: {
+    fragment: string;
+    vertex: string;
+};

package/packages/{cad-geometry-loaders/src/material-manager → rendering/src}/rendering/types.d.ts

@@ -1,76 +1,76 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-export { SectorQuads } from '@cognite/reveal-parser-worker';
-/**
- * Anti-aliasing modes supported by Reveal.
- */
-export declare enum AntiAliasingMode {
-    /**
-     * No anti-aliasing (0).
-     */
-    NoAA = 0,
-    /**
-     * Fast-approximate anti-aliasing (FXAA) (1).
-     */
-    FXAA = 1
-}
-/**
- * Options and hints for how the Reveal viewer applies rendering effects.
- */
-export declare type RenderOptions = {
-    /**
-     * Anti-aliasing mode used to avoid aliasing effects in the rendered view.
-     */
-    antiAliasing?: AntiAliasingMode;
-    /**
-     * When provided, Reveal will use multi-sampling to reduce aliasing effects when WebGL 2 is
-     * available. Ignored if using WebGL 1.
-     */
-    multiSampleCountHint?: number;
-    /**
-     * Determines the parameters used for ambient occlusion heuristic shading.
-     */
-    ssaoRenderParameters?: SsaoParameters;
-    /**
-     * Determines the parameters used for visualizing edges of the geometry.
-     */
-    edgeDetectionParameters?: EdgeDetectionParameters;
-};
-/**
- * SSAO rendering quality modes supported by Reveal.
- */
-export declare enum SsaoSampleQuality {
-    Medium = 32,
-    High = 64,
-    VeryHigh = 128,
-    None = 1,
-    Default = 32
-}
-/**
- * Defaults for {@ref RevealRenderOptions}.
- */
-export declare const defaultRenderOptions: Required<RenderOptions>;
-/**
- * Edge detection parameters supported by Reveal.
- */
-export declare type EdgeDetectionParameters = {
-    enabled: boolean;
-};
-/**
- * Screen-space ambient occlusion parameters supported by Reveal.
- */
-export declare type SsaoParameters = {
-    /**
-     * Quality (Number of samples) to estimate occlusion factor.
-     */
-    sampleSize: SsaoSampleQuality;
-    /**
-     * Maximum length of sample vector.
-     */
-    sampleRadius: number;
-    /**
-     * Applied bias when depth testing to reduce output noise.
-     */
-    depthCheckBias: number;
-};
+/*!
+ * Copyright 2021 Cognite AS
+ */
+export { SectorQuads } from '@cognite/reveal-parser-worker';
+/**
+ * Anti-aliasing modes supported by Reveal.
+ */
+export declare enum AntiAliasingMode {
+    /**
+     * No anti-aliasing (0).
+     */
+    NoAA = 0,
+    /**
+     * Fast-approximate anti-aliasing (FXAA) (1).
+     */
+    FXAA = 1
+}
+/**
+ * Options and hints for how the Reveal viewer applies rendering effects.
+ */
+export declare type RenderOptions = {
+    /**
+     * Anti-aliasing mode used to avoid aliasing effects in the rendered view.
+     */
+    antiAliasing?: AntiAliasingMode;
+    /**
+     * When provided, Reveal will use multi-sampling to reduce aliasing effects when WebGL 2 is
+     * available. Ignored if using WebGL 1.
+     */
+    multiSampleCountHint?: number;
+    /**
+     * Determines the parameters used for ambient occlusion heuristic shading.
+     */
+    ssaoRenderParameters?: SsaoParameters;
+    /**
+     * Determines the parameters used for visualizing edges of the geometry.
+     */
+    edgeDetectionParameters?: EdgeDetectionParameters;
+};
+/**
+ * SSAO rendering quality modes supported by Reveal.
+ */
+export declare enum SsaoSampleQuality {
+    Medium = 32,
+    High = 64,
+    VeryHigh = 128,
+    None = 1,
+    Default = 32
+}
+/**
+ * Defaults for {@ref RevealRenderOptions}.
+ */
+export declare const defaultRenderOptions: Required<RenderOptions>;
+/**
+ * Edge detection parameters supported by Reveal.
+ */
+export declare type EdgeDetectionParameters = {
+    enabled: boolean;
+};
+/**
+ * Screen-space ambient occlusion parameters supported by Reveal.
+ */
+export declare type SsaoParameters = {
+    /**
+     * Quality (Number of samples) tond estimate occlusion factor.
+     */
+    sampleSize: SsaoSampleQuality;
+    /**
+     * Maximum length of sample vector.
+     */
+    sampleRadius: number;
+    /**
+     * Applied bias when depth testing to reduce output noise.
+     */
+    depthCheckBias: number;
+};

package/packages/{cad-geometry-loaders/src → rendering/src/sector}/CadNode.d.ts

@@ -1,54 +1,54 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-import { SectorQuads } from './material-manager/rendering/types';
-import { RootSectorNode } from './sector/RootSectorNode';
-import { CadMaterialManager } from './material-manager/CadMaterialManager';
-import { NodeTransformProvider } from './material-manager/styling/NodeTransformProvider';
-import { SectorScene, CadModelMetadata, RenderMode, SectorGeometry, InstancedMeshFile } from '../../cad-parsers';
-import { NodeAppearanceProvider, NodeAppearance } from '../../cad-styling';
-export declare type ParseCallbackDelegate = (parsed: {
-    lod: string;
-    data: SectorGeometry | SectorQuads;
-}) => void;
-export interface SuggestedCameraConfig {
-    position: THREE.Vector3;
-    target: THREE.Vector3;
-    near: number;
-    far: number;
-}
-export declare class CadNode extends THREE.Object3D {
-    private readonly _rootSector;
-    private readonly _cadModelMetadata;
-    private readonly _materialManager;
-    private readonly _sectorScene;
-    private readonly _previousCameraMatrix;
-    private readonly _instancedMeshManager;
-    constructor(model: CadModelMetadata, materialManager: CadMaterialManager);
-    get nodeTransformProvider(): NodeTransformProvider;
-    get nodeAppearanceProvider(): NodeAppearanceProvider;
-    get defaultNodeAppearance(): NodeAppearance;
-    set defaultNodeAppearance(appearance: NodeAppearance);
-    get clippingPlanes(): THREE.Plane[];
-    set clippingPlanes(planes: THREE.Plane[]);
-    get cadModelMetadata(): CadModelMetadata;
-    get sectorScene(): SectorScene;
-    get rootSector(): RootSectorNode;
-    get materialManager(): CadMaterialManager;
-    set renderMode(mode: RenderMode);
-    get renderMode(): RenderMode;
-    /**
-     * Sets transformation matrix of the model. This overrides the current transformation.
-     * @param matrix Transformation matrix.
-     */
-    setModelTransformation(matrix: THREE.Matrix4): void;
-    /**
-     * Gets transformation matrix of the model
-     * @param out Preallocated `THREE.Matrix4` (optional).
-     */
-    getModelTransformation(out?: THREE.Matrix4): THREE.Matrix4;
-    suggestCameraConfig(): SuggestedCameraConfig;
-    updateInstancedMeshes(instanceMeshFiles: InstancedMeshFile[], modelIdentifier: string, sectorId: number): void;
-    discardInstancedMeshes(sectorId: number): void;
-}
+/**
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+import { CadMaterialManager } from '../CadMaterialManager';
+import { SectorQuads } from '../rendering/types';
+import { NodeTransformProvider } from '../transform/NodeTransformProvider';
+import { RenderMode } from '../rendering/RenderMode';
+import { NodeAppearanceProvider, NodeAppearance } from '../../../cad-styling';
+import { SectorScene, CadModelMetadata, SectorGeometry, InstancedMeshFile, RootSectorNode } from '../../../cad-parsers';
+export declare type ParseCallbackDelegate = (parsed: {
+    lod: string;
+    data: SectorGeometry | SectorQuads;
+}) => void;
+export interface SuggestedCameraConfig {
+    position: THREE.Vector3;
+    target: THREE.Vector3;
+    near: number;
+    far: number;
+}
+export declare class CadNode extends THREE.Object3D {
+    private readonly _rootSector;
+    private readonly _cadModelMetadata;
+    private readonly _materialManager;
+    private readonly _sectorScene;
+    private readonly _previousCameraMatrix;
+    private readonly _instancedMeshManager;
+    constructor(model: CadModelMetadata, materialManager: CadMaterialManager);
+    get nodeTransformProvider(): NodeTransformProvider;
+    get nodeAppearanceProvider(): NodeAppearanceProvider;
+    get defaultNodeAppearance(): NodeAppearance;
+    set defaultNodeAppearance(appearance: NodeAppearance);
+    get clippingPlanes(): THREE.Plane[];
+    set clippingPlanes(planes: THREE.Plane[]);
+    get cadModelMetadata(): CadModelMetadata;
+    get sectorScene(): SectorScene;
+    get rootSector(): RootSectorNode;
+    get materialManager(): CadMaterialManager;
+    set renderMode(mode: RenderMode);
+    get renderMode(): RenderMode;
+    /**
+     * Sets transformation matrix of the model. This overrides the current transformation.
+     * @param matrix Transformation matrix.
+     */
+    setModelTransformation(matrix: THREE.Matrix4): void;
+    /**
+     * Gets transformation matrix of the model
+     * @param out Preallocated `THREE.Matrix4` (optional).
+     */
+    getModelTransformation(out?: THREE.Matrix4): THREE.Matrix4;
+    suggestCameraConfig(): SuggestedCameraConfig;
+    updateInstancedMeshes(instanceMeshFiles: InstancedMeshFile[], modelIdentifier: string, sectorId: number): void;
+    discardInstancedMeshes(sectorId: number): void;
+}

package/packages/{cad-geometry-loaders/src/material-manager/styling → rendering/src/transform}/NodeTransformProvider.d.ts

@@ -1,13 +1,13 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-import { NumericRange } from '../../../../utilities';
-export declare type NodeTransformChangeEventDelegate = (change: 'set' | 'reset', treeIndices: NumericRange, transform: THREE.Matrix4) => void;
-export declare class NodeTransformProvider {
-    private readonly _events;
-    on(event: 'changed', listener: NodeTransformChangeEventDelegate): void;
-    off(event: 'changed', listener: NodeTransformChangeEventDelegate): void;
-    setNodeTransform(treeIndices: NumericRange, transform: THREE.Matrix4): void;
-    resetNodeTransform(treeIndices: NumericRange): void;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+import { NumericRange } from '../../../utilities';
+export declare type NodeTransformChangeEventDelegate = (change: 'set' | 'reset', treeIndices: NumericRange, transform: THREE.Matrix4) => void;
+export declare class NodeTransformProvider {
+    private readonly _events;
+    on(event: 'changed', listener: NodeTransformChangeEventDelegate): void;
+    off(event: 'changed', listener: NodeTransformChangeEventDelegate): void;
+    setNodeTransform(treeIndices: NumericRange, transform: THREE.Matrix4): void;
+    resetNodeTransform(treeIndices: NumericRange): void;
+}

package/packages/{cad-geometry-loaders/src/material-manager/styling → rendering/src/transform}/NodeTransformTextureBuilder.d.ts

@@ -1,23 +1,23 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-import { NodeTransformProvider } from './NodeTransformProvider';
-export declare class NodeTransformTextureBuilder {
-    private readonly _transformProvider;
-    private readonly _transformOverrideBuffer;
-    private readonly _transformOverrideIndexTexture;
-    private _needsUpdate;
-    private _handleTransformChangedBound;
-    constructor(treeIndexCount: number, transformProvider: NodeTransformProvider);
-    dispose(): void;
-    get needsUpdate(): boolean;
-    get overrideTransformIndexTexture(): THREE.DataTexture;
-    get transformLookupTexture(): THREE.DataTexture;
-    build(): void;
-    private setNodeTransform;
-    private resetNodeTransform;
-    private setOverrideIndex;
-    private handleNewTransformTexture;
-    private handleTransformChanged;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+import { NodeTransformProvider } from './NodeTransformProvider';
+export declare class NodeTransformTextureBuilder {
+    private readonly _transformProvider;
+    private readonly _transformOverrideBuffer;
+    private readonly _transformOverrideIndexTexture;
+    private _needsUpdate;
+    private readonly _handleTransformChangedBound;
+    constructor(treeIndexCount: number, transformProvider: NodeTransformProvider);
+    dispose(): void;
+    get needsUpdate(): boolean;
+    get overrideTransformIndexTexture(): THREE.DataTexture;
+    get transformLookupTexture(): THREE.DataTexture;
+    build(): void;
+    private setNodeTransform;
+    private resetNodeTransform;
+    private setOverrideIndex;
+    private handleNewTransformTexture;
+    private handleTransformChanged;
+}

package/packages/{cad-geometry-loaders/src/material-manager/styling → rendering/src/transform}/TransformOverrideBuffer.d.ts

@@ -1,21 +1,21 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-export declare class TransformOverrideBuffer {
-    private static readonly MIN_NUMBER_OF_TREE_INDICES;
-    private static readonly NUMBER_OF_ELEMENTS_PER_MATRIX;
-    private static readonly BYTES_PER_FLOAT;
-    private _dataTexture;
-    private _textureBuffer;
-    private _unusedIndices;
-    private _treeIndexToOverrideIndex;
-    private _onGenerateNewDataTextureCallback;
-    get dataTexture(): THREE.DataTexture;
-    get overrideIndices(): Map<number, number>;
-    constructor(onGenerateNewDataTexture: (datatexture: THREE.DataTexture) => void);
-    dispose(): void;
-    addOverrideTransform(treeIndex: number, transform: THREE.Matrix4): number;
-    removeOverrideTransform(treeIndex: number): void;
-    private recomputeDataTexture;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+export declare class TransformOverrideBuffer {
+    private static readonly MIN_NUMBER_OF_TREE_INDICES;
+    private static readonly NUMBER_OF_ELEMENTS_PER_MATRIX;
+    private static readonly BYTES_PER_FLOAT;
+    private _dataTexture;
+    private _textureBuffer;
+    private readonly _unusedIndices;
+    private readonly _treeIndexToOverrideIndex;
+    private readonly _onGenerateNewDataTextureCallback;
+    get dataTexture(): THREE.DataTexture;
+    get overrideIndices(): Map<number, number>;
+    constructor(onGenerateNewDataTexture: (datatexture: THREE.DataTexture) => void);
+    dispose(): void;
+    addOverrideTransform(treeIndex: number, transform: THREE.Matrix4): number;
+    removeOverrideTransform(treeIndex: number): void;
+    private recomputeDataTexture;
+}

package/packages/rendering/src/utilities/types.d.ts

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

package/packages/tools/index.d.ts

@@ -1,12 +1,15 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-export { HtmlOverlayTool, HtmlOverlayOptions } from './src/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 { 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 { 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';