@cognite/reveal 4.0.0-dev.20221123 → 4.0.0-dev.20221124

package/dist/packages/api/index.d.ts

@@ -5,5 +5,6 @@ export { Cognite3DViewer } from './src/public/migration/Cognite3DViewer';
 export { CogniteCadModel } from '../cad-model';
 export { ViewerState, ModelState } from './src/utilities/ViewStateHelper';
 export * from './src/public/types';
+export { CDF_TO_VIEWER_TRANSFORMATION } from './src/public/constants';
 declare const REVEAL_VERSION: string;
 export { REVEAL_VERSION };

package/dist/packages/api/src/public/constants.d.ts

@@ -0,0 +1,11 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+import { Matrix4 } from 'three';
+/**
+ * The transformation matrix from CDF coordinates to ThreeJS/Reveal.
+ * Note that this is already applied to {@link CogniteCadModel} and {@link CognitePointCloudModel}
+ * automatically, as it is factored into the matrix returned from e.g.
+ * the {@link CogniteCadModel.getCdfToDefaultModelTransformation} method.
+ */
+export declare const CDF_TO_VIEWER_TRANSFORMATION: Matrix4;

package/dist/packages/api/src/public/migration/types.d.ts

@@ -129,7 +129,7 @@ export interface Cognite3DViewerOptions {
      * the camera is moving. Note that this option should left to false on
      * low-end devices as more loading can cause frame drops.
      *
-     * Default value is set to false.
+     * Default value is set to true.
      */
     continuousModelStreaming?: boolean;
 }

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

@@ -1,26 +1,28 @@
 /**
  * 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 {
+import { Object3D, Plane, Matrix4 } from 'three';
+export declare class CadNode extends Object3D {
     private readonly _cadModelMetadata;
     private readonly _materialManager;
     private readonly _sectorRepository;
     private _rootSector;
     private _sectorScene;
     private _geometryBatchingManager?;
+    private readonly _sourceTransform;
+    private readonly _customTransform;
     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 clippingPlanes(): Plane[];
+    set clippingPlanes(planes: Plane[]);
     get cadModelMetadata(): CadModelMetadata;
     get cadModelIdentifier(): string;
     get sectorScene(): SectorScene;
@@ -33,12 +35,13 @@ export declare class CadNode extends THREE.Object3D {
      * Sets transformation matrix of the model. This overrides the current transformation.
      * @param matrix Transformation matrix.
      */
-    setModelTransformation(matrix: THREE.Matrix4): void;
+    setModelTransformation(matrix: Matrix4): void;
     /**
      * Gets transformation matrix of the model
      * @param out Preallocated `THREE.Matrix4` (optional).
      */
-    getModelTransformation(out?: THREE.Matrix4): THREE.Matrix4;
+    getModelTransformation(out?: Matrix4): Matrix4;
+    getCdfToDefaultModelTransformation(out?: Matrix4): Matrix4;
     get prioritizedAreas(): PrioritizedArea[];
     batchGeometry(geometryBatchingQueue: ParsedGeometry[], sectorId: number): void;
     removeBatchedSectorGeometries(sectorId: number): void;

package/dist/packages/cad-model/src/wrappers/CogniteCadModel.d.ts

@@ -125,45 +125,6 @@ export declare class CogniteCadModel implements CdfModelNodeCollectionDataProvid
      * @param applyToChildren
      */
     resetNodeTransformByTreeIndex(treeIndex: number, applyToChildren?: boolean): Promise<number>;
-    /**
-     * Maps a position retrieved from the CDF API (e.g. 3D node information) to
-     * coordinates in "ThreeJS model space". This is necessary because CDF has a right-handed
-     * Z-up coordinate system while ThreeJS uses a right-hand Y-up coordinate system.
-     * @param p     The CDF coordinate to transform.
-     * @param out   Optional preallocated buffer for storing the result. May be `p`.
-     * @returns Transformed position.
-     */
-    mapFromCdfToModelCoordinates(p: THREE.Vector3, out?: THREE.Vector3): THREE.Vector3;
-    /**
-     * Maps from a 3D position in "ThreeJS model space" (e.g. a ray intersection coordinate)
-     * to coordinates in "CDF space". This is necessary because CDF has a right-handed
-     * Z-up coordinate system while ThreeJS uses a right-hand Y-up coordinate system.
-     * This function also accounts for transformation applied to the model.
-     * @param p       The ThreeJS coordinate to transform.
-     * @param out     Optional preallocated buffer for storing the result. May be `p`.
-     * @returns Transformed position.
-     */
-    mapPositionFromModelToCdfCoordinates(p: THREE.Vector3, out?: THREE.Vector3): THREE.Vector3;
-    /**
-     * Maps from a 3D position in "ThreeJS model space" to coordinates in "CDF space".
-     * This is necessary because CDF has a right-handed Z-up coordinate system while ThreeJS
-     * uses a right-hand Y-up coordinate system. This function also accounts for transformation
-     * applied to the model.
-     * @param box     The box in ThreeJS/model coordinates.
-     * @param out     Optional preallocated buffer for storing the result. May be same input as `box`.
-     * @returns       Transformed box.
-     */
-    mapBoxFromModelToCdfCoordinates(box: THREE.Box3, out?: THREE.Box3): THREE.Box3;
-    /**
-     * Maps from a 3D position in "CDF space" to coordinates in "ThreeJS model space".
-     * This is necessary because CDF has a right-handed Z-up coordinate system while ThreeJS
-     * uses a right-hand Y-up coordinate system. This function also accounts for transformation
-     * applied to the model.
-     * @param box     The box in CDF model coordinates.
-     * @param out     Optional preallocated buffer for storing the result. May be same input as `box`.
-     * @returns       Transformed box.
-     */
-    mapBoxFromCdfToModelCoordinates(box: THREE.Box3, out?: THREE.Box3): THREE.Box3;
     /**
      * Cleans up used resources.
      */
@@ -218,10 +179,17 @@ export declare class CogniteCadModel implements CdfModelNodeCollectionDataProvid
      */
     setModelTransformation(matrix: THREE.Matrix4): void;
     /**
-     * Gets transformation matrix of the model.
+     * Gets transformation matrix that has previously been set with {@link CogniteCadModel.setModelTransformation}.
      * @param out Preallocated `THREE.Matrix4` (optional).
      */
     getModelTransformation(out?: THREE.Matrix4): THREE.Matrix4;
+    /**
+     * Gets transformation from CDF space to ThreeJS space,
+     * which includes any additional "default" transformations assigned to this model.
+     * Does not include any custom transformations set by {@link CognitePointcloudmodel.setModelTransformation}
+     * @param out Preallocated `THREE.Matrix4` (optional)
+     */
+    getCdfToDefaultModelTransformation(out?: THREE.Matrix4): THREE.Matrix4;
     /**
      * Fetches a bounding box from the CDF by the nodeId.
      * @param nodeId

package/dist/packages/cad-styling/src/CdfModelNodeCollectionDataProvider.d.ts

@@ -7,13 +7,15 @@ import * as THREE from 'three';
  */
 export interface CdfModelNodeCollectionDataProvider {
     /**
-     * Maps a box from Reveal space to CDF space
+     * Gets the transformation of the model in ThreeJS space
      */
-    mapBoxFromModelToCdfCoordinates: (box: THREE.Box3, out?: THREE.Box3) => THREE.Box3;
+    getModelTransformation(out?: THREE.Matrix4): THREE.Matrix4;
     /**
-     * Maps a box from CDF space to Reveal space
+     * Gets the default transformation of the model from CDF space.
+     * The current total transformation of the model from the backend to its transform in ThreeJS space
+     * is thus `model.getCdfToDefaultModelTransformation() * model.getModelTransformation()`.
      */
-    mapBoxFromCdfToModelCoordinates: (box: THREE.Box3, out?: THREE.Box3) => THREE.Box3;
+    getCdfToDefaultModelTransformation(out?: THREE.Matrix4): THREE.Matrix4;
     /**
      * Total count of nodes in the model
      */

package/dist/packages/cad-styling/src/CdfNodeCollectionBase.d.ts

@@ -6,7 +6,7 @@ import { IndexSet } from '../../utilities';
 export declare abstract class CdfNodeCollectionBase extends NodeCollection {
     private _indexSet;
     private _areas;
-    private readonly _boundsMapper;
+    private readonly _cadModelData;
     private _fetchResultHelper;
     constructor(classToken: string, model: CdfModelNodeCollectionDataProvider);
     get isLoading(): boolean;

package/dist/packages/data-providers/index.d.ts

@@ -17,5 +17,6 @@ export { PointCloudStylableObjectProvider } from './src/PointCloudStylableObject
 export { StylableObject, SerializableStylableObject } from './src/pointcloud-stylable-object-providers/StylableObject';
 export { CdfPointCloudStylableObjectProvider } from './src/pointcloud-stylable-object-providers/CdfPointCloudStylableObjectProvider';
 export { DummyPointCloudStylableObjectProvider } from './src/pointcloud-stylable-object-providers/DummyPointCloudStylableObjectProvider';
+export { cadFromCdfToThreeMatrix } from './src/utilities/applyDefaultModelTransformation';
 export { Image360Provider } from './src/Image360Provider';
 export { BinaryFileProvider, JsonFileProvider, File3dFormat, BlobOutputMetadata, Image360Descriptor, Image360FileProvider, Image360Face } from './src/types';

package/dist/packages/data-providers/src/utilities/applyDefaultModelTransformation.d.ts

@@ -3,4 +3,5 @@
  */
 import * as THREE from 'three';
 import { File3dFormat } from '../types';
+export declare const cadFromCdfToThreeMatrix: THREE.Matrix4;
 export declare function applyDefaultModelTransformation(matrix: THREE.Matrix4, format: File3dFormat | string): void;

package/dist/packages/pointclouds/src/CognitePointCloudModel.d.ts

@@ -48,14 +48,22 @@ export declare class CognitePointCloudModel {
     getCameraConfiguration(): CameraConfiguration | undefined;
     /**
      * Sets transformation matrix of the model. This overrides the current transformation.
-     * @param transformationMatrix
+     * @param transformationMatrix The new transformation matrix
      */
     setModelTransformation(transformationMatrix: THREE.Matrix4): void;
     /**
-     * Gets transformation matrix of the model.
+     * Gets transformation matrix that has previously been
+     * set with {@link CognitePointCloudmodel.setModelTransformation}.
      * @param out Preallocated `THREE.Matrix4` (optional).
      */
     getModelTransformation(out?: THREE.Matrix4): THREE.Matrix4;
+    /**
+     * Gets transformation from CDF space to ThreeJS space,
+     * which includes any additional "default" transformations assigned to this model.
+     * Does not include any custom transformations set by {@link CognitePointcloudmodel.setModelTransformation}
+     * @param out Preallocated `THREE.Matrix4` (optional)
+     */
+    getCdfToDefaultModelTransformation(out?: THREE.Matrix4): THREE.Matrix4;
     /**
      * Sets a visible filter on points of a given class.
      * @param pointClass ASPRS classification class code. Either one of the well known

package/dist/packages/pointclouds/src/PointCloudNode.d.ts

@@ -1,14 +1,14 @@
 /*!
  * Copyright 2021 Cognite AS
  */
-import * as THREE from 'three';
 import { CameraConfiguration } from '../../utilities';
 import { ClassificationInfo, PointCloudOctree, PickPoint } from './potree-three-loader';
 import { WellKnownAsprsPointClassCodes } from './types';
 import { PointColorType, PointShape, PointSizeType } from '../../rendering';
 import { PointCloudObjectMetadata, PointCloudObject } from '../../data-providers';
 import { CompletePointCloudAppearance, StyledPointCloudObjectCollection } from '../../pointcloud-styling';
-export declare class PointCloudNode extends THREE.Group {
+import { Matrix4, Group } from 'three';
+export declare class PointCloudNode extends Group {
     private readonly _cameraConfiguration?;
     private readonly _octree;
     private readonly _annotations;
@@ -16,7 +16,9 @@ export declare class PointCloudNode extends THREE.Group {
     private _needsRedraw;
     private static readonly pickingWindowSize;
     private readonly _modelIdentifier;
-    constructor(modelIdentifier: symbol, octree: PointCloudOctree, annotations: PointCloudObject[], classificationInfo: ClassificationInfo, cameraConfiguration?: CameraConfiguration);
+    private readonly _sourceTransform;
+    private readonly _customTransform;
+    constructor(modelIdentifier: symbol, sourceTransform: Matrix4, octree: PointCloudOctree, annotations: PointCloudObject[], classificationInfo: ClassificationInfo, cameraConfiguration?: CameraConfiguration);
     get modelIdentifier(): symbol;
     get octree(): PointCloudOctree;
     get needsRedraw(): boolean;
@@ -73,7 +75,8 @@ export declare class PointCloudNode extends THREE.Group {
     }>;
     getBoundingBox(outBbox?: THREE.Box3): THREE.Box3;
     setModelTransformation(matrix: THREE.Matrix4): void;
-    getModelTransformation(out?: THREE.Matrix4): THREE.Matrix4;
+    getModelTransformation(out?: Matrix4): THREE.Matrix4;
+    getCdfToDefaultModelTransformation(out?: Matrix4): Matrix4;
     get stylableObjectAnnotationMetadata(): Iterable<PointCloudObjectMetadata>;
     get stylableObjects(): PointCloudObject[];
     get defaultAppearance(): CompletePointCloudAppearance;

package/dist/packages/rendering/src/CadMaterialManager.d.ts

@@ -27,6 +27,7 @@ export declare class CadMaterialManager {
     getModelBackTreeIndices(modelIdentifier: string): IndexSet;
     getModelInFrontTreeIndices(modelIdentifier: string): IndexSet;
     getModelGhostedTreeIndices(modelIdentifier: string): IndexSet;
+    getModelVisibleTreeIndices(modelIdentifier: string): IndexSet;
     setRenderMode(mode: RenderMode): void;
     getRenderMode(): RenderMode;
     dispose(): void;

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

@@ -15,6 +15,7 @@ export declare class NodeAppearanceTextureBuilder {
     private readonly _regularNodesTreeIndices;
     private readonly _ghostedNodesTreeIndices;
     private readonly _infrontNodesTreeIndices;
+    private readonly _visibleNodesTreeIndices;
     constructor(treeIndexCount: number, styleProvider: NodeAppearanceProvider);
     getDefaultAppearance(): NodeAppearance;
     /**
@@ -27,6 +28,7 @@ export declare class NodeAppearanceTextureBuilder {
     get regularNodeTreeIndices(): IndexSet;
     get ghostedNodeTreeIndices(): IndexSet;
     get infrontNodeTreeIndices(): IndexSet;
+    get visibleNodeTreeIndices(): IndexSet;
     get needsUpdate(): boolean;
     /**
      * A texture holding at least one element per node with color override

package/dist/packages/tools/index.d.ts

@@ -2,7 +2,6 @@
  * Copyright 2021 Cognite AS
  */
 export { HtmlOverlayTool, HtmlOverlayOptions, HtmlOverlayPositionUpdatedDelegate, HtmlOverlayCreateClusterDelegate } from './src/HtmlOverlay/HtmlOverlayTool';
-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';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cognite/reveal",
-  "version": "4.0.0-dev.20221123",
+  "version": "4.0.0-dev.20221124",
   "description": "WebGL based 3D viewer for CAD and point clouds processed in Cognite Data Fusion.",
   "homepage": "https://github.com/cognitedata/reveal/tree/master/viewer",
   "repository": {
@@ -81,11 +81,11 @@
     "proj4": "2.8.0",
     "rxjs": "7.5.7",
     "skmeans": "0.11.3",
-    "three-stdlib": "2.17.3"
+    "three-stdlib": "2.18.1"
   },
   "devDependencies": {
     "@azure/msal-browser": "2.31.0",
-    "@cognite/sdk": "7.11.0",
+    "@cognite/sdk": "7.12.0",
     "@cognite/sdk-core": "4.4.0",
     "@types/dat.gui": "0.7.7",
     "@types/expect-puppeteer": "5.0.2",
@@ -152,7 +152,7 @@
     "workerize-loader": "2.0.2"
   },
   "peerDependencies": {
-    "@cognite/sdk": "7.11.0",
+    "@cognite/sdk": "7.12.0",
     "@cognite/sdk-core": "^4.1.0",
     "three": "0.146.0"
   },

package/dist/packages/tools/src/ExplodedViewTool.d.ts

@@ -1,12 +0,0 @@
-import { Cognite3DViewerToolBase } from './Cognite3DViewerToolBase';
-import { CogniteCadModel } from '../../api';
-export declare class ExplodedViewTool extends Cognite3DViewerToolBase {
-    private readonly _cadModel;
-    private _treeBoundingBoxdata;
-    private readonly _rootTreeIndex;
-    get readyPromise(): Promise<void>;
-    constructor(treeIndex: number, cadModel: CogniteCadModel);
-    expand(expandRadius: number): Promise<void>;
-    reset(): void;
-    private preloadBoundingBoxData;
-}