@cognite/reveal 3.0.2 → 3.2.0

package/packages/rendering/src/rendering/shaders.d.ts

@@ -1,101 +1,100 @@
-/*!
- * 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;
-};
+/*!
+ * 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;
+    };
+};
+/**
+ * Point cloud shaders.
+ */
+export declare const pointCloudShaders: {
+    normalize: {
+        fragment: string;
+        vertex: string;
+    };
+};
+/**
+ * Screen space ambient occlusion shader
+ */
+export declare const ssaoShaders: {
+    fragment: string;
+    vertex: string;
+};
+export declare const blitShaders: {
+    fragment: string;
+    vertex: string;
+};
+export declare const depthBlendBlitShaders: {
+    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/rendering/src/rendering/types.d.ts

@@ -1,76 +1,89 @@
-/*!
- * 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;
-};
+/*!
+ * 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;
+    /**
+     * Point cloud effects parameters.
+     */
+    pointCloudParameters?: PointCloudParameters;
+};
+/**
+ * SSAO rendering quality modes supported by Reveal.
+ */
+export declare enum SsaoSampleQuality {
+    Medium = 32,
+    High = 64,
+    VeryHigh = 128,
+    None = 0,
+    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;
+};
+/**
+ * Point cloud rendering parameters supported by Reveal.
+ */
+export declare type PointCloudParameters = {
+    /**
+     * Effect of blending close points together. Creates smoother texture on object surfaces.
+     */
+    pointBlending: boolean;
+};

package/packages/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/rendering/src/transform/NodeTransformTextureBuilder.d.ts

@@ -1,23 +1,24 @@
-/*!
- * 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;
-}
+/*!
+ * 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;
+    private readonly _transformOverrideIndexBufferView;
+    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/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 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;
-}
+/*!
+ * 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 NUMBER_OF_ROWS_PER_MATRIX;
+    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/renderUtilities.d.ts

@@ -0,0 +1,29 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+import * as THREE from 'three';
+import { CadMaterialManager } from '../CadMaterialManager';
+import { BlitOptions, DepthBlendBlitOptions, PointCloudPostProcessingOptions } from '../render-passes/types';
+export declare const unitOrthographicCamera: THREE.OrthographicCamera;
+export declare function createFullScreenTriangleMesh(shaderMaterial: THREE.RawShaderMaterial): THREE.Mesh;
+export declare function createRenderTarget(width?: number, height?: number, multiSampleCount?: number): THREE.WebGLRenderTarget;
+export declare function getDepthBlendBlitMaterial(options: DepthBlendBlitOptions): THREE.RawShaderMaterial;
+export declare function getBlitMaterial(options: BlitOptions): THREE.RawShaderMaterial;
+export declare function getPointCloudPostProcessingMaterial(options: PointCloudPostProcessingOptions): THREE.RawShaderMaterial;
+export declare enum RenderLayer {
+    Back = 1,
+    InFront = 6,
+    Ghost = 7,
+    PointCloud = 8,
+    Default = 0
+}
+export declare function setupCadModelsGeometryLayers(materialManager: CadMaterialManager, cadModels?: {
+    object: THREE.Object3D<THREE.Event>;
+    modelIdentifier: string;
+}[]): void;
+export declare function getLayerMask(renderLayer: number): number;
+export declare function hasStyledNodes(modelIdentifiers: string[], materialManager: CadMaterialManager): {
+    back: boolean;
+    inFront: boolean;
+    ghost: boolean;
+};

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

@@ -1,26 +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;
-}
+/*!
+ * 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/sector-loader/index.d.ts

@@ -1,6 +1,6 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-export { SectorRepository } from './src/SectorRepository';
-export { V8SectorRepository } from './src/V8SectorRepository';
-export { GltfSectorRepository } from './src/GltfSectorRepository';
+/*!
+ * Copyright 2021 Cognite AS
+ */
+export { SectorRepository } from './src/SectorRepository';
+export { V8SectorRepository } from './src/V8SectorRepository';
+export { GltfSectorRepository } from './src/GltfSectorRepository';

package/packages/sector-loader/src/GltfSectorLoader.d.ts

@@ -1,12 +1,12 @@
-import { ConsumedSector, WantedSector } from '../../cad-parsers';
-import { BinaryFileProvider } from '../../modeldata-api';
-import { CadMaterialManager } from '../../rendering';
-export declare class GltfSectorLoader {
-    private readonly _gltfSectorParser;
-    private readonly _sectorFileProvider;
-    private readonly _materialManager;
-    constructor(sectorFileProvider: BinaryFileProvider, materialManager: CadMaterialManager);
-    loadSector(sector: WantedSector): Promise<ConsumedSector>;
-    private createTreeIndexSet;
-    private createMesh;
-}
+import { ConsumedSector, WantedSector } from '../../cad-parsers';
+import { BinaryFileProvider } from '../../modeldata-api';
+import { CadMaterialManager } from '../../rendering';
+export declare class GltfSectorLoader {
+    private readonly _gltfSectorParser;
+    private readonly _sectorFileProvider;
+    private readonly _materialManager;
+    constructor(sectorFileProvider: BinaryFileProvider, materialManager: CadMaterialManager);
+    loadSector(sector: WantedSector): Promise<ConsumedSector>;
+    private createTreeIndexSet;
+    private createMesh;
+}

package/packages/sector-loader/src/GltfSectorRepository.d.ts

@@ -1,19 +1,19 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { ConsumedSector, WantedSector } from '../../cad-parsers';
-import { BinaryFileProvider } from '../../modeldata-api';
-import { CadMaterialManager } from '../../rendering';
-import { SectorRepository } from './SectorRepository';
-export declare class GltfSectorRepository implements SectorRepository {
-    private readonly _gltfSectorLoader;
-    private readonly _gltfCache;
-    constructor(sectorFileProvider: BinaryFileProvider, materialManager: CadMaterialManager);
-    private getEmptySectorWithLod;
-    private getEmptyDetailedSector;
-    private getEmptyDiscardedSector;
-    loadSector(sector: WantedSector): Promise<ConsumedSector>;
-    setCacheSize(sectorCount: number): void;
-    clearCache(): void;
-    private wantedSectorCacheKey;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { ConsumedSector, WantedSector } from '../../cad-parsers';
+import { BinaryFileProvider } from '../../modeldata-api';
+import { CadMaterialManager } from '../../rendering';
+import { SectorRepository } from './SectorRepository';
+export declare class GltfSectorRepository implements SectorRepository {
+    private readonly _gltfSectorLoader;
+    private readonly _gltfCache;
+    constructor(sectorFileProvider: BinaryFileProvider, materialManager: CadMaterialManager);
+    private getEmptySectorWithLod;
+    private getEmptyDetailedSector;
+    private getEmptyDiscardedSector;
+    loadSector(sector: WantedSector): Promise<ConsumedSector>;
+    setCacheSize(sectorCount: number): void;
+    clearCache(): void;
+    private wantedSectorCacheKey;
+}