@cognite/reveal 2.1.0 → 2.2.2

package/{core/src/datamodels/cad/styling → packages/rendering/src/rendering}/NodeAppearanceTextureBuilder.d.ts

@@ -1,51 +1,51 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-import { NodeAppearance } from '../NodeAppearance';
-import { IndexSet } from '../../../utilities/IndexSet';
-import { NodeAppearanceProvider } from './NodeAppearanceProvider';
-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-5: outline color - outline toggle and color ({@see OutlineColor}).
-     * - 6-7: unused
-     * 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/{core/src/datamodels/cad → 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/{core/src/datamodels/cad → 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/{core/src/datamodels/cad → 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/{core/src/datamodels/cad → 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/{core/src/datamodels/cad → packages/rendering/src}/rendering/primitives.d.ts

@@ -1,12 +1,12 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-import { SectorGeometry } from '../sector/types';
-import { Materials } from './materials';
-import { BoundingBoxLOD } from '../../../utilities/three';
-export declare function createPrimitives(sector: SectorGeometry, materials: Materials, sectorBounds: THREE.Box3, geometryClipBox?: THREE.Box3 | null): Generator<THREE.Mesh<THREE.BufferGeometry, THREE.Material | THREE.Material[]> | THREE.Mesh<THREE.InstancedBufferGeometry, THREE.ShaderMaterial> | BoundingBoxLOD, void, unknown>;
-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/{core/src/datamodels/cad → 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;
-};
-/**
- * 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/rendering/src/rendering/types.d.ts

@@ -0,0 +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) 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/{core/src/datamodels/cad → packages/rendering/src/sector}/CadNode.d.ts

@@ -1,57 +1,54 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-import { SectorGeometry, SectorScene } from './sector/types';
-import { InstancedMeshFile, SectorQuads } from './rendering/types';
-import { RootSectorNode } from './sector/RootSectorNode';
-import { RenderMode } from './rendering/RenderMode';
-import { CadMaterialManager } from './CadMaterialManager';
-import { CadModelMetadata } from './CadModelMetadata';
-import { NodeTransformProvider } from './styling/NodeTransformProvider';
-import { NodeAppearanceProvider } from './styling/NodeAppearanceProvider';
-import { NodeAppearance } from './NodeAppearance';
-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/{core/src/datamodels/cad/styling → 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;
+}