@cognite/reveal 2.2.2 → 2.3.0

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

@@ -1,99 +1,99 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-import { CadMaterialManager } from '../CadMaterialManager';
-import { RenderOptions } from './types';
-export declare class EffectRenderManager {
-    private readonly _materialManager;
-    private readonly _orthographicCamera;
-    private readonly _originalScene;
-    private readonly _compositionScene;
-    private readonly _fxaaScene;
-    private readonly _ssaoScene;
-    private readonly _ssaoBlurCombineScene;
-    private readonly _cadScene;
-    private readonly _normalScene;
-    private readonly _inFrontScene;
-    private readonly _emptyScene;
-    private readonly _normalSceneBuilder;
-    private readonly _inFrontSceneBuilder;
-    private _renderOptions;
-    private readonly _combineOutlineDetectionMaterial;
-    private readonly _fxaaMaterial;
-    private _ssaoMaterial;
-    private readonly _ssaoBlurCombineMaterial;
-    private readonly _customObjectRenderTarget;
-    private readonly _ghostObjectRenderTarget;
-    private readonly _normalRenderedCadModelTarget;
-    private readonly _inFrontRenderedCadModelTarget;
-    private readonly _compositionTarget;
-    private readonly _ssaoTarget;
-    private readonly _ssaoBlurCombineTarget;
-    /**
-     * Holds state of how the last frame was rendered by `render()`. This is used to explicit clear
-     * WebGL2 render targets which might cause geometry to "get stuck" after e.g. removing models.
-     */
-    private _lastFrameSceneState;
-    private readonly _rootSectorNodeBuffer;
-    private readonly _outlineTexelSize;
-    private readonly _renderer;
-    private _renderTarget;
-    private _autoSetTargetSize;
-    private _debugRenderTimings;
-    private _uiObjects;
-    set renderOptions(options: RenderOptions);
-    set debugRenderTimings(logTimings: boolean);
-    get debugRenderTimings(): boolean;
-    addUiObject(object: THREE.Object3D, screenPos: THREE.Vector2, size: THREE.Vector2): void;
-    removeUiObject(object: THREE.Object3D): void;
-    private ssaoParameters;
-    private get antiAliasingMode();
-    private get multiSampleCountHint();
-    constructor(renderer: THREE.WebGLRenderer, scene: THREE.Scene, materialManager: CadMaterialManager, options: RenderOptions);
-    private supportsSsao;
-    renderDetailedToDepthOnly(camera: THREE.PerspectiveCamera): void;
-    render(camera: THREE.PerspectiveCamera): void;
-    private restoreCadNodes;
-    private extractCadNodes;
-    setRenderTarget(target: THREE.WebGLRenderTarget | null): void;
-    getRenderTarget(): THREE.WebGLRenderTarget | null;
-    setRenderTargetAutoSize(autoSize: boolean): void;
-    getRenderTargetAutoSize(): boolean;
-    private clearTarget;
-    private explicitFlushRender;
-    private splitToScenes;
-    private renderNormalCadModels;
-    private renderNormalCadModelsFromBaseScene;
-    private renderInFrontCadModels;
-    private renderGhostedCadModelsFromBaseScene;
-    private renderCustomObjects;
-    private updateRenderSize;
-    private renderComposition;
-    private setSsaoParameters;
-    private renderPostProcessStep;
-    private renderSsao;
-    private renderStep;
-    private readonly _deepFlushRendererArgs;
-    private deepFlushRenderer;
-    private createOutlineColorTexture;
-    private setupCompositionScene;
-    private setupFxaaScene;
-    private setupSsaoScene;
-    private setupSsaoBlurCombineScene;
-    private createKernel;
-    private createRenderTriangle;
-    private traverseForRootSectorNode;
-    private setVisibilityOfSectors;
-    /**
-     * Assign SpectorJS metadata containing names for the render targets when running Reveal
-     * in development mode.
-     */
-    private setupRenderTargetSpectorDebugging;
-    /**
-     * Assigns SpectorJS metadata to the current framebuffer (render target).
-     * This is useful to assign e.g. names to framebuffers to easy debugging in SpectorJS. The metadata
-     * will be visible in 'bindFramebuffer'-commands in the SpectorJS report.
-     */
-    private assignSpectorJsMetadataToRenderTarget;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+import { CadMaterialManager } from '../CadMaterialManager';
+import { RenderOptions } from './types';
+export declare class EffectRenderManager {
+    private readonly _materialManager;
+    private readonly _orthographicCamera;
+    private readonly _originalScene;
+    private readonly _compositionScene;
+    private readonly _fxaaScene;
+    private readonly _ssaoScene;
+    private readonly _ssaoBlurCombineScene;
+    private readonly _cadScene;
+    private readonly _normalScene;
+    private readonly _inFrontScene;
+    private readonly _emptyScene;
+    private readonly _normalSceneBuilder;
+    private readonly _inFrontSceneBuilder;
+    private _renderOptions;
+    private readonly _combineOutlineDetectionMaterial;
+    private readonly _fxaaMaterial;
+    private _ssaoMaterial;
+    private readonly _ssaoBlurCombineMaterial;
+    private readonly _customObjectRenderTarget;
+    private readonly _ghostObjectRenderTarget;
+    private readonly _normalRenderedCadModelTarget;
+    private readonly _inFrontRenderedCadModelTarget;
+    private readonly _compositionTarget;
+    private readonly _ssaoTarget;
+    private readonly _ssaoBlurCombineTarget;
+    /**
+     * Holds state of how the last frame was rendered by `render()`. This is used to explicit clear
+     * WebGL2 render targets which might cause geometry to "get stuck" after e.g. removing models.
+     */
+    private _lastFrameSceneState;
+    private readonly _rootSectorNodeBuffer;
+    private readonly _outlineTexelSize;
+    private readonly _renderer;
+    private _renderTarget;
+    private _autoSetTargetSize;
+    private _debugRenderTimings;
+    private _uiObjects;
+    set renderOptions(options: RenderOptions);
+    set debugRenderTimings(logTimings: boolean);
+    get debugRenderTimings(): boolean;
+    addUiObject(object: THREE.Object3D, screenPos: THREE.Vector2, size: THREE.Vector2): void;
+    removeUiObject(object: THREE.Object3D): void;
+    private ssaoParameters;
+    private get antiAliasingMode();
+    private get multiSampleCountHint();
+    constructor(renderer: THREE.WebGLRenderer, scene: THREE.Scene, materialManager: CadMaterialManager, options: RenderOptions);
+    private supportsSsao;
+    renderDetailedToDepthOnly(camera: THREE.PerspectiveCamera): void;
+    render(camera: THREE.PerspectiveCamera): void;
+    private restoreCadNodes;
+    private extractCadNodes;
+    setRenderTarget(target: THREE.WebGLRenderTarget | null): void;
+    getRenderTarget(): THREE.WebGLRenderTarget | null;
+    setRenderTargetAutoSize(autoSize: boolean): void;
+    getRenderTargetAutoSize(): boolean;
+    private clearTarget;
+    private explicitFlushRender;
+    private splitToScenes;
+    private renderNormalCadModels;
+    private renderNormalCadModelsFromBaseScene;
+    private renderInFrontCadModels;
+    private renderGhostedCadModelsFromBaseScene;
+    private renderCustomObjects;
+    private updateRenderSize;
+    private renderComposition;
+    private setSsaoParameters;
+    private renderPostProcessStep;
+    private renderSsao;
+    private renderStep;
+    private readonly _deepFlushRendererArgs;
+    private deepFlushRenderer;
+    private createOutlineColorTexture;
+    private setupCompositionScene;
+    private setupFxaaScene;
+    private setupSsaoScene;
+    private setupSsaoBlurCombineScene;
+    private createKernel;
+    private createRenderTriangle;
+    private traverseForRootSectorNode;
+    private setVisibilityOfSectors;
+    /**
+     * Assign SpectorJS metadata containing names for the render targets when running Reveal
+     * in development mode.
+     */
+    private setupRenderTargetSpectorDebugging;
+    /**
+     * Assigns SpectorJS metadata to the current framebuffer (render target).
+     * This is useful to assign e.g. names to framebuffers to easy debugging in SpectorJS. The metadata
+     * will be visible in 'bindFramebuffer'-commands in the SpectorJS report.
+     */
+    private assignSpectorJsMetadataToRenderTarget;
+}

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

@@ -1,51 +1,51 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-import { IndexSet } from '../../../utilities';
-import { NodeAppearanceProvider, NodeAppearance } from '../../../cad-styling';
-export declare class NodeAppearanceTextureBuilder {
-    private _defaultAppearance;
-    private readonly _styleProvider;
-    private readonly _handleStylesChangedListener;
-    private _needsUpdate;
-    private readonly _allTreeIndices;
-    private readonly _overrideColorDefaultAppearanceRgba;
-    private readonly _overrideColorPerTreeIndexTexture;
-    private readonly _regularNodesTreeIndices;
-    private readonly _ghostedNodesTreeIndices;
-    private readonly _infrontNodesTreeIndices;
-    constructor(treeIndexCount: number, styleProvider: NodeAppearanceProvider);
-    getDefaultAppearance(): NodeAppearance;
-    /**
-     * Sets the default style and invalidates the builder. Note that this causes a full
-     * recomputation of values the next time {@link build} is called, so using this might be
-     * expensive.
-     * @param appearance New style that is applied to all 'unstyled' elements.
-     */
-    setDefaultAppearance(appearance: NodeAppearance): void;
-    get regularNodeTreeIndices(): IndexSet;
-    get ghostedNodeTreeIndices(): IndexSet;
-    get infrontNodeTreeIndices(): IndexSet;
-    get needsUpdate(): boolean;
-    /**
-     * A texture holding at least one element per node with color override
-     * and style information. RGB is used to store color, A is used to store
-     * style toggles, with the following bit layout:
-     * - 0  : visible bit         - when set the node is visible
-     * - 1  : in front bit        - when set the node is rendered in front of other objects
-     * - 2  : ghosted bit         - when set the node is rendered 'ghosted'
-     * - 3  : unused
-     * - 4  : unused
-     * - 5-7: outline color - outline toggle and color ({@see OutlineColor}).
-     * Note that in-front and ghost information also is available from
-     * the {@see inFrontTreeIndices} and {@see ghostedTreeIndices} collections.
-     */
-    get overrideColorPerTreeIndexTexture(): THREE.DataTexture;
-    dispose(): void;
-    build(): void;
-    private populateTexture;
-    private populateNodeSets;
-    private applyStyleToNodes;
-    private handleStylesChanged;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+import { IndexSet } from '../../../utilities';
+import { NodeAppearanceProvider, NodeAppearance } from '../../../cad-styling';
+export declare class NodeAppearanceTextureBuilder {
+    private _defaultAppearance;
+    private readonly _styleProvider;
+    private readonly _handleStylesChangedListener;
+    private _needsUpdate;
+    private readonly _allTreeIndices;
+    private readonly _overrideColorDefaultAppearanceRgba;
+    private readonly _overrideColorPerTreeIndexTexture;
+    private readonly _regularNodesTreeIndices;
+    private readonly _ghostedNodesTreeIndices;
+    private readonly _infrontNodesTreeIndices;
+    constructor(treeIndexCount: number, styleProvider: NodeAppearanceProvider);
+    getDefaultAppearance(): NodeAppearance;
+    /**
+     * Sets the default style and invalidates the builder. Note that this causes a full
+     * recomputation of values the next time {@link build} is called, so using this might be
+     * expensive.
+     * @param appearance New style that is applied to all 'unstyled' elements.
+     */
+    setDefaultAppearance(appearance: NodeAppearance): void;
+    get regularNodeTreeIndices(): IndexSet;
+    get ghostedNodeTreeIndices(): IndexSet;
+    get infrontNodeTreeIndices(): IndexSet;
+    get needsUpdate(): boolean;
+    /**
+     * A texture holding at least one element per node with color override
+     * and style information. RGB is used to store color, A is used to store
+     * style toggles, with the following bit layout:
+     * - 0  : visible bit         - when set the node is visible
+     * - 1  : in front bit        - when set the node is rendered in front of other objects
+     * - 2  : ghosted bit         - when set the node is rendered 'ghosted'
+     * - 3  : unused
+     * - 4  : unused
+     * - 5-7: outline color - outline toggle and color ({@see OutlineColor}).
+     * Note that in-front and ghost information also is available from
+     * the {@see inFrontTreeIndices} and {@see ghostedTreeIndices} collections.
+     */
+    get overrideColorPerTreeIndexTexture(): THREE.DataTexture;
+    dispose(): void;
+    build(): void;
+    private populateTexture;
+    private populateNodeSets;
+    private applyStyleToNodes;
+    private handleStylesChanged;
+}

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

@@ -1,15 +1,15 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-export declare enum RenderMode {
-    Color = 1,
-    Normal = 2,
-    TreeIndex = 3,
-    PackColorAndNormal = 4,
-    Depth = 5,
-    Effects = 6,
-    Ghost = 7,
-    LOD = 8,
-    DepthBufferOnly = 9,
-    GeometryType = 10
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+export declare enum RenderMode {
+    Color = 1,
+    Normal = 2,
+    TreeIndex = 3,
+    PackColorAndNormal = 4,
+    Depth = 5,
+    Effects = 6,
+    Ghost = 7,
+    LOD = 8,
+    DepthBufferOnly = 9,
+    GeometryType = 10
+}

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

@@ -1,6 +1,6 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-import { Materials } from './materials';
-export declare function createSimpleGeometryMesh(attributeValues: Float32Array, materials: Materials, sectorBounds: THREE.Box3, geometryClipBox: THREE.Box3 | null): THREE.Mesh | undefined;
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+import { Materials } from './materials';
+export declare function createSimpleGeometryMesh(attributeValues: Float32Array, materials: Materials, sectorBounds: THREE.Box3, geometryClipBox: THREE.Box3 | null): THREE.Mesh | undefined;

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

@@ -1,5 +1,5 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-declare const image: HTMLImageElement;
-export default image;
+/*!
+ * Copyright 2021 Cognite AS
+ */
+declare const image: HTMLImageElement;
+export default image;

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

@@ -1,23 +1,23 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-import { RenderMode } from './RenderMode';
-export interface Materials {
-    box: THREE.ShaderMaterial;
-    circle: THREE.ShaderMaterial;
-    generalRing: THREE.ShaderMaterial;
-    nut: THREE.ShaderMaterial;
-    quad: THREE.ShaderMaterial;
-    cone: THREE.ShaderMaterial;
-    eccentricCone: THREE.ShaderMaterial;
-    sphericalSegment: THREE.ShaderMaterial;
-    torusSegment: THREE.ShaderMaterial;
-    generalCylinder: THREE.ShaderMaterial;
-    trapezium: THREE.ShaderMaterial;
-    ellipsoidSegment: THREE.ShaderMaterial;
-    instancedMesh: THREE.ShaderMaterial;
-    triangleMesh: THREE.ShaderMaterial;
-    simple: THREE.ShaderMaterial;
-}
-export declare function createMaterials(renderMode: RenderMode, clippingPlanes: THREE.Plane[], overrideColorPerTreeIndex: THREE.DataTexture, transformOverrideIndexTexture: THREE.DataTexture, transformOverrideLookupTexture: THREE.DataTexture): Materials;
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+import { RenderMode } from './RenderMode';
+export interface Materials {
+    box: THREE.ShaderMaterial;
+    circle: THREE.ShaderMaterial;
+    generalRing: THREE.ShaderMaterial;
+    nut: THREE.ShaderMaterial;
+    quad: THREE.ShaderMaterial;
+    cone: THREE.ShaderMaterial;
+    eccentricCone: THREE.ShaderMaterial;
+    sphericalSegment: THREE.ShaderMaterial;
+    torusSegment: THREE.ShaderMaterial;
+    generalCylinder: THREE.ShaderMaterial;
+    trapezium: THREE.ShaderMaterial;
+    ellipsoidSegment: THREE.ShaderMaterial;
+    instancedMesh: THREE.ShaderMaterial;
+    triangleMesh: THREE.ShaderMaterial;
+    simple: THREE.ShaderMaterial;
+}
+export declare function createMaterials(renderMode: RenderMode, clippingPlanes: THREE.Plane[], overrideColorPerTreeIndex: THREE.DataTexture, transformOverrideIndexTexture: THREE.DataTexture, transformOverrideLookupTexture: THREE.DataTexture): Materials;

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

@@ -1,12 +1,12 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-import { SectorGeometry } from '../../../cad-parsers';
-import { BoundingBoxLOD } from '../../../utilities';
-import { Materials } from './materials';
-export declare function createPrimitives(sector: SectorGeometry, materials: Materials, sectorBounds: THREE.Box3, geometryClipBox?: THREE.Box3 | null): Generator<THREE.Mesh | BoundingBoxLOD>;
-export declare function determineBoundsFromInstanceMatrices(geometry: THREE.InstancedBufferGeometry): {
-    boundingBox: THREE.Box3;
-    boundingSphere: THREE.Sphere;
-};
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+import { SectorGeometry } from '../../../cad-parsers';
+import { BoundingBoxLOD } from '../../../utilities';
+import { Materials } from './materials';
+export declare function createPrimitives(sector: SectorGeometry, materials: Materials, sectorBounds: THREE.Box3, geometryClipBox?: THREE.Box3 | null): Generator<THREE.Mesh | BoundingBoxLOD>;
+export declare function determineBoundsFromInstanceMatrices(geometry: THREE.InstancedBufferGeometry): {
+    boundingBox: THREE.Box3;
+    boundingSphere: THREE.Sphere;
+};

package/packages/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;
-};
-/**
- * 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;
+    };
+};
+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;
+};