@cognite/reveal 4.12.1 → 4.13.0

package/dist/packages/camera-manager/src/Flexible/IFlexibleCameraManager.d.ts

@@ -41,5 +41,49 @@ export interface IFlexibleCameraManager extends CameraManager {
      * @param callback - The callback function to be removed from the controls type change listeners.
      */
     removeControlsTypeChangeListener(callback: FlexibleControlsTypeChangeDelegate): void;
+    /**
+     * Called when a click event is triggered
+     * @beta
+     */
+    onClick(event: PointerEvent): Promise<void>;
+    /**
+     * Called when double click event is triggered
+     * @beta
+     */
+    onDoubleClick(event: PointerEvent): Promise<void>;
+    /**
+     * Called when pointer is pressed
+     * @beta
+     */
+    onPointerDown(event: PointerEvent, leftButton: boolean): Promise<void>;
+    /**
+     * Called when pointer is dragged
+     * @beta
+     */
+    onPointerDrag(event: PointerEvent, leftButton: boolean): Promise<void>;
+    /**
+     * Called when pointer is released
+     * @beta
+     */
+    onPointerUp(event: PointerEvent, leftButton: boolean): Promise<void>;
+    /**
+     * Called when wheel event is triggered
+     * @beta
+     */
+    onWheel(event: WheelEvent): Promise<void>;
+    /**
+     * Called when a key is pressed or released
+     * @beta
+     */
+    onKey(event: KeyboardEvent, down: boolean): void;
+    /**
+     * Called when focus is changed
+     * @beta
+     */
+    onFocusChanged(haveFocus: boolean): void;
 }
-export declare function asFlexibleCameraManager(manager: CameraManager): IFlexibleCameraManager | undefined;
+/**
+ * Check id the CameraManager is a IFlexibleCameraManager
+ * @beta
+ */
+export declare function isFlexibleCameraManager(manager: CameraManager): manager is IFlexibleCameraManager;

package/dist/packages/camera-manager/src/Keyboard.d.ts

@@ -6,10 +6,8 @@ type EventCode = (typeof EVENT_CODES)[number];
 export default class Keyboard {
     private readonly _keys;
     private _isEnabled;
-    private readonly _domElement;
     get isEnabled(): boolean;
     set isEnabled(value: boolean);
-    constructor(domElement: HTMLElement);
     isPressed(key: EventCode): boolean;
     isShiftPressed(): boolean;
     isShiftPressedOnly(): boolean;
@@ -17,7 +15,6 @@ export default class Keyboard {
     isCtrlPressedOnly(): boolean;
     isAltPressed(): boolean;
     isMetaPressed(): boolean;
-    dispose(): void;
     /**
      * Given two keys representing positive and negative directions (e.g., left and right, or up and down),
      * this method returns 1 for the positive key, -1 for the negative key, or 0 if neither or both is pressed.
@@ -27,10 +24,11 @@ export default class Keyboard {
      * @returns A value indicating the direction of movement: 1 (positive), -1 (negative), or 0 (none).
      */
     getKeyboardMovementValue(positiveKey: EventCode, negativeKey: EventCode): number;
-    private readonly addEventListeners;
-    private readonly removeEventListeners;
+    addEventListeners(domElement: HTMLElement): void;
+    removeEventListeners(domElement: HTMLElement): void;
     private readonly onKeyDown;
     private readonly onKeyUp;
+    onKey(event: KeyboardEvent, down: boolean): void;
     readonly clearPressedKeys: () => void;
 }
 export {};

package/dist/packages/camera-manager/src/types.d.ts

@@ -1,29 +1,30 @@
 /*!
  * Copyright 2021 Cognite AS
  */
+import type { Box3, Quaternion, Vector3 } from 'three';
 export type ControlsState = {
-    position: THREE.Vector3;
-    target: THREE.Vector3;
+    position: Vector3;
+    target: Vector3;
 };
 export type CameraState = {
     /**
      * Camera position in world space.
      */
-    position?: THREE.Vector3;
+    position?: Vector3;
     /**
      * Camera target in world space.
      * **/
-    target?: THREE.Vector3;
+    target?: Vector3;
     /**
      * Camera local rotation in quaternion form.
      */
-    rotation?: THREE.Quaternion;
+    rotation?: Quaternion;
 };
 /**
  * Delegate for camera update events.
  * @module @cognite/reveal
  */
-export type CameraChangeDelegate = (position: THREE.Vector3, target: THREE.Vector3) => void;
+export type CameraChangeDelegate = (position: Vector3, target: Vector3) => void;
 /**
  * Delegate for camera update events.
  * @module @cognite/reveal
@@ -41,7 +42,7 @@ export type CameraManagerCallbackData = {
         /**
          * Coordinate of the intersection.
          */
-        point: THREE.Vector3;
+        point: Vector3;
         /**
          * Distance from the camera to the intersection.
          */
@@ -50,11 +51,11 @@ export type CameraManagerCallbackData = {
     /**
      * Bounding box for all models on the scene
      */
-    modelsBoundingBox: THREE.Box3;
+    modelsBoundingBox: Box3;
     /**
      * Bounding box for the object (node in a model) that was picked
      */
-    pickedBoundingBox: THREE.Box3 | undefined;
+    pickedBoundingBox: Box3 | undefined;
 };
 /**
  * List of supported event types (adapted from https://stackoverflow.com/questions/44480644/string-union-to-string-array)

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

@@ -3,6 +3,7 @@
  */
 import { AnnotationsAssetRef } from '@cognite/sdk';
 import { CognitePointCloudModel } from './CognitePointCloudModel';
+import type { Vector3 } from 'three';
 export type PointCloudIntersection = {
     /**
      * The intersection type.
@@ -15,7 +16,7 @@ export type PointCloudIntersection = {
     /**
      * Coordinate of the intersection.
      */
-    point: THREE.Vector3;
+    point: Vector3;
     /**
      * The index of the point that was intersected.
      */

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

@@ -7,7 +7,7 @@ import { WellKnownAsprsPointClassCodes } from './types';
 import { PointColorType, PointShape, PointSizeType } from '../../rendering';
 import { PointCloudObjectMetadata, PointCloudObject } from '../../data-providers';
 import { CompletePointCloudAppearance, StyledPointCloudObjectCollection } from '../../pointcloud-styling';
-import { Matrix4, Group, Color } from 'three';
+import { Matrix4, Group, Box3, Color, type Camera, type Plane, type Ray, type WebGLRenderer } from 'three';
 export declare class PointCloudNode extends Group {
     private readonly _cameraConfiguration?;
     private readonly _octree;
@@ -41,7 +41,7 @@ export declare class PointCloudNode extends Group {
      * @param ray Ray representing the direction for picking.
      * @returns Picked point data.
      */
-    pick(renderer: THREE.WebGLRenderer, camera: THREE.Camera, ray: THREE.Ray): PickPoint | null;
+    pick(renderer: WebGLRenderer, camera: Camera, ray: Ray): PickPoint | null;
     /**
      * Sets a visible filter on points of a given class.
      * @param pointClass ASPRS classification class code. Either one of the well known
@@ -74,16 +74,16 @@ export declare class PointCloudNode extends Group {
         code: number | WellKnownAsprsPointClassCodes;
         color: Color;
     }>;
-    getBoundingBox(outBbox?: THREE.Box3): THREE.Box3;
-    setModelTransformation(matrix: THREE.Matrix4): void;
-    getModelTransformation(out?: Matrix4): THREE.Matrix4;
+    getBoundingBox(outBbox?: Box3): Box3;
+    setModelTransformation(matrix: Matrix4): void;
+    getModelTransformation(out?: Matrix4): Matrix4;
     getCdfToDefaultModelTransformation(out?: Matrix4): Matrix4;
     get stylableObjectAnnotationMetadata(): Iterable<PointCloudObjectMetadata>;
     getStylableObjectMetadata(objectId: number): PointCloudObjectMetadata | undefined;
     get stylableObjectCount(): number;
     get defaultAppearance(): CompletePointCloudAppearance;
     set defaultAppearance(appearance: CompletePointCloudAppearance);
-    set clippingPlanes(clippingPlanes: THREE.Plane[]);
+    set clippingPlanes(clippingPlanes: Plane[]);
     assignStyledPointCloudObjectCollection(styledCollection: StyledPointCloudObjectCollection): void;
     removeAllStyledPointCloudObjects(): void;
     dispose(): void;

package/dist/packages/pointclouds/src/potree-three-loader/tree/PointCloudOctreePickerHelper.d.ts

@@ -48,7 +48,7 @@ export declare class PointCloudOctreePickerHelper {
     private static updatePickMaterial;
     static updatePickRenderTarget(pickState: IPickState, width: number, height: number): void;
     private static makePickRenderTarget;
-    static findHit(pixels: Uint8Array, pickWndSize: number, nodes: RenderedNode[], camera: THREE.Camera): PointCloudHit | null;
+    static findHit(pixels: Uint8Array, pickWndSize: number, nodes: RenderedNode[], camera: Camera): PointCloudHit | null;
     static getPickPoint(hit: PointCloudHit | null, nodes: RenderedNode[]): PickPoint | null;
     static getPointPosition(nodes: RenderedNode[], pcIndex: number, pIndex: number): Vector3;
     private static addPositionToPickPoint;

package/dist/packages/pointclouds/src/potree-three-loader/types/types.d.ts

@@ -1,8 +1,8 @@
-import { Vector3 } from 'three';
+import type { Vector3, Object3D } from 'three';
 import { PointCloudOctree } from '../tree/PointCloudOctree';
 export interface PickPoint {
     pointIndex: number;
-    object: THREE.Object3D;
+    object: Object3D;
     position: Vector3;
     normal?: Vector3;
     pointCloud?: PointCloudOctree;

package/dist/packages/pointclouds/src/potree-three-loader/workers/assignPointsToObjectsWithWasm.d.ts

@@ -2,4 +2,5 @@
  * Copyright 2022 Cognite AS
  */
 import { SerializableStylableObject } from '../../../../data-providers';
-export declare function assignPointsToObjectsWithWasm(points: Float32Array, objects: SerializableStylableObject[], pointOffset: THREE.Vector3, sectorBoundingBox: THREE.Box3): Promise<Uint16Array>;
+import type { Vector3, Box3 } from 'three';
+export declare function assignPointsToObjectsWithWasm(points: Float32Array, objects: SerializableStylableObject[], pointOffset: Vector3, sectorBoundingBox: Box3): Promise<Uint16Array>;

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

@@ -1,6 +1,7 @@
 /*!
  * Copyright 2022 Cognite AS
  */
+import type { WebGLRenderer } from 'three';
 import { RenderPass } from './RenderPass';
 /**
  * Defines a provider that provides a set of renderpasses
@@ -10,6 +11,6 @@ import { RenderPass } from './RenderPass';
  * render passes given some dependency.
  */
 export interface RenderPipelineProvider {
-    pipeline(renderer: THREE.WebGLRenderer): Generator<RenderPass>;
+    pipeline(renderer: WebGLRenderer): Generator<RenderPass>;
     dispose(): void;
 }

package/dist/packages/rendering/src/pointcloud-rendering/types.d.ts

@@ -1,7 +1,7 @@
 /*!
  * Adapted from pnext/three-loader (https://github.com/pnext/three-loader)
  */
-import { Color, IUniform as IThreeUniform, Vector4 } from 'three';
+import { Color, IUniform as IThreeUniform, Vector4, type Box3, type Vector3 } from 'three';
 export type IGradient = [number, Color][];
 export interface PointClassification {
     [value: string]: Vector4;
@@ -12,7 +12,7 @@ export interface IUniform<T> extends IThreeUniform {
     value: T;
 }
 export type OctreeMaterialParams = {
-    scale: THREE.Vector3;
+    scale: Vector3;
     spacing: number;
-    boundingBox: THREE.Box3;
+    boundingBox: Box3;
 };

package/dist/packages/rendering/src/render-passes/SSAOPass.d.ts

@@ -8,7 +8,7 @@ export declare class SSAOPass implements RenderPass {
     private readonly _fullScreenTriangle;
     private readonly _ssaoShaderMaterial;
     set ssaoParameters(ssaoParameters: SsaoParameters);
-    constructor(depthTexture: THREE.Texture, ssaoParameters: SsaoParameters);
+    constructor(depthTexture: THREE.Texture | null, ssaoParameters: SsaoParameters);
     render(renderer: THREE.WebGLRenderer, camera: THREE.Camera): void;
     private createKernel;
 }

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

@@ -18,7 +18,7 @@ export declare enum BlitEffect {
 export type BlitOptions = {
     texture: THREE.Texture;
     effect?: BlitEffect;
-    depthTexture?: THREE.DepthTexture;
+    depthTexture: THREE.DepthTexture | null;
     ssaoTexture?: THREE.Texture;
     blendOptions?: BlendOptions;
     overrideAlpha?: number;
@@ -27,9 +27,9 @@ export type BlitOptions = {
 };
 export type DepthBlendBlitOptions = {
     texture: THREE.Texture;
-    depthTexture: THREE.DepthTexture;
+    depthTexture: THREE.DepthTexture | null;
     blendTexture: THREE.Texture;
-    blendDepthTexture: THREE.Texture;
+    blendDepthTexture: THREE.Texture | null;
     blendFactor: number;
     overrideAlpha?: number;
     outline?: boolean;
@@ -37,7 +37,7 @@ export type DepthBlendBlitOptions = {
 export type PointCloudPostProcessingOptions = {
     logDepthTexture: THREE.Texture;
     texture: THREE.Texture;
-    depthTexture: THREE.DepthTexture;
+    depthTexture: THREE.DepthTexture | null;
     pointBlending: boolean;
     edlOptions: EdlOptions;
 };

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

@@ -1,9 +1,10 @@
 /*!
  * Copyright 2022 Cognite AS
  */
+import type { WebGLRenderTarget } from 'three';
 /**
  * Interface for allowing render targets in renderPipelines to be changed dynamicaly in RevealManager.
  */
 export interface SettableRenderTarget {
-    setOutputRenderTarget(target: THREE.WebGLRenderTarget | null, autoSizeRenderTarget?: boolean): void;
+    setOutputRenderTarget(target: WebGLRenderTarget | null, autoSizeRenderTarget?: boolean): void;
 }

package/dist/packages/sector-parser/src/types.d.ts

@@ -1,6 +1,7 @@
 /*!
  * Copyright 2021 Cognite AS
  */
+import type { InstancedBufferGeometry, BufferGeometry, Texture as ThreeTexture } from 'three';
 export type GltfJson = {
     accessors: Accessor[];
     asset: Asset;
@@ -109,7 +110,7 @@ export type GlbHeaderData = {
 };
 export type GeometryProcessingPayload = {
     geometryType: RevealGeometryCollectionType;
-    bufferGeometry: THREE.InstancedBufferGeometry | THREE.BufferGeometry;
+    bufferGeometry: InstancedBufferGeometry | BufferGeometry;
     instancingExtension: {
         attributes: {
             [key: string]: number;
@@ -117,12 +118,12 @@ export type GeometryProcessingPayload = {
     } | undefined;
     meshId: number | undefined;
     glbHeaderData: GlbHeaderData;
-    texture?: THREE.Texture;
+    texture?: ThreeTexture;
     data: ArrayBuffer;
 };
 export type ParsedGeometry = {
     type: RevealGeometryCollectionType;
-    geometryBuffer: THREE.BufferGeometry;
-    texture?: THREE.Texture;
+    geometryBuffer: BufferGeometry;
+    texture?: ThreeTexture;
     instanceId?: string;
 };

package/dist/packages/tools/src/Measurement/types.d.ts

@@ -1,10 +1,11 @@
 /*!
  * Copyright 2022 Cognite AS
  */
+import type { Vector3, Color } from 'three';
 export type Measurement = {
     readonly measurementId: number;
-    readonly startPoint: THREE.Vector3;
-    readonly endPoint: THREE.Vector3;
+    readonly startPoint: Vector3;
+    readonly endPoint: Vector3;
     readonly distanceInMeters: number;
 };
 /**
@@ -35,5 +36,5 @@ export type MeasurementOptions = {
     /**
      * Line color in 32 bit hex.
      */
-    color?: THREE.Color;
+    color?: Color;
 };

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

@@ -5,7 +5,13 @@ export { traverseDepthFirst } from './src/objectTraversal';
 export { transformCameraConfiguration } from './src/transformCameraConfiguration';
 export { RandomColors } from './src/RandomColors';
 export { CameraConfiguration } from './src/CameraConfiguration';
-export { EventTrigger, clickOrTouchEventOffset, getClickOrTouchEventPoint, InputHandler, disposeOfAllEventListeners } from './src/events';
+export { EventTrigger } from './src/events/EventTrigger';
+export { InputHandler } from './src/events/InputHandler';
+export { PointerEvents } from './src/events/PointerEvents';
+export { PointerEventsTarget } from './src/events/PointerEventsTarget';
+export { disposeOfAllEventListeners } from './src/events/disposeOfAllEventListeners';
+export { clickOrTouchEventOffset, getClickOrTouchEventPoint } from './src/events/clickOrTouchEventOffset';
+export { getWheelEventDelta } from './src/events/getWheelEventDelta';
 export { DisposedDelegate, BeforeSceneRenderedDelegate, SceneRenderedDelegate, PointerEventDelegate, PointerEventData } from './src/events/types';
 export { assertNever } from './src/assertNever';
 export { NumericRange } from './src/NumericRange';

package/dist/packages/utilities/src/CameraConfiguration.d.ts

@@ -1,10 +1,11 @@
 /*!
  * Copyright 2021 Cognite AS
  */
+import type { Vector3 } from 'three';
 /**
  * Represents a camera configuration, consisting of a camera position and target.
  */
 export type CameraConfiguration = {
-    readonly position: THREE.Vector3;
-    readonly target: THREE.Vector3;
+    readonly position: Vector3;
+    readonly target: Vector3;
 };

package/dist/packages/utilities/src/events/InputHandler.d.ts

@@ -1,14 +1,12 @@
-import { EventTrigger } from './EventTrigger';
 import { PointerEventDelegate } from './types';
-export type EventCollection = {
-    [eventName: string]: EventTrigger<(...args: any[]) => void>;
-};
-export declare class InputHandler {
-    private readonly domElement;
-    private static readonly maxMoveDistance;
-    private static readonly maxClickDuration;
-    private readonly _events;
+import { PointerEvents } from './PointerEvents';
+export declare class InputHandler extends PointerEvents {
+    private readonly _domElement;
+    private readonly _pointerEventsTarget;
+    private readonly _clickEvents;
+    private readonly _hoverEvents;
     constructor(domElement: HTMLElement);
+    dispose(): void;
     /**
      * @example
      * ```js
@@ -18,13 +16,7 @@ export declare class InputHandler {
      */
     on(event: 'click' | 'hover', callback: PointerEventDelegate): void;
     off(event: 'click' | 'hover', callback: PointerEventDelegate): void;
-    dispose(): void;
-    private setupEventListeners;
-    private isProperClick;
-    private handleClickEvent;
-    private readonly onHoverCallback;
+    onClick(event: PointerEvent): Promise<void>;
+    onHover(event: PointerEvent): void;
+    get isEnabled(): boolean;
 }
-/**
- * Method for deleting all external events that are associated with current instance of a class.
- */
-export declare function disposeOfAllEventListeners(eventList: EventCollection): void;

package/dist/packages/utilities/src/events/PointerEvents.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * Copyright 2024 Cognite AS
+ */
+/**
+ * This base should be extended for listen to various pointer events.
+ * @beta
+ */
+export declare class PointerEvents {
+    onHover(_event: PointerEvent): void;
+    onClick(_event: PointerEvent): Promise<void>;
+    onDoubleClick(_event: PointerEvent): Promise<void>;
+    onPointerDown(_event: PointerEvent, _leftButton: boolean): Promise<void>;
+    onPointerUp(_event: PointerEvent, _leftButton: boolean): Promise<void>;
+    onPointerDrag(_event: PointerEvent, _leftButton: boolean): Promise<void>;
+    get isEnabled(): boolean;
+}

package/dist/packages/utilities/src/events/PointerEventsTarget.d.ts

@@ -0,0 +1,29 @@
+import { PointerEvents } from './PointerEvents';
+/**
+ * This class fires click, double click, hover end similar events at a PointerEvents
+ * onClick will fired if it's a single click, and the mouse hasn't move too much
+ * If onDoubleClick is fired, the onClick will not be fired
+ * onHover will be fired only if the mouse button is not pressed and not to often
+ * If mouse, the onDoubleClick and onClick is fired when the left mouse button is pressed
+ * onPointerDrag will be fired wnen the mouse button is pressed and the mouse is moving
+ * @beta
+ */
+export declare class PointerEventsTarget {
+    private readonly _domElement;
+    private readonly _events;
+    private readonly _downPosition;
+    private _lastDownTimestamp;
+    private _prevDownTimestamp;
+    private _clickCounter;
+    private _isLeftDown;
+    private get isEnabled();
+    constructor(domElement: HTMLElement, events: PointerEvents);
+    addEventListeners(): void;
+    removeEventListeners(): void;
+    private readonly onPointerDown;
+    private readonly onPointerHover;
+    private readonly onPointerDrag;
+    private readonly onPointerUp;
+    private isProperClick;
+    private isDoubleClick;
+}

package/dist/packages/utilities/src/events/disposeOfAllEventListeners.d.ts

@@ -0,0 +1,11 @@
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { EventTrigger } from './EventTrigger';
+export type EventCollection = {
+    [eventName: string]: EventTrigger<(...args: any[]) => void>;
+};
+/**
+ * Method for deleting all external events that are associated with current instance of a class.
+ */
+export declare function disposeOfAllEventListeners(eventList: EventCollection): void;

package/dist/packages/utilities/src/events/getWheelEventDelta.d.ts

@@ -0,0 +1,8 @@
+/*!
+ * Copyright 2024 Cognite AS
+ */
+/**
+ * Determines hove many deltas the whell has been scrolled.
+ * @param event     An WheelEvent
+ */
+export declare function getWheelEventDelta(event: WheelEvent): number;

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

@@ -1,6 +1,7 @@
 /*!
  * Copyright 2022 Cognite AS
  */
+import type { PerspectiveCamera, WebGLRenderer } from 'three';
 /**
  * Delegate for pointer events.
  * @module @cognite/reveal
@@ -25,8 +26,8 @@ export type DisposedDelegate = () => void;
  */
 export type BeforeSceneRenderedDelegate = (event: {
     frameNumber: number;
-    renderer: THREE.WebGLRenderer;
-    camera: THREE.PerspectiveCamera;
+    renderer: WebGLRenderer;
+    camera: PerspectiveCamera;
 }) => void;
 /**
  * Delegate for event triggered when scene has been rendered.
@@ -35,6 +36,6 @@ export type BeforeSceneRenderedDelegate = (event: {
 export type SceneRenderedDelegate = (event: {
     frameNumber: number;
     renderTime: number;
-    renderer: THREE.WebGLRenderer;
-    camera: THREE.PerspectiveCamera;
+    renderer: WebGLRenderer;
+    camera: PerspectiveCamera;
 }) => void;