@cognite/reveal 2.0.0-beta.3 → 2.1.2

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

@@ -1,31 +1,31 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-export declare const boxGeometry: {
-    index: THREE.BufferAttribute | null;
-    position: THREE.BufferAttribute | THREE.InterleavedBufferAttribute;
-    normal: THREE.BufferAttribute | THREE.InterleavedBufferAttribute;
-}, boxGeometryBoundingBox: THREE.Box3;
-export declare const quadGeometry: {
-    index: THREE.BufferAttribute | null;
-    position: THREE.BufferAttribute | THREE.InterleavedBufferAttribute;
-    normal: THREE.BufferAttribute | THREE.InterleavedBufferAttribute;
-}, quadGeometryBoundingBox: THREE.Box3;
-export declare const trapeziumGeometry: {
-    index: THREE.BufferAttribute;
-    position: THREE.BufferAttribute;
-}, trapeziumGeometryBoundingBox: THREE.Box3;
-export declare const coneGeometry: {
-    index: THREE.BufferAttribute;
-    position: THREE.BufferAttribute;
-}, coneGeometryBoundingBox: THREE.Box3;
-export declare const torusGeometry: {
-    index: THREE.Uint16BufferAttribute;
-    position: THREE.Float32BufferAttribute;
-}, torusGeometryBoundingBox: THREE.Box3;
-export declare const nutGeometry: {
-    index: THREE.BufferAttribute | null;
-    position: THREE.BufferAttribute | THREE.InterleavedBufferAttribute;
-    normal: THREE.BufferAttribute | THREE.InterleavedBufferAttribute;
-}, nutGeometryBoundingBox: THREE.Box3;
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+export declare const boxGeometry: {
+    index: THREE.BufferAttribute | null;
+    position: THREE.BufferAttribute | THREE.InterleavedBufferAttribute;
+    normal: THREE.BufferAttribute | THREE.InterleavedBufferAttribute;
+}, boxGeometryBoundingBox: THREE.Box3;
+export declare const quadGeometry: {
+    index: THREE.BufferAttribute | null;
+    position: THREE.BufferAttribute | THREE.InterleavedBufferAttribute;
+    normal: THREE.BufferAttribute | THREE.InterleavedBufferAttribute;
+}, quadGeometryBoundingBox: THREE.Box3;
+export declare const trapeziumGeometry: {
+    index: THREE.BufferAttribute;
+    position: THREE.BufferAttribute;
+}, trapeziumGeometryBoundingBox: THREE.Box3;
+export declare const coneGeometry: {
+    index: THREE.BufferAttribute;
+    position: THREE.BufferAttribute;
+}, coneGeometryBoundingBox: THREE.Box3;
+export declare const torusLodGeometries: {
+    index: THREE.Uint16BufferAttribute;
+    position: THREE.Float32BufferAttribute;
+}[], torusGeometryBoundingBox: THREE.Box3;
+export declare const nutGeometry: {
+    index: THREE.BufferAttribute | null;
+    position: THREE.BufferAttribute | THREE.InterleavedBufferAttribute;
+    normal: THREE.BufferAttribute | THREE.InterleavedBufferAttribute;
+}, nutGeometryBoundingBox: THREE.Box3;

package/packages/cad-parsers/src/cad/primitives.d.ts

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

package/{datamodels/cad/rendering → packages/cad-parsers/src/cad}/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;
+};
+/**
+ * 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;
+};

package/packages/cad-parsers/src/cad/types.d.ts

@@ -0,0 +1,56 @@
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+import { AutoDisposeGroup } from '../../../utilities';
+import { ParsedPrimitives, ParseSectorResult, ParseCtmResult, SectorQuads } from '@cognite/reveal-parser-worker';
+import { SectorMetadata } from '../metadata/types';
+import { LevelOfDetail } from './LevelOfDetail';
+export declare type TriangleMesh = {
+    readonly fileId: number;
+    readonly indices: Uint32Array;
+    readonly treeIndices: Float32Array;
+    readonly vertices: Float32Array;
+    readonly normals: Float32Array | undefined;
+    readonly colors: Uint8Array;
+};
+export declare type InstancedMeshFile = {
+    readonly fileId: number;
+    readonly indices: Uint32Array;
+    readonly vertices: Float32Array;
+    readonly instances: InstancedMesh[];
+};
+export declare type InstancedMesh = {
+    readonly triangleCount: number;
+    readonly triangleOffset: number;
+    readonly colors: Uint8Array;
+    readonly instanceMatrices: Float32Array;
+    readonly treeIndices: Float32Array;
+};
+export interface SectorGeometry {
+    readonly nodeIdToTreeIndexMap: Map<number, number>;
+    readonly treeIndexToNodeIdMap: Map<number, number>;
+    readonly primitives: ParsedPrimitives;
+    readonly instanceMeshes: InstancedMeshFile[];
+    readonly triangleMeshes: TriangleMesh[];
+}
+export interface ConsumedSector {
+    modelIdentifier: string;
+    metadata: SectorMetadata;
+    levelOfDetail: LevelOfDetail;
+    group: AutoDisposeGroup | undefined;
+    instancedMeshes: InstancedMeshFile[] | undefined;
+}
+export interface ParsedSector {
+    modelIdentifier: string;
+    metadata: SectorMetadata;
+    data: null | ParseSectorResult | ParseCtmResult | SectorGeometry | SectorQuads;
+    levelOfDetail: LevelOfDetail;
+}
+export interface WantedSector {
+    modelIdentifier: string;
+    modelBaseUrl: string;
+    geometryClipBox: THREE.Box3 | null;
+    levelOfDetail: LevelOfDetail;
+    metadata: SectorMetadata;
+}

package/{datamodels/cad/parsers → packages/cad-parsers/src/metadata}/CadMetadataParser.d.ts

@@ -1,7 +1,7 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { SectorScene } from '../sector/types';
-export declare class CadMetadataParser {
-    parse(parsedJson: any): SectorScene;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { SectorScene } from '../utilities/types';
+export declare class CadMetadataParser {
+    parse(parsedJson: any): SectorScene;
+}

package/{datamodels/cad → packages/cad-parsers/src/metadata}/CadModelMetadata.d.ts

@@ -1,36 +1,44 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-import { SectorScene } from './sector/types';
-import { CameraConfiguration } from '../../utilities';
-export interface CadModelMetadata {
-    /**
-     * URL of the model. This is a unique identifier.
-     */
-    readonly blobUrl: string;
-    /**
-     * If not null, geometry outside this box might be clipped
-     * away to avoid representing unused geometry. Will typically
-     * be used with geometry filters where only a part of the model
-     * is loaded.
-     */
-    readonly geometryClipBox: THREE.Box3 | null;
-    /**
-     * Matrix transforming from coordinates of the model to ThreeJS
-     * coordinates.
-     */
-    readonly modelMatrix: THREE.Matrix4;
-    /**
-     * Inverse of {@see modelMatrix}.
-     */
-    readonly inverseModelMatrix: THREE.Matrix4;
-    /**
-     * Description of the tree structure holding geometry.
-     */
-    readonly scene: SectorScene;
-    /**
-     * Camera configuration stored in CDF (if any).
-     */
-    readonly cameraConfiguration?: CameraConfiguration;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+import { SectorScene } from '../utilities/types';
+import { CameraConfiguration } from '../../../utilities';
+export interface CadModelMetadata {
+    /**
+     * A unique identifier of the model.
+     */
+    readonly modelIdentifier: string;
+    /**
+     * Base URL of the model.
+     */
+    readonly modelBaseUrl: string;
+    /**
+     * If not null, geometry outside this box might be clipped
+     * away to avoid representing unused geometry. Will typically
+     * be used with geometry filters where only a part of the model
+     * is loaded.
+     * Note that the coordinates of this box is in "model space" and
+     * not in "viewer space". To use this to e.g. create clip planes
+     * around the geometry, it must be transformed to "viewer space"
+     * first.
+     */
+    readonly geometryClipBox: THREE.Box3 | null;
+    /**
+     * Matrix transforming from coordinates of the model to ThreeJS
+     * coordinates.
+     */
+    readonly modelMatrix: THREE.Matrix4;
+    /**
+     * Inverse of {@see modelMatrix}.
+     */
+    readonly inverseModelMatrix: THREE.Matrix4;
+    /**
+     * Description of the tree structure holding geometry.
+     */
+    readonly scene: SectorScene;
+    /**
+     * Camera configuration stored in CDF (if any).
+     */
+    readonly cameraConfiguration?: CameraConfiguration;
+}

package/packages/cad-parsers/src/metadata/CadModelMetadataRepository.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { CadMetadataParser } from './CadMetadataParser';
+import { CadModelMetadata } from './CadModelMetadata';
+import { MetadataRepository } from './MetadataRepository';
+import { ModelDataClient, ModelMetadataProvider } from '../../../modeldata-api';
+export declare class CadModelMetadataRepository<TModelIdentifier> implements MetadataRepository<TModelIdentifier, Promise<CadModelMetadata>> {
+    private readonly _modelMetadataProvider;
+    private readonly _modelDataClient;
+    private readonly _cadSceneParser;
+    private readonly _blobFileName;
+    private _currentModelIdentifier;
+    constructor(modelMetadataProvider: ModelMetadataProvider<TModelIdentifier>, modelDataClient: ModelDataClient, cadMetadataParser: CadMetadataParser, blobFileName?: string);
+    loadData(model: TModelIdentifier): Promise<CadModelMetadata>;
+}

package/{datamodels/base → packages/cad-parsers/src/metadata}/MetadataRepository.d.ts

@@ -1,6 +1,6 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-export interface MetadataRepository<Input, Output> {
-    loadData(input: Input): Output;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+export interface MetadataRepository<Input, Output> {
+    loadData(input: Input): Output;
+}

package/{datamodels/cad → packages/cad-parsers/src/metadata}/parsers/CadMetadataParserV8.d.ts

@@ -1,50 +1,51 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { SectorScene } from '../sector/types';
-export interface CadSectorMetadataV8 {
-    readonly id: number;
-    readonly parentId: number;
-    readonly path: string;
-    readonly depth: number;
-    readonly estimatedDrawCallCount: number;
-    readonly boundingBox: {
-        readonly min: {
-            x: number;
-            y: number;
-            z: number;
-        };
-        readonly max: {
-            x: number;
-            y: number;
-            z: number;
-        };
-    };
-    readonly indexFile: {
-        readonly fileName: string;
-        readonly peripheralFiles: string[];
-        readonly downloadSize: number;
-    };
-    readonly facesFile: {
-        readonly quadSize: number;
-        readonly coverageFactors: {
-            xy: number;
-            yz: number;
-            xz: number;
-        };
-        readonly recursiveCoverageFactors: {
-            xy: number;
-            yz: number;
-            xz: number;
-        } | undefined;
-        readonly fileName: string | null;
-        readonly downloadSize: number;
-    } | null;
-}
-export interface CadMetadataV8 {
-    readonly version: 8;
-    readonly maxTreeIndex: number;
-    readonly sectors: CadSectorMetadataV8[];
-    readonly unit: string | null;
-}
-export declare function parseCadMetadataV8(metadata: CadMetadataV8): SectorScene;
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { SectorScene } from '../../utilities/types';
+export interface CadSectorMetadataV8 {
+    readonly id: number;
+    readonly parentId: number;
+    readonly path: string;
+    readonly depth: number;
+    readonly estimatedDrawCallCount: number;
+    readonly estimatedTriangleCount: number;
+    readonly boundingBox: {
+        readonly min: {
+            x: number;
+            y: number;
+            z: number;
+        };
+        readonly max: {
+            x: number;
+            y: number;
+            z: number;
+        };
+    };
+    readonly indexFile: {
+        readonly fileName: string;
+        readonly peripheralFiles: string[];
+        readonly downloadSize: number;
+    };
+    readonly facesFile: {
+        readonly quadSize: number;
+        readonly coverageFactors: {
+            xy: number;
+            yz: number;
+            xz: number;
+        };
+        readonly recursiveCoverageFactors: {
+            xy: number;
+            yz: number;
+            xz: number;
+        } | undefined;
+        readonly fileName: string | null;
+        readonly downloadSize: number;
+    } | null;
+}
+export interface CadMetadataV8 {
+    readonly version: 8;
+    readonly maxTreeIndex: number;
+    readonly sectors: CadSectorMetadataV8[];
+    readonly unit: string | null;
+}
+export declare function parseCadMetadataV8(metadata: CadMetadataV8): SectorScene;

package/packages/cad-parsers/src/metadata/types.d.ts

@@ -0,0 +1,41 @@
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+export interface SectorMetadataIndexFileSection {
+    readonly fileName: string;
+    readonly peripheralFiles: string[];
+    readonly downloadSize: number;
+}
+export interface SectorMetadataFacesFileSection {
+    readonly quadSize: number;
+    /**
+     * Coverage factors for the sector without children.
+     */
+    readonly coverageFactors: {
+        xy: number;
+        yz: number;
+        xz: number;
+    };
+    /**
+     * Coverage factor for the sectors including children.
+     */
+    readonly recursiveCoverageFactors: {
+        xy: number;
+        yz: number;
+        xz: number;
+    };
+    readonly fileName: string | null;
+    readonly downloadSize: number;
+}
+export interface SectorMetadata {
+    readonly id: number;
+    readonly path: string;
+    readonly depth: number;
+    readonly bounds: THREE.Box3;
+    readonly indexFile: SectorMetadataIndexFileSection;
+    readonly facesFile: SectorMetadataFacesFileSection;
+    readonly children: SectorMetadata[];
+    readonly estimatedDrawCallCount: number;
+    readonly estimatedRenderCost: number;
+}

package/{datamodels/cad/sector → packages/cad-parsers/src/utilities}/SectorScene.d.ts

@@ -1,21 +1,21 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-import { SectorMetadata, SectorScene } from './types';
-export declare class SectorSceneImpl implements SectorScene {
-    static createFromRootSector(version: number, maxTreeIndex: number, unit: string, root: SectorMetadata): SectorScene;
-    readonly version: number;
-    readonly maxTreeIndex: number;
-    readonly root: SectorMetadata;
-    readonly unit: string;
-    private readonly sectors;
-    constructor(version: number, maxTreeIndex: number, unit: string, root: SectorMetadata, sectorsById: Map<number, SectorMetadata>);
-    get sectorCount(): number;
-    getSectorById(sectorId: number): SectorMetadata | undefined;
-    getAllSectors(): SectorMetadata[];
-    getSectorsContainingPoint(p: THREE.Vector3): SectorMetadata[];
-    getSectorsIntersectingBox(b: THREE.Box3): SectorMetadata[];
-    getBoundsOfMostGeometry(): THREE.Box3;
-    getSectorsIntersectingFrustum(projectionMatrix: THREE.Matrix4, inverseCameraModelMatrix: THREE.Matrix4): SectorMetadata[];
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+import { SectorScene } from './types';
+import { SectorMetadata } from '../metadata/types';
+export declare class SectorSceneImpl implements SectorScene {
+    readonly version: number;
+    readonly maxTreeIndex: number;
+    readonly root: SectorMetadata;
+    readonly unit: string;
+    private readonly sectors;
+    constructor(version: number, maxTreeIndex: number, unit: string, root: SectorMetadata, sectorsById: Map<number, SectorMetadata>);
+    get sectorCount(): number;
+    getSectorById(sectorId: number): SectorMetadata | undefined;
+    getAllSectors(): SectorMetadata[];
+    getSectorsContainingPoint(p: THREE.Vector3): SectorMetadata[];
+    getSectorsIntersectingBox(b: THREE.Box3): SectorMetadata[];
+    getBoundsOfMostGeometry(): THREE.Box3;
+    getSectorsIntersectingFrustum(projectionMatrix: THREE.Matrix4, inverseCameraModelMatrix: THREE.Matrix4): SectorMetadata[];
+}

package/packages/cad-parsers/src/utilities/SectorSceneFactory.d.ts

@@ -0,0 +1,12 @@
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { SectorSceneImpl } from './SectorScene';
+import { SectorMetadata } from '../metadata/types';
+/**
+ * Factory for creating instance of {@link SectorScene} based on
+ * the version of the format provided.
+ */
+export declare class SectorSceneFactory {
+    createSectorScene(version: number, maxTreeIndex: number, unit: string, root: SectorMetadata): SectorSceneImpl;
+}