@cognite/reveal 3.0.0-alpha.2 → 3.0.0

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

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

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

@@ -1,17 +1,17 @@
-/*!
- * Copyright 2022 Cognite AS
- */
-export declare class DeferredPromise<T> implements Promise<T> {
-    [Symbol.toStringTag]: 'Promise';
-    private readonly _promise;
-    private _resolve;
-    private _reject;
-    private _state;
-    get state(): 'pending' | 'fulfilled' | 'rejected';
-    constructor();
-    finally(onfinally?: (() => void) | null): Promise<T>;
-    then<TResult1, TResult2>(onfulfilled?: (value: T) => TResult1 | PromiseLike<TResult1>, onrejected?: (reason: any) => TResult2 | PromiseLike<TResult2>): Promise<TResult1 | TResult2>;
-    catch<TResult>(onrejected?: (reason: any) => TResult | PromiseLike<TResult>): Promise<T | TResult>;
-    resolve(value: T | PromiseLike<T>): void;
-    reject(reason?: any): void;
-}
+/*!
+ * Copyright 2022 Cognite AS
+ */
+export declare class DeferredPromise<T> implements Promise<T> {
+    [Symbol.toStringTag]: 'Promise';
+    private readonly _promise;
+    private _resolve;
+    private _reject;
+    private _state;
+    get state(): 'pending' | 'fulfilled' | 'rejected';
+    constructor();
+    finally(onfinally?: (() => void) | null): Promise<T>;
+    then<TResult1, TResult2>(onfulfilled?: (value: T) => TResult1 | PromiseLike<TResult1>, onrejected?: (reason: any) => TResult2 | PromiseLike<TResult2>): Promise<TResult1 | TResult2>;
+    catch<TResult>(onrejected?: (reason: any) => TResult | PromiseLike<TResult>): Promise<T | TResult>;
+    resolve(value: T | PromiseLike<T>): void;
+    reject(reason?: any): void;
+}

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

@@ -1 +1 @@
-export { IndexSet } from './indexset/IndexSet';
+export { IndexSet } from './indexset/IndexSet';

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

@@ -1,22 +1,22 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-export declare class NumericRange {
-    readonly from: number;
-    readonly count: number;
-    readonly toInclusive: number;
-    constructor(from: number, count: number);
-    static createFromInterval(from: number, toInclusive: number): NumericRange;
-    values(): Generator<number>;
-    toArray(): number[];
-    equal(other: NumericRange): boolean;
-    contains(value: number): boolean;
-    intersects(range: NumericRange): boolean;
-    intersectsOrCoinciding(range: NumericRange): boolean;
-    intersectionWith(range: NumericRange): NumericRange | undefined;
-    isInside(range: NumericRange): boolean;
-    union(range: NumericRange): NumericRange;
-    forEach(action: (value: number) => void): void;
-    toString(): string;
-    static isNumericRange(value: any): value is NumericRange;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+export declare class NumericRange {
+    readonly from: number;
+    readonly count: number;
+    readonly toInclusive: number;
+    constructor(from: number, count: number);
+    static createFromInterval(from: number, toInclusive: number): NumericRange;
+    values(): Generator<number>;
+    toArray(): number[];
+    equal(other: NumericRange): boolean;
+    contains(value: number): boolean;
+    intersects(range: NumericRange): boolean;
+    intersectsOrCoinciding(range: NumericRange): boolean;
+    intersectionWith(range: NumericRange): NumericRange | undefined;
+    isInside(range: NumericRange): boolean;
+    union(range: NumericRange): NumericRange;
+    forEach(action: (value: number) => void): void;
+    toString(): string;
+    static isNumericRange(value: any): value is NumericRange;
+}

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

@@ -1,34 +1,34 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-/**
- * Utility class for creating reasonable visible colors. Mainly meant for use
- * in debugging.
- */
-export declare class RandomColors {
-    private static readonly _colors;
-    /**
-     * Returns a color as a THREE.Color.
-     * @param colorIndex
-     * @returns
-     */
-    static color(colorIndex: number): THREE.Color;
-    /**
-     * Returns color as RGB components between 0 and 255.
-     * @param colorIndex Return
-     * @returns
-     */
-    static colorRGB(colorIndex: number): [number, number, number];
-    /**
-     * Returns a color string suitable for usage in CSS styles.
-     * @param colorIndex
-     * @returns
-     */
-    static colorCSS(colorIndex: number): string;
-    /**
-     * Returns a random color with reasonable lightness and saturation
-     * to make the color easily distinguishable from other colors.
-     */
-    static generateRandomColor(): THREE.Color;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+/**
+ * Utility class for creating reasonable visible colors. Mainly meant for use
+ * in debugging.
+ */
+export declare class RandomColors {
+    private static readonly _colors;
+    /**
+     * Returns a color as a THREE.Color.
+     * @param colorIndex
+     * @returns
+     */
+    static color(colorIndex: number): THREE.Color;
+    /**
+     * Returns color as RGB components between 0 and 255.
+     * @param colorIndex Return
+     * @returns
+     */
+    static colorRGB(colorIndex: number): [number, number, number];
+    /**
+     * Returns a color string suitable for usage in CSS styles.
+     * @param colorIndex
+     * @returns
+     */
+    static colorCSS(colorIndex: number): string;
+    /**
+     * Returns a random color with reasonable lightness and saturation
+     * to make the color easily distinguishable from other colors.
+     */
+    static generateRandomColor(): THREE.Color;
+}

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

@@ -1,15 +1,15 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-export declare class WebGLRendererStateHelper {
-    private _originalState;
-    private readonly _renderer;
-    constructor(renderer: THREE.WebGLRenderer);
-    setClearColor(color: THREE.Color | number | string, alpha?: number): void;
-    setSize(width: number, height: number): void;
-    set localClippingEnabled(enabled: boolean);
-    set autoClear(enabled: boolean);
-    setRenderTarget(renderTarget: THREE.WebGLRenderTarget | null): void;
-    resetState(): void;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+export declare class WebGLRendererStateHelper {
+    private _originalState;
+    private readonly _renderer;
+    constructor(renderer: THREE.WebGLRenderer);
+    setClearColor(color: THREE.Color | number | string, alpha?: number): void;
+    setSize(width: number, height: number): void;
+    set localClippingEnabled(enabled: boolean);
+    set autoClear(enabled: boolean);
+    setRenderTarget(renderTarget: THREE.WebGLRenderTarget | null): void;
+    resetState(): void;
+}

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

@@ -1,7 +1,7 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-/**
- * See https://www.typescriptlang.org/docs/handbook/unions-and-intersections.html#union-exhaustiveness-checking
- */
-export declare function assertNever(x: never, message?: string): never;
+/*!
+ * Copyright 2021 Cognite AS
+ */
+/**
+ * See https://www.typescriptlang.org/docs/handbook/unions-and-intersections.html#union-exhaustiveness-checking
+ */
+export declare function assertNever(x: never, message?: string): never;

package/packages/utilities/src/cache/MemoryRequestCache.d.ts

@@ -1,22 +1,24 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { RequestCache } from './RequestCache';
-export interface MemoryRequestCacheOptions {
-    maxElementsInCache?: number;
-}
-export declare class MemoryRequestCache<Key, Data> implements RequestCache<Key, Data> {
-    private readonly _maxElementsInCache;
-    private readonly _data;
-    private readonly _defaultCleanupCount;
-    private readonly _removeCallback;
-    constructor(maxElementsInCache?: number, removeCallback?: (value: Data) => void, defaultCleanupCount?: number);
-    has(id: Key): boolean;
-    forceInsert(id: Key, data: Data): void;
-    insert(id: Key, data: Data): void;
-    remove(id: Key): void;
-    get(id: Key): Data;
-    isFull(): boolean;
-    cleanCache(count: number): void;
-    clear(): void;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { RequestCache } from './RequestCache';
+export interface MemoryRequestCacheOptions {
+    maxElementsInCache?: number;
+}
+export declare class MemoryRequestCache<Key, Data> implements RequestCache<Key, Data> {
+    private _maxElementsInCache;
+    private readonly _data;
+    private _defaultCleanupCount;
+    private readonly _removeCallback;
+    private static readonly CLEANUP_COUNT_TO_CAPACITY_RATIO;
+    constructor(maxElementsInCache?: number, removeCallback?: (value: Data) => void, defaultCleanupCount?: number);
+    has(id: Key): boolean;
+    forceInsert(id: Key, data: Data): void;
+    insert(id: Key, data: Data): void;
+    remove(id: Key): void;
+    get(id: Key): Data;
+    isFull(): boolean;
+    cleanCache(count: number): void;
+    resize(cacheSize: number): void;
+    clear(): void;
+}

package/packages/utilities/src/cache/MostFrequentlyUsedCache.d.ts

@@ -1,19 +1,19 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-/**
- * A cache that keeps values that is most frequently used (MFU) rather than a more common
- * least recently used (LRU) approach.
- */
-export declare class MostFrequentlyUsedCache<TKey, TValue> {
-    private readonly _capacity;
-    private readonly _cache;
-    private readonly _retrieves;
-    private readonly _disposeCallback;
-    constructor(capacity: number, disposeCallback?: (value: TValue) => void);
-    get(key: TKey): TValue | undefined;
-    set(key: TKey, value: TValue): boolean;
-    remove(key: TKey): boolean;
-    clear(): void;
-    private ensureWithinCapacity;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+/**
+ * A cache that keeps values that is most frequently used (MFU) rather than a more common
+ * least recently used (LRU) approach.
+ */
+export declare class MostFrequentlyUsedCache<TKey, TValue> {
+    private readonly _capacity;
+    private readonly _cache;
+    private readonly _retrieves;
+    private readonly _disposeCallback;
+    constructor(capacity: number, disposeCallback?: (value: TValue) => void);
+    get(key: TKey): TValue | undefined;
+    set(key: TKey, value: TValue): boolean;
+    remove(key: TKey): boolean;
+    clear(): void;
+    private ensureWithinCapacity;
+}

package/packages/utilities/src/cache/RequestCache.d.ts

@@ -1,13 +1,13 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-export interface RequestCache<Key, Data> {
-    has(key: Key): boolean;
-    get(key: Key): Data;
-    insert(key: Key, data: Data): void;
-    forceInsert(key: Key, data: Data): void;
-    remove(key: Key): void;
-    isFull(): boolean;
-    cleanCache(count: number): void;
-    clear(): void;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+export interface RequestCache<Key, Data> {
+    has(key: Key): boolean;
+    get(key: Key): Data;
+    insert(key: Key, data: Data): void;
+    forceInsert(key: Key, data: Data): void;
+    remove(key: Key): void;
+    isFull(): boolean;
+    cleanCache(count: number): void;
+    clear(): void;
+}

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

@@ -0,0 +1,4 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+export declare function calculateVolumeOfMesh(vertexBuffer: Float32Array, indexBuffer: Uint16Array | Uint32Array): number;

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

@@ -1,5 +1,5 @@
-/**
- * Copyright 2022 Cognite AS
- */
-export declare function incrementOrInsertIndex(indexMap: Map<number, number>, index: number): void;
-export declare function decrementOrDeleteIndex(indexMap: Map<number, number>, index: number): void;
+/**
+ * Copyright 2022 Cognite AS
+ */
+export declare function incrementOrInsertIndex(indexMap: Map<number, number>, index: number): void;
+export declare function decrementOrDeleteIndex(indexMap: Map<number, number>, index: number): void;

package/packages/utilities/src/datastructures/DynamicDefragmentedBuffer.d.ts

@@ -1,35 +1,33 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { TypedArray } from '../types';
-export declare class DynamicDefragmentedBuffer<T extends TypedArray> {
-    get length(): number;
-    get bufferView(): T;
-    private _bufferView;
-    private _numFilled;
-    private readonly _type;
-    private readonly _batchMap;
-    private _currentTail;
-    private _batchIdCounter;
-    constructor(initialSize: number, type: new (length: number) => T);
-    add(array: T): {
-        batchId: number;
-        bufferIsReallocated: boolean;
-        updateRange: {
-            byteOffset: number;
-            byteCount: number;
-        };
-    };
-    remove(batchId: number): {
-        updateRange: {
-            byteOffset: number;
-            byteCount: number;
-        };
-    };
-    getRangeForBatchId(batchId: number): {
-        byteOffset: number;
-        byteCount: number;
-    };
-    private createBatch;
-    private allocateNewBuffer;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { TypedArray } from '../types';
+export declare class DynamicDefragmentedBuffer<T extends TypedArray> {
+    get length(): number;
+    get bufferView(): T;
+    private _bufferView;
+    private _numFilled;
+    private readonly _type;
+    private readonly _batchMap;
+    private _currentTail;
+    private _batchIdCounter;
+    constructor(initialSize: number, type: new (length: number) => T);
+    add(array: T): {
+        batchId: number;
+        bufferIsReallocated: boolean;
+        updateRange: {
+            byteOffset: number;
+            byteCount: number;
+        };
+    };
+    remove(batchId: number): {
+        byteOffset: number;
+        byteCount: number;
+    };
+    getRangeForBatchId(batchId: number): {
+        byteOffset: number;
+        byteCount: number;
+    };
+    private createBatch;
+    private allocateNewBuffer;
+}

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

@@ -1,11 +1,11 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-/**
- * Computes minimal power-of-two width and height that holds at least the number of elements provided.
- * This is useful to compute texture sizes.
- */
-export declare function determinePowerOfTwoDimensions(elementCount: number): {
-    width: number;
-    height: number;
-};
+/*!
+ * Copyright 2021 Cognite AS
+ */
+/**
+ * Computes minimal power-of-two width and height that holds at least the number of elements provided.
+ * This is useful to compute texture sizes.
+ */
+export declare function determinePowerOfTwoDimensions(elementCount: number): {
+    width: number;
+    height: number;
+};

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

@@ -1,17 +1,17 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-/**
- * Handler for THREE.BufferAttribute.onUpload() that frees the underlying JS side array
- * of values after they have been uploaded to the GPU.
- *
- * @example
- * const geometry = new THREE.BufferGeometry();
- * const indices = new THREE.Uint32BufferAttribute(mesh.indices.buffer, 1).onUpload(disposeAttributeArrayOnUpload);
- * const vertices = new THREE.Float32BufferAttribute(mesh.vertices.buffer, 3).onUpload(disposeAttributeArrayOnUpload);
- * const colors = new THREE.Float32BufferAttribute(mesh.colors.buffer, 3).onUpload(disposeAttributeArrayOnUpload);
- * const treeIndices = new THREE.Float32BufferAttribute(mesh.treeIndices.buffer, 1).onUpload(disposeAttributeArrayOnUpload);
- */
-export declare function disposeAttributeArrayOnUpload(this: {
-    array: ArrayLike<number>;
-}): void;
+/*!
+ * Copyright 2021 Cognite AS
+ */
+/**
+ * Handler for THREE.BufferAttribute.onUpload() that frees the underlying JS side array
+ * of values after they have been uploaded to the GPU.
+ *
+ * @example
+ * const geometry = new THREE.BufferGeometry();
+ * const indices = new THREE.Uint32BufferAttribute(mesh.indices.buffer, 1).onUpload(disposeAttributeArrayOnUpload);
+ * const vertices = new THREE.Float32BufferAttribute(mesh.vertices.buffer, 3).onUpload(disposeAttributeArrayOnUpload);
+ * const colors = new THREE.Float32BufferAttribute(mesh.colors.buffer, 3).onUpload(disposeAttributeArrayOnUpload);
+ * const treeIndices = new THREE.Float32BufferAttribute(mesh.treeIndices.buffer, 1).onUpload(disposeAttributeArrayOnUpload);
+ */
+export declare function disposeAttributeArrayOnUpload(this: {
+    array: ArrayLike<number>;
+}): void;

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

@@ -1,13 +1,13 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-/**
- * Subscribable event source.
- */
-export declare class EventTrigger<TListener extends (...args: any[]) => void> {
-    private readonly _listeners;
-    subscribe(listener: TListener): void;
-    unsubscribe(listener: TListener): void;
-    unsubscribeAll(): void;
-    fire(...args: Parameters<TListener>): void;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+/**
+ * Subscribable event source.
+ */
+export declare class EventTrigger<TListener extends (...args: any[]) => void> {
+    private readonly _listeners;
+    subscribe(listener: TListener): void;
+    unsubscribe(listener: TListener): void;
+    unsubscribeAll(): void;
+    fire(...args: Parameters<TListener>): void;
+}

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

@@ -1,25 +1,34 @@
-declare type PointerEventDelegate = (event: {
-    offsetX: number;
-    offsetY: number;
-}) => void;
-export declare class InputHandler {
-    private readonly domElement;
-    private static readonly maxMoveDistance;
-    private static readonly maxClickDuration;
-    private readonly _events;
-    constructor(domElement: HTMLElement);
-    /**
-     * @example
-     * ```js
-     * const onClick = (event) => { console.log(event.offsetX, event.offsetY) };
-     * viewer.on('click', onClick);
-     * ```
-     */
-    on(event: 'click' | 'hover', callback: PointerEventDelegate): void;
-    off(event: 'click' | 'hover', callback: PointerEventDelegate): void;
-    private setupEventListeners;
-    private isProperClick;
-    private handleClickEvent;
-    private readonly onHoverCallback;
-}
-export {};
+import { EventTrigger } from './EventTrigger';
+declare type PointerEventDelegate = (event: {
+    offsetX: number;
+    offsetY: number;
+}) => void;
+export declare 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;
+    constructor(domElement: HTMLElement);
+    /**
+     * @example
+     * ```js
+     * const onClick = (event) => { console.log(event.offsetX, event.offsetY) };
+     * viewer.on('click', onClick);
+     * ```
+     */
+    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;
+}
+/**
+ * Method for deleting all external events that are associated with current instance of a class.
+ */
+export declare function disposeOfAllEventListeners(eventList: EventCollection): void;
+export {};

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

@@ -1,13 +1,13 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-/**
- * Determines clicked or touched coordinate as offset
- * @param ev        An MouseEvent or TouchEvent.
- * @param target    HTML element to find coordinates relative to.
- * @returns A struct containing coordinates relative to the HTML element provided.
- */
-export declare function clickOrTouchEventOffset(ev: MouseEvent | TouchEvent, target: HTMLElement): {
-    offsetX: number;
-    offsetY: number;
-};
+/*!
+ * Copyright 2021 Cognite AS
+ */
+/**
+ * Determines clicked or touched coordinate as offset
+ * @param ev        An MouseEvent or TouchEvent.
+ * @param target    HTML element to find coordinates relative to.
+ * @returns A struct containing coordinates relative to the HTML element provided.
+ */
+export declare function clickOrTouchEventOffset(ev: MouseEvent | TouchEvent, target: HTMLElement): {
+    offsetX: number;
+    offsetY: number;
+};

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

@@ -1,6 +1,6 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-export { clickOrTouchEventOffset } from './clickOrTouchEventOffset';
-export { EventTrigger } from './EventTrigger';
-export { InputHandler } from './InputHandler';
+/*!
+ * Copyright 2021 Cognite AS
+ */
+export { clickOrTouchEventOffset } from './clickOrTouchEventOffset';
+export { EventTrigger } from './EventTrigger';
+export { InputHandler, disposeOfAllEventListeners } from './InputHandler';