@cognite/reveal 3.2.0 → 4.0.0-dev.20221025

package/packages/rendering/src/render-passes/types.d.ts

@@ -1,7 +1,7 @@
 /*!
  * Copyright 2022 Cognite AS
  */
-import { PotreePointShape } from '../../../pointclouds';
+import { PointShape } from '../pointcloud-rendering';
 import * as THREE from 'three';
 export declare type BlendOptions = {
     blendDestination: THREE.BlendingDstFactor;
@@ -42,17 +42,18 @@ export declare const transparentBlendOptions: BlendOptions;
 export declare type ThreeUniforms = {
     [uniform: string]: THREE.IUniform<any>;
 };
+export declare type PointCloudMaterialParameters = {
+    weighted?: boolean;
+    shape?: PointShape;
+    hqDepthPass?: boolean;
+    depthWrite?: boolean;
+    blending?: THREE.Blending;
+    blendSrc?: THREE.BlendingDstFactor | THREE.BlendingSrcFactor;
+    blendDst?: THREE.BlendingDstFactor;
+    colorWrite?: boolean;
+};
 export declare type PointCloudPassParameters = {
-    material?: {
-        weighted?: boolean;
-        shape?: PotreePointShape;
-        hqDepthPass?: boolean;
-        depthWrite?: boolean;
-        blending?: THREE.Blending;
-        blendSrc?: THREE.BlendingDstFactor | THREE.BlendingSrcFactor;
-        blendDst?: THREE.BlendingDstFactor;
-        colorWrite?: boolean;
-    };
+    material?: PointCloudMaterialParameters;
     renderer?: {
         autoClearDepth?: boolean;
     };

package/packages/rendering/src/render-pipeline-providers/DefaultRenderPipelineProvider.d.ts

@@ -7,6 +7,7 @@ import { RenderPass } from '../RenderPass';
 import { RenderPipelineProvider } from '../RenderPipelineProvider';
 import { RenderOptions } from '../rendering/types';
 import { SceneHandler } from '../../../utilities';
+import { PointCloudMaterialManager } from '../PointCloudMaterialManager';
 export declare class DefaultRenderPipelineProvider implements RenderPipelineProvider {
     private readonly _viewerScene;
     private readonly _renderTargetData;
@@ -24,7 +25,7 @@ export declare class DefaultRenderPipelineProvider implements RenderPipelineProv
     private readonly _materialManager;
     private _rendererStateHelper;
     set renderOptions(renderOptions: RenderOptions);
-    constructor(materialManager: CadMaterialManager, sceneHandler: SceneHandler, renderOptions: RenderOptions, outputRenderTarget?: {
+    constructor(materialManager: CadMaterialManager, pointCloudMaterialManager: PointCloudMaterialManager, sceneHandler: SceneHandler, renderOptions: RenderOptions, outputRenderTarget?: {
         target: THREE.WebGLRenderTarget;
         autoSize?: boolean;
     });

package/packages/rendering/src/render-pipeline-providers/PointCloudRenderPipelineProvider.d.ts

@@ -7,6 +7,7 @@ import { RenderPipelineProvider } from '../RenderPipelineProvider';
 import { SceneHandler } from '../../../utilities';
 import { PointCloudRenderTargets } from './types';
 import { PointCloudParameters } from '../rendering/types';
+import { PointCloudMaterialManager } from '../PointCloudMaterialManager';
 export declare class PointCloudRenderPipelineProvider implements RenderPipelineProvider {
     private readonly _renderTargetData;
     private readonly _renderParameters;
@@ -16,7 +17,7 @@ export declare class PointCloudRenderPipelineProvider implements RenderPipelineP
     private readonly _sceneHandler;
     private static readonly DepthPassParameters;
     private static readonly AttributePassParameters;
-    constructor(sceneHandler: SceneHandler, renderParameters: PointCloudParameters);
+    constructor(sceneHandler: SceneHandler, pointCloudMaterialManager: PointCloudMaterialManager, renderParameters: PointCloudParameters);
     get pointCloudRenderTargets(): PointCloudRenderTargets;
     pipeline(renderer: THREE.WebGLRenderer): Generator<RenderPass>;
     dispose(): void;

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

@@ -75,6 +75,10 @@ export declare const pointCloudShaders: {
         fragment: string;
         vertex: string;
     };
+    pointcloud: {
+        fragment: string;
+        vertex: string;
+    };
 };
 /**
  * Screen space ambient occlusion shader

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

@@ -1,7 +1,6 @@
 /*!
  * Copyright 2021 Cognite AS
  */
-export { SectorQuads } from '@cognite/reveal-parser-worker';
 /**
  * Anti-aliasing modes supported by Reveal.
  */

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

@@ -2,8 +2,9 @@
  * Copyright 2022 Cognite AS
  */
 import * as THREE from 'three';
+import { WebGLRendererStateHelper } from '../../../utilities';
 import { CadMaterialManager } from '../CadMaterialManager';
-import { BlitOptions, DepthBlendBlitOptions, PointCloudPostProcessingOptions } from '../render-passes/types';
+import { BlitOptions, DepthBlendBlitOptions, PointCloudPassParameters, 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;
@@ -18,7 +19,7 @@ export declare enum RenderLayer {
     Default = 0
 }
 export declare function setupCadModelsGeometryLayers(materialManager: CadMaterialManager, cadModels?: {
-    object: THREE.Object3D<THREE.Event>;
+    cadNode: THREE.Object3D;
     modelIdentifier: string;
 }[]): void;
 export declare function getLayerMask(renderLayer: number): number;
@@ -27,3 +28,4 @@ export declare function hasStyledNodes(modelIdentifiers: string[], materialManag
     inFront: boolean;
     ghost: boolean;
 };
+export declare function setRendererParameters(rendererHelper: WebGLRendererStateHelper, parameters: PointCloudPassParameters): void;

package/packages/sector-loader/index.d.ts

@@ -2,5 +2,4 @@
  * 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,5 +1,5 @@
 import { ConsumedSector, WantedSector } from '../../cad-parsers';
-import { BinaryFileProvider } from '../../modeldata-api';
+import { BinaryFileProvider } from '../../data-providers';
 import { CadMaterialManager } from '../../rendering';
 export declare class GltfSectorLoader {
     private readonly _gltfSectorParser;

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

@@ -2,7 +2,7 @@
  * Copyright 2021 Cognite AS
  */
 import { ConsumedSector, WantedSector } from '../../cad-parsers';
-import { BinaryFileProvider } from '../../modeldata-api';
+import { BinaryFileProvider } from '../../data-providers';
 import { CadMaterialManager } from '../../rendering';
 import { SectorRepository } from './SectorRepository';
 export declare class GltfSectorRepository implements SectorRepository {

package/packages/tools/index.d.ts

@@ -6,13 +6,10 @@ export { ExplodedViewTool } from './src/ExplodedViewTool';
 export { DebugCameraTool } from './src/DebugCameraTool';
 export { AxisViewTool } from './src/AxisView/AxisViewTool';
 export { AxisBoxConfig, AxisBoxCompassConfig, AxisBoxFaceConfig, Corner, AbsolutePosition, RelativePosition } from './src/AxisView/types';
-export { GeomapTool } from './src/Geomap/GeomapTool';
-export { MapConfig, MapProviders, BingMapConfig, HereMapConfig, MapboxConfig, MapboxMode, MapboxStyle, MapboxImageFormat, BingMapType, BingMapImageFormat, HereMapType, HereMapScheme, HereMapImageFormat } from './src/Geomap/MapConfig';
 export { TimelineTool } from './src/Timeline/TimelineTool';
 export { Keyframe } from './src/Timeline/Keyframe';
 export { TimelineDateUpdateDelegate } from './src/Timeline/types';
 export { Cognite3DViewerToolBase } from './src/Cognite3DViewerToolBase';
-export { DebugLoadedSectorsTool, DebugLoadedSectorsToolOptions } from './src/DebugLoadedSectorsTool';
 export { MeasurementTool } from './src/Measurement/MeasurementTool';
 export { Measurement } from './src/Measurement/MeasurementManager';
 export { MeasurementOptions, MeasurementAddedDelegate, MeasurementStartedDelegate, MeasurementEndedDelegate } from './src/Measurement/types';

package/packages/tools/src/Cognite3DViewerToolBase.d.ts

@@ -2,7 +2,7 @@
  * Copyright 2021 Cognite AS
  */
 /**
- * Base class for tools attaching to a {@see Cognite3DViewer}.
+ * Base class for tools attaching to a {@link Cognite3DViewer}.
  */
 export declare abstract class Cognite3DViewerToolBase {
     private readonly _disposedEvent;

package/packages/tools/src/HtmlOverlay/HtmlOverlayTool.d.ts

@@ -59,7 +59,7 @@ export declare type HtmlOverlayToolOptions = {
 };
 /**
  
- * Manages HTMLoverlays for {@see Cognite3DViewer}. Attaches HTML elements to a
+ * Manages HTMLoverlays for {@link Cognite3DViewer}. Attaches HTML elements to a
  * 3D position and updates its position/visibility as user moves the camera. This is
  * useful to create HTML overlays to highlight information about key positions in the 3D model.
  *

package/packages/tools/src/Measurement/MeasurementTool.d.ts

@@ -8,7 +8,7 @@ import * as THREE from 'three';
 import { MeasurementAddedDelegate, MeasurementStartedDelegate, MeasurementEndedDelegate, MeasurementOptions } from './types';
 import { Measurement } from './MeasurementManager';
 /**
- * Enables {@see Cognite3DViewer} to perform a point to point measurement.
+ * Enables {@link Cognite3DViewer} to perform a point to point measurement.
  * This can be achieved by selecting a point on the 3D Object and drag the pointer to
  * required point to get measurement of the distance.
  * The tools default measurement is in "Meters" as supported in Reveal, but it also provides

package/packages/utilities/index.d.ts

@@ -6,7 +6,7 @@ export { transformCameraConfiguration } from './src/transformCameraConfiguration
 export { RandomColors } from './src/RandomColors';
 export { CameraConfiguration } from './src/CameraConfiguration';
 export { EventTrigger, clickOrTouchEventOffset, InputHandler, disposeOfAllEventListeners } from './src/events';
-export { DisposedDelegate, SceneRenderedDelegate, PointerEventDelegate, PointerEventData } from './src/events/types';
+export { DisposedDelegate, BeforeSceneRenderedDelegate, SceneRenderedDelegate, PointerEventDelegate, PointerEventData } from './src/events/types';
 export { assertNever } from './src/assertNever';
 export { NumericRange } from './src/NumericRange';
 export { determinePowerOfTwoDimensions } from './src/determinePowerOfTwoDimensions';
@@ -15,22 +15,25 @@ export { DynamicDefragmentedBuffer } from './src/datastructures/DynamicDefragmen
 export { AutoDisposeGroup } from './src/three/AutoDisposeGroup';
 export { BoundingBoxLOD } from './src/three/BoundingBoxLOD';
 export { toThreeBox3 } from './src/three/toThreeBox3';
+export { fromThreeVector3 } from './src/three/fromThreeVector3';
 export { unionBoxes } from './src/three/unionBoxes';
 export { determineCurrentDevice, DeviceDescriptor } from './src/device';
 export { createRenderTriangle } from './src/three/createFullScreenTriangleGeometry';
 export { fitCameraToBoundingBox } from './src/three/fitCameraToBoundingBox';
 export { isBox3OnPositiveSideOfPlane } from './src/three/isBox3OnPositiveSideOfPlane';
 export { visitBox3CornerPoints } from './src/three/visitBox3CornerPoints';
+export { createDistinctColors } from './src/three/createDistinctColors';
 export { isMobileOrTablet } from './src/isMobileOrTablet';
 export { WebGLRendererStateHelper } from './src/WebGLRendererStateHelper';
-export { WorkerPool } from './src/workers/WorkerPool';
 export { TypedArray, TypedArrayConstructor } from './src/types';
 export { MemoryRequestCache } from './src/cache/MemoryRequestCache';
 export { MostFrequentlyUsedCache } from './src/cache/MostFrequentlyUsedCache';
 export { disposeAttributeArrayOnUpload } from './src/disposeAttributeArrayOnUpload';
-export { revealEnv } from './src/revealEnv';
 export { incrementOrInsertIndex, decrementOrDeleteIndex } from './src/counterMap';
 export { calculateVolumeOfMesh } from './src/calculateVolumeOfMesh';
-export { worldToNormalizedViewportCoordinates, worldToViewportCoordinates } from './src/worldToViewport';
+export { worldToNormalizedViewportCoordinates, worldToViewportCoordinates, pixelToNormalizedDeviceCoordinates } from './src/worldToViewport';
 export { DeferredPromise } from './src/DeferredPromise';
 export { SceneHandler } from './src/SceneHandler';
+export * from './src/workers/workerize-transferable';
+export * from './src/shapes';
+export * from './src/linalg';

package/packages/utilities/src/SceneHandler.d.ts

@@ -9,19 +9,19 @@ export declare class SceneHandler {
     private readonly _customObjects;
     get scene(): THREE.Scene;
     get cadModels(): {
-        object: THREE.Object3D;
+        cadNode: THREE.Object3D;
         modelIdentifier: string;
     }[];
     get pointCloudModels(): {
-        object: THREE.Object3D;
+        pointCloudNode: THREE.Object3D;
         modelIdentifier: symbol;
     }[];
     get customObjects(): THREE.Object3D[];
     constructor();
-    addCadModel(object: THREE.Object3D, modelIdentifier: string): void;
-    addPointCloudModel(object: THREE.Object3D, modelIdentifier: symbol): void;
-    removePointCloudModel(object: THREE.Object3D): void;
-    removeCadModel(object: THREE.Object3D): void;
+    addCadModel(cadNode: THREE.Object3D, modelIdentifier: string): void;
+    addPointCloudModel(pointCloudNode: THREE.Object3D, modelIdentifier: symbol): void;
+    removePointCloudModel(pointCloudNode: THREE.Object3D): void;
+    removeCadModel(cadNode: THREE.Object3D): void;
     addCustomObject(object: THREE.Object3D): void;
     removeCustomObject(object: THREE.Object3D): void;
     dispose(): void;

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

@@ -21,7 +21,15 @@ export declare type PointerEventData = {
  */
 export declare type DisposedDelegate = () => void;
 /**
- * Delegate for rendering events.
+ * Delegate for event triggered when scene is about to be rendered.
+ */
+export declare type BeforeSceneRenderedDelegate = (event: {
+    frameNumber: number;
+    renderer: THREE.WebGLRenderer;
+    camera: THREE.PerspectiveCamera;
+}) => void;
+/**
+ * Delegate for event triggered when scene has been rendered.
  * @module @cognite/reveal
  */
 export declare type SceneRenderedDelegate = (event: {

package/packages/utilities/src/linalg.d.ts

@@ -0,0 +1,11 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+export declare type Vec3 = [number, number, number];
+export declare type AABB = {
+    min: Vec3;
+    max: Vec3;
+};
+export declare type Mat4 = {
+    data: number[];
+};

package/packages/utilities/src/shapes/Box.d.ts

@@ -0,0 +1,12 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+import { Matrix4, Box3 } from 'three';
+import { IShape } from './IShape';
+import { SerializableBox } from './SerializableBox';
+export declare class Box implements IShape {
+    private readonly _invInstanceMatrix;
+    constructor(instanceMatrix: Matrix4);
+    getSerializableShape(): SerializableBox;
+    createBoundingBox(): Box3;
+}

package/packages/utilities/src/shapes/CompositeShape.d.ts

@@ -0,0 +1,13 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+import { IShape } from './IShape';
+import { SerializableCompositeShape } from './SerializableCompositeShape';
+import { Box3 } from 'three';
+export declare class CompositeShape implements IShape {
+    private readonly _innerShapes;
+    constructor(innerShapes: IShape[]);
+    get innerShapes(): IShape[];
+    getSerializableShape(): SerializableCompositeShape;
+    createBoundingBox(): Box3;
+}

package/packages/utilities/src/shapes/Cylinder.d.ts

@@ -0,0 +1,14 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+import { IShape } from './IShape';
+import { SerializableCylinder } from './SerializableCylinder';
+import { Box3, Vector3 } from 'three';
+export declare class Cylinder implements IShape {
+    private readonly _centerA;
+    private readonly _centerB;
+    private readonly _radius;
+    constructor(centerA: Vector3, centerB: Vector3, radius: number);
+    getSerializableShape(): SerializableCylinder;
+    createBoundingBox(): Box3;
+}

package/packages/utilities/src/shapes/ISerializableShape.d.ts

@@ -0,0 +1,11 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+export declare enum ShapeType {
+    Box = 0,
+    Cylinder = 1,
+    Composite = 2
+}
+export interface ISerializableShape {
+    readonly shapeType: ShapeType;
+}

package/packages/utilities/src/shapes/IShape.d.ts

@@ -0,0 +1,9 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+import { ISerializableShape } from './ISerializableShape';
+import { Box3 } from 'three';
+export interface IShape {
+    getSerializableShape(): ISerializableShape;
+    createBoundingBox(): Box3;
+}

package/packages/utilities/src/shapes/SerializableBox.d.ts

@@ -0,0 +1,8 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+import { ISerializableShape } from './ISerializableShape';
+import { Mat4 } from '../linalg';
+export declare type SerializableBox = ISerializableShape & {
+    readonly invMatrix: Mat4;
+};

package/packages/utilities/src/shapes/SerializableCompositeShape.d.ts

@@ -0,0 +1,7 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+import { ISerializableShape } from './ISerializableShape';
+export declare type SerializableCompositeShape = ISerializableShape & {
+    readonly innerShapes: ISerializableShape[];
+};

package/packages/utilities/src/shapes/SerializableCylinder.d.ts

@@ -0,0 +1,10 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+import { ISerializableShape } from './ISerializableShape';
+import { Vec3 } from '../linalg';
+export declare type SerializableCylinder = ISerializableShape & {
+    centerA: Vec3;
+    centerB: Vec3;
+    radius: number;
+};

package/packages/utilities/src/shapes/index.d.ts

@@ -0,0 +1,11 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+export { SerializableBox } from './SerializableBox';
+export { SerializableCylinder } from './SerializableCylinder';
+export { SerializableCompositeShape } from './SerializableCompositeShape';
+export { ISerializableShape, ShapeType } from './ISerializableShape';
+export { IShape } from './IShape';
+export { Box } from './Box';
+export { Cylinder } from './Cylinder';
+export { CompositeShape } from './CompositeShape';

package/packages/utilities/src/three/createDistinctColors.d.ts

@@ -0,0 +1,5 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+import * as THREE from 'three';
+export declare function createDistinctColors(count: number): THREE.Color[];

package/packages/utilities/src/three/fromThreeVector3.d.ts

@@ -0,0 +1,5 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+import * as THREE from 'three';
+export declare function fromThreeVector3(vec: THREE.Vector3): [number, number, number];

package/packages/utilities/src/workers/workerize-transferable/index.d.ts

@@ -0,0 +1,7 @@
+/*!
+ * Adopted from https://github.com/naoak/workerize-transferable
+ */
+export * from './message-types';
+export * from './on-main';
+export * from './on-worker';
+export * from './util';

package/packages/utilities/src/workers/workerize-transferable/message-types.d.ts

@@ -0,0 +1,4 @@
+/*!
+ * Adopted from https://github.com/naoak/workerize-transferable
+ */
+export declare const MESSAGE_TYPE_RPC_TRANSFERABLE = "RPC_transferable";

package/packages/utilities/src/workers/workerize-transferable/on-main.d.ts

@@ -0,0 +1,13 @@
+/** Options for worker method params */
+export declare type WorkerMethodParamsOptions = {
+    /** pick transferables from method params */
+    pickTransferablesFromParams?: (params: any) => any[];
+};
+/**
+ * Setup worker methods which receive transferables from worker method params. This function should be executed on the main thread.
+ * @param worker worker instance
+ * @param methods an object whose key is method name and whose value is options how to pick transferables from method params
+ */
+export declare function setupTransferableMethodsOnMain<WORKER extends Worker>(worker: WORKER, methods: {
+    [x: string]: WorkerMethodParamsOptions;
+}): void;

package/packages/utilities/src/workers/workerize-transferable/on-worker.d.ts

@@ -0,0 +1,14 @@
+/** Options for worker method result */
+export declare type WorkerMethodResultOptions = {
+    /** worker method */
+    fn: (...params: any[]) => any;
+    /** pick transferables from method result */
+    pickTransferablesFromResult?: (result: any) => any[];
+};
+/**
+ * Setup worker methods which return transferables. This function should be executed on the worker thread.
+ * @param methods an object whose key is method name and whose value is options how to pick transferables from method result
+ */
+export declare function setupTransferableMethodsOnWorker(methods: {
+    [x: string]: WorkerMethodResultOptions;
+}): void;

package/packages/utilities/src/workers/workerize-transferable/util.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Get the global scope for browsers that do not support globalThis
+ * https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/globalThis
+ */
+export declare function getGlobalThis(): typeof globalThis;
+/**
+ * Test if an object is transferable
+ * @param x Object
+ */
+export declare function isTransferableObject(x: any): boolean;

package/packages/utilities/src/worldToViewport.d.ts

@@ -28,3 +28,7 @@ export declare function worldToNormalizedViewportCoordinates(camera: THREE.Persp
  * is within near/far of camera.
  */
 export declare function worldToViewportCoordinates(renderer: THREE.WebGLRenderer, camera: THREE.PerspectiveCamera, position3D: THREE.Vector3, out?: THREE.Vector3): THREE.Vector3;
+/**
+ * Converts a pixel coordinate to normalized device coordinate (in range [-1, 1])
+ */
+export declare function pixelToNormalizedDeviceCoordinates(x: number, y: number, width: number, height: number): THREE.Vector2;