@cognite/reveal 3.1.0 → 4.0.0-dev.20221025

package/packages/cad-model/src/CadModelFactory.d.ts

@@ -1,17 +1,16 @@
-import { GeometryFilter } from './types';
-import { CadMaterialManager } from '../../rendering';
-import { CadModelMetadata } from '../../cad-parsers';
-import { ModelDataProvider, ModelMetadataProvider, ModelIdentifier } from '../../modeldata-api';
-import { CadNode } from './wrappers/CadNode';
-export declare class CadModelFactory {
-    private readonly _materialManager;
-    private readonly _modelDataProvider;
-    private readonly _cadModelMetadataRepository;
-    private _v8SectorRepository;
-    private _gltfSectorRepository;
-    constructor(materialManager: CadMaterialManager, modelMetadataProvider: ModelMetadataProvider, modelDataProvider: ModelDataProvider);
-    loadModelMetadata(externalModelIdentifier: ModelIdentifier): Promise<CadModelMetadata>;
-    createModel(metadata: CadModelMetadata, geometryFilter?: GeometryFilter): Promise<CadNode>;
-    private getSectorRepository;
-    dispose(): void;
-}
+import { GeometryFilter } from './types';
+import { CadMaterialManager } from '../../rendering';
+import { CadModelMetadata } from '../../cad-parsers';
+import { ModelDataProvider, ModelMetadataProvider, ModelIdentifier } from '../../data-providers';
+import { CadNode } from './wrappers/CadNode';
+export declare class CadModelFactory {
+    private readonly _materialManager;
+    private readonly _modelDataProvider;
+    private readonly _cadModelMetadataRepository;
+    private _gltfSectorRepository;
+    constructor(materialManager: CadMaterialManager, modelMetadataProvider: ModelMetadataProvider, modelDataProvider: ModelDataProvider);
+    loadModelMetadata(externalModelIdentifier: ModelIdentifier): Promise<CadModelMetadata>;
+    createModel(metadata: CadModelMetadata, geometryFilter?: GeometryFilter): Promise<CadNode>;
+    private getSectorRepository;
+    dispose(): void;
+}

package/packages/cad-model/src/batching/GeometryBatchingManager.d.ts

@@ -1,31 +1,31 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-import { ParsedGeometry } from '../../../sector-parser';
-import { Materials } from '../../../rendering';
-export declare class GeometryBatchingManager {
-    private readonly _batchedGeometriesGroup;
-    private readonly _materials;
-    private readonly _instancedTypeMap;
-    private readonly _sectorMap;
-    private static readonly TypedArrayViews;
-    constructor(group: THREE.Group, materials: Materials);
-    dispose(): void;
-    batchGeometries(geometryBatchingQueue: ParsedGeometry[], sectorId: number): void;
-    removeSectorBatches(sectorId: number): void;
-    private processGeometries;
-    private updateInstanceAttributes;
-    private extendUpdateRange;
-    private reallocateBufferGeometry;
-    private createSectorBatch;
-    private createInstanceMeshGeometry;
-    private getInstanceAttributesSharedView;
-    private getTreeIndexAttribute;
-    private removeTreeIndicesFromMeshUserData;
-    private createDefragmentedBufferGeometry;
-    private createInstanceMesh;
-    private getAttributes;
-    private copyGeometryWithBufferAttributes;
-    private getShaderMaterial;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+import { ParsedGeometry } from '../../../sector-parser';
+import { Materials } from '../../../rendering';
+export declare class GeometryBatchingManager {
+    private readonly _batchedGeometriesGroup;
+    private readonly _materials;
+    private readonly _instancedTypeMap;
+    private readonly _sectorMap;
+    private static readonly TypedArrayViews;
+    constructor(group: THREE.Group, materials: Materials);
+    dispose(): void;
+    batchGeometries(geometryBatchingQueue: ParsedGeometry[], sectorId: number): void;
+    removeSectorBatches(sectorId: number): void;
+    private processGeometries;
+    private updateInstanceAttributes;
+    private extendUpdateRange;
+    private reallocateBufferGeometry;
+    private createSectorBatch;
+    private createInstanceMeshGeometry;
+    private getInstanceAttributesSharedView;
+    private getTreeIndexAttribute;
+    private removeTreeIndicesFromMeshUserData;
+    private createDefragmentedBufferGeometry;
+    private createInstanceMesh;
+    private getAttributes;
+    private copyGeometryWithBufferAttributes;
+    private getShaderMaterial;
+}

package/packages/cad-model/src/picking/PickingHandler.d.ts

@@ -1,35 +1,36 @@
-/*!
- * Copyright 2022 Cognite AS
- */
-import * as THREE from 'three';
-import { IntersectInput } from '../../../model-base';
-import { CadMaterialManager } from '../../../rendering';
-import { SceneHandler } from '../../../utilities';
-import { CadNode } from '../wrappers/CadNode';
-declare type IntersectCadNodesResult = {
-    distance: number;
-    point: THREE.Vector3;
-    treeIndex: number;
-    cadNode: CadNode;
-    object: THREE.Object3D;
-};
-export declare class PickingHandler {
-    private readonly _clearColor;
-    private readonly _clearAlpha;
-    private readonly _pickPixelColorStorage;
-    private readonly _rgbaVector;
-    private readonly _unpackFactors;
-    private readonly _pipelineExecutor;
-    private readonly _depthRenderPipeline;
-    private readonly _treeIndexRenderPipeline;
-    constructor(renderer: THREE.WebGLRenderer, materialManager: CadMaterialManager, sceneHandler: SceneHandler);
-    intersectCadNodes(cadNodes: CadNode[], input: IntersectInput): IntersectCadNodesResult[];
-    intersectCadNode(cadNode: CadNode, input: IntersectInput): IntersectCadNodesResult | undefined;
-    private pickTreeIndex;
-    private perspectiveDepthToViewZ;
-    private pickDepth;
-    private getPosition;
-    private pickPixel;
-    private unpackRGBAToDepth;
-}
-export {};
+/*!
+ * Copyright 2022 Cognite AS
+ */
+import * as THREE from 'three';
+import { IntersectInput } from '../../../model-base';
+import { CadMaterialManager } from '../../../rendering';
+import { SceneHandler } from '../../../utilities';
+import { CadNode } from '../wrappers/CadNode';
+declare type IntersectCadNodesResult = {
+    distance: number;
+    point: THREE.Vector3;
+    treeIndex: number;
+    cadNode: CadNode;
+    object: THREE.Object3D;
+};
+export declare class PickingHandler {
+    private readonly _clearColor;
+    private readonly _clearAlpha;
+    private readonly _pickPixelColorStorage;
+    private readonly _rgbaVector;
+    private readonly _unpackFactors;
+    private readonly _pipelineExecutor;
+    private readonly _depthRenderPipeline;
+    private readonly _treeIndexRenderPipeline;
+    private readonly _mutex;
+    constructor(renderer: THREE.WebGLRenderer, materialManager: CadMaterialManager, sceneHandler: SceneHandler);
+    intersectCadNodes(cadNodes: CadNode[], input: IntersectInput, async?: boolean): Promise<IntersectCadNodesResult[]>;
+    intersectCadNode(cadNode: CadNode, input: IntersectInput, async: boolean): Promise<IntersectCadNodesResult | undefined>;
+    private pickTreeIndex;
+    private perspectiveDepthToViewZ;
+    private pickDepth;
+    private getPosition;
+    private pickPixel;
+    private unpackRGBAToDepth;
+}
+export {};

package/packages/cad-model/src/picking/readPixelsFromTargetAsync.d.ts

@@ -0,0 +1,17 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+import * as THREE from 'three';
+/**
+ * Does the same as THREE.WebGlRenderer.readRenderTargetPixels(), but does this
+ * asynchronously when used on WebGL2.
+ * @param renderer
+ * @param renderTarget
+ * @param x
+ * @param y
+ * @param w
+ * @param h
+ * @param dest
+ * @returns
+ */
+export declare function readPixelsFromTargetAsync(renderer: THREE.WebGLRenderer, renderTarget: THREE.WebGLRenderTarget, x: number, y: number, w: number, h: number, dest: ArrayBufferView, forceSync?: boolean): Promise<void>;

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

@@ -1,59 +1,59 @@
-/*!
- * Copyright 2022 Cognite AS
- */
-/**
- * Units supported by {@link Cognite3DModel}.
- */
-export declare type WellKnownUnit = 'Meters' | 'Centimeters' | 'Millimeters' | 'Micrometers' | 'Kilometers' | 'Feet' | 'Inches' | 'Yards' | 'Miles' | 'Mils' | 'Microinches';
-export declare type GeometryFilter = {
-    /**
-     * The bounds to load geometry within. By default this box is in CDF coordinate space which
-     * will be transformed into coordinates relative to the model using the the model transformation
-     * which can be specified using {@link https://docs.cognite.com/api/v1/#operation/update3DRevisions |the CDF API},
-     * or set in {@link https://fusion.cognite.com/ |Cognite Fusion}.
-     * @see {@link isBoundingBoxInModelCoordinates}.
-     */
-    boundingBox?: THREE.Box3;
-    /**
-     * When set, the geometry filter {@link boundingBox} will be considered to be in "Reveal/ThreeJS space".
-     * Rather than CDF space which is the default. When using Reveal space, the model transformation
-     * which can be specified using {@link https://docs.cognite.com/api/v1/#operation/update3DRevisions |the CDF API},
-     * or set in {@link https://fusion.cognite.com/ |Cognite Fusion}.
-     */
-    isBoundingBoxInModelCoordinates?: boolean;
-};
-export declare type CadModelSectorLoadStatistics = {
-    /**
-     * Estimated number of bytes to download sectors.
-     */
-    readonly downloadSize: number;
-    /**
-     * Estimated number of draw calls required to draw sectors.
-     */
-    readonly drawCalls: number;
-    /**
-     * Total number of sectors to load.
-     */
-    readonly loadedSectorCount: number;
-    /**
-     * Number of 'simple' sectors to load.
-     */
-    readonly simpleSectorCount: number;
-    /**
-     * Number of 'detailed' sectors to load.
-     */
-    readonly detailedSectorCount: number;
-    /**
-     * How many sectors that was "forced prioritized", e.g.
-     * because they are near the camera.
-     */
-    readonly forcedDetailedSectorCount: number;
-    /**
-     * The total number of sectors in models we are loading.
-     */
-    readonly totalSectorCount: number;
-    /**
-     * How much of the prioritized nodes that are loaded (between 0 and 1).
-     */
-    readonly accumulatedPriority: number;
-};
+/*!
+ * Copyright 2022 Cognite AS
+ */
+/**
+ * Units supported by {@link Cognite3DModel}.
+ */
+export declare type WellKnownUnit = 'Meters' | 'Centimeters' | 'Millimeters' | 'Micrometers' | 'Kilometers' | 'Feet' | 'Inches' | 'Yards' | 'Miles' | 'Mils' | 'Microinches';
+export declare type GeometryFilter = {
+    /**
+     * The bounds to load geometry within. By default this box is in CDF coordinate space which
+     * will be transformed into coordinates relative to the model using the the model transformation
+     * which can be specified using {@link https://docs.cognite.com/api/v1/#operation/update3DRevisions |the CDF API},
+     * or set in {@link https://fusion.cognite.com/ |Cognite Fusion}.
+     * @see {@link isBoundingBoxInModelCoordinates}.
+     */
+    boundingBox?: THREE.Box3;
+    /**
+     * When set, the geometry filter {@link boundingBox} will be considered to be in "Reveal/ThreeJS space".
+     * Rather than CDF space which is the default. When using Reveal space, the model transformation
+     * which can be specified using {@link https://docs.cognite.com/api/v1/#operation/update3DRevisions |the CDF API},
+     * or set in {@link https://fusion.cognite.com/ |Cognite Fusion}.
+     */
+    isBoundingBoxInModelCoordinates?: boolean;
+};
+export declare type CadModelSectorLoadStatistics = {
+    /**
+     * Estimated number of bytes to download sectors.
+     */
+    readonly downloadSize: number;
+    /**
+     * Estimated number of draw calls required to draw sectors.
+     */
+    readonly drawCalls: number;
+    /**
+     * Total number of sectors to load.
+     */
+    readonly loadedSectorCount: number;
+    /**
+     * Number of 'simple' sectors to load.
+     */
+    readonly simpleSectorCount: number;
+    /**
+     * Number of 'detailed' sectors to load.
+     */
+    readonly detailedSectorCount: number;
+    /**
+     * How many sectors that was "forced prioritized", e.g.
+     * because they are near the camera.
+     */
+    readonly forcedDetailedSectorCount: number;
+    /**
+     * The total number of sectors in models we are loading.
+     */
+    readonly totalSectorCount: number;
+    /**
+     * How much of the prioritized nodes that are loaded (between 0 and 1).
+     */
+    readonly accumulatedPriority: number;
+};

package/packages/cad-model/src/utilities/BoundingBoxClipper.d.ts

@@ -1,23 +1,23 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-export declare class BoundingBoxClipper {
-    private readonly _box;
-    private readonly _clippingPlanes;
-    constructor(box?: THREE.Box3);
-    set minX(x: number);
-    get minX(): number;
-    set minY(y: number);
-    get minY(): number;
-    set minZ(z: number);
-    get minZ(): number;
-    set maxX(x: number);
-    get maxX(): number;
-    set maxY(y: number);
-    get maxY(): number;
-    set maxZ(z: number);
-    get maxZ(): number;
-    private updatePlanes;
-    get clippingPlanes(): THREE.Plane[];
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+export declare class BoundingBoxClipper {
+    private readonly _box;
+    private readonly _clippingPlanes;
+    constructor(box?: THREE.Box3);
+    set minX(x: number);
+    get minX(): number;
+    set minY(y: number);
+    get minY(): number;
+    set minZ(z: number);
+    get minZ(): number;
+    set maxX(x: number);
+    get maxX(): number;
+    set maxY(y: number);
+    get maxY(): number;
+    set maxZ(z: number);
+    get maxZ(): number;
+    private updatePlanes;
+    get clippingPlanes(): THREE.Plane[];
+}

package/packages/cad-model/src/utilities/NodeIdAndTreeIndexMaps.d.ts

@@ -1,4 +1,4 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-export {};
+/*!
+ * Copyright 2021 Cognite AS
+ */
+export {};

package/packages/cad-model/src/utilities/callActionWithIndicesAsync.d.ts

@@ -1,4 +1,4 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-export declare function callActionWithIndicesAsync(startIndex: number, lastIndexInclusive: number, action: (index: number) => any, timesPerChunk?: number): Promise<void>;
+/*!
+ * Copyright 2021 Cognite AS
+ */
+export declare function callActionWithIndicesAsync(startIndex: number, lastIndexInclusive: number, action: (index: number) => any, timesPerChunk?: number): Promise<void>;

package/packages/cad-model/src/wrappers/CadNode.d.ts

@@ -1,54 +1,47 @@
-/**
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-import { NodeAppearanceProvider, NodeAppearance, PrioritizedArea } from '../../../cad-styling';
-import { SectorScene, CadModelMetadata, SectorGeometry, InstancedMeshFile, RootSectorNode, WantedSector, ConsumedSector } from '../../../cad-parsers';
-import { SectorRepository } from '../../../sector-loader';
-import { ParsedGeometry } from '../../../sector-parser';
-import { CadMaterialManager, NodeTransformProvider, RenderMode, SectorQuads } from '../../../rendering';
-export declare type ParseCallbackDelegate = (parsed: {
-    lod: string;
-    data: SectorGeometry | SectorQuads;
-}) => void;
-export declare class CadNode extends THREE.Object3D {
-    private readonly _cadModelMetadata;
-    private readonly _materialManager;
-    private readonly _instancedMeshManager;
-    private readonly _sectorRepository;
-    private _rootSector;
-    private _sectorScene;
-    private _geometryBatchingManager?;
-    constructor(model: CadModelMetadata, materialManager: CadMaterialManager, sectorRepository: SectorRepository);
-    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 cadModelIdentifier(): string;
-    get sectorScene(): SectorScene;
-    get rootSector(): RootSectorNode;
-    get materialManager(): CadMaterialManager;
-    set renderMode(mode: RenderMode);
-    get renderMode(): RenderMode;
-    loadSector(sector: WantedSector): Promise<ConsumedSector>;
-    /**
-     * 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;
-    get prioritizedAreas(): PrioritizedArea[];
-    updateInstancedMeshes(instanceMeshFiles: InstancedMeshFile[], modelIdentifier: string, sectorId: number): void;
-    discardInstancedMeshes(sectorId: number): void;
-    batchGeometry(geometryBatchingQueue: ParsedGeometry[], sectorId: number): void;
-    removeBatchedSectorGeometries(sectorId: number): void;
-    setCacheSize(sectorCount: number): void;
-    dispose(): void;
-}
+/**
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+import { NodeAppearanceProvider, NodeAppearance, PrioritizedArea } from '../../../cad-styling';
+import { SectorScene, CadModelMetadata, RootSectorNode, WantedSector, ConsumedSector } from '../../../cad-parsers';
+import { SectorRepository } from '../../../sector-loader';
+import { ParsedGeometry } from '../../../sector-parser';
+import { CadMaterialManager, NodeTransformProvider, RenderMode } from '../../../rendering';
+export declare class CadNode extends THREE.Object3D {
+    private readonly _cadModelMetadata;
+    private readonly _materialManager;
+    private readonly _sectorRepository;
+    private _rootSector;
+    private _sectorScene;
+    private _geometryBatchingManager?;
+    constructor(model: CadModelMetadata, materialManager: CadMaterialManager, sectorRepository: SectorRepository);
+    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 cadModelIdentifier(): string;
+    get sectorScene(): SectorScene;
+    get rootSector(): RootSectorNode;
+    get materialManager(): CadMaterialManager;
+    set renderMode(mode: RenderMode);
+    get renderMode(): RenderMode;
+    loadSector(sector: WantedSector): Promise<ConsumedSector>;
+    /**
+     * 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;
+    get prioritizedAreas(): PrioritizedArea[];
+    batchGeometry(geometryBatchingQueue: ParsedGeometry[], sectorId: number): void;
+    removeBatchedSectorGeometries(sectorId: number): void;
+    setCacheSize(sectorCount: number): void;
+    dispose(): void;
+}