@cognite/reveal 3.1.0 → 3.2.0

package/packages/cad-styling/src/AssetNodeCollection.d.ts

@@ -1,47 +1,47 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-import { NodeCollection } from './NodeCollection';
-import { SerializedNodeCollection } from './SerializedNodeCollection';
-import { AreaCollection } from './prioritized/AreaCollection';
-import { IndexSet } from '../../utilities';
-import { CogniteClient } from '@cognite/sdk';
-import { CdfModelNodeCollectionDataProvider } from './CdfModelNodeCollectionDataProvider';
-/**
- * Represents a set of nodes associated with an [asset in Cognite Fusion]{@link https://docs.cognite.com/api/v1/#tag/Assets}
- * linked to the 3D model using [asset mappings]{@link https://docs.cognite.com/api/v1/#tag/3D-Asset-Mapping}. A node
- * is considered to be part of an asset if it has a direct asset mapping or if one of its ancestors has an asset mapping
- * to the asset.
- */
-export declare class AssetNodeCollection extends NodeCollection {
-    static readonly classToken = "AssetNodeCollection";
-    private readonly _client;
-    private _indexSet;
-    private _areas;
-    private readonly _modelMetadataProvider;
-    private _fetchResultHelper;
-    private _filter;
-    constructor(client: CogniteClient, modelMetadataProvider: CdfModelNodeCollectionDataProvider);
-    get isLoading(): boolean;
-    /**
-     * Updates the node collection to hold nodes associated with the asset given, or
-     * assets within the bounding box or all assets associated with the 3D model.
-     * @param filter
-     * @param filter.assetId      ID of a single [asset]{@link https://docs.cognite.com/dev/concepts/resource_types/assets.html} (optional)
-     * @param filter.boundingBox  When provided, only assets within the provided bounds will be included in the filter.
-     */
-    executeFilter(filter: {
-        assetId?: number;
-        boundingBox?: THREE.Box3;
-    }): Promise<void>;
-    private fetchBoundingBoxesForAssetMappings;
-    getFilter(): {
-        assetId?: number | undefined;
-        boundingBox?: THREE.Box3 | undefined;
-    } | undefined;
-    clear(): void;
-    getIndexSet(): IndexSet;
-    getAreas(): AreaCollection;
-    serialize(): SerializedNodeCollection;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+import { NodeCollection } from './NodeCollection';
+import { SerializedNodeCollection } from './SerializedNodeCollection';
+import { AreaCollection } from './prioritized/AreaCollection';
+import { IndexSet } from '../../utilities';
+import { CogniteClient } from '@cognite/sdk';
+import { CdfModelNodeCollectionDataProvider } from './CdfModelNodeCollectionDataProvider';
+/**
+ * Represents a set of nodes associated with an [asset in Cognite Fusion]{@link https://docs.cognite.com/api/v1/#tag/Assets}
+ * linked to the 3D model using [asset mappings]{@link https://docs.cognite.com/api/v1/#tag/3D-Asset-Mapping}. A node
+ * is considered to be part of an asset if it has a direct asset mapping or if one of its ancestors has an asset mapping
+ * to the asset.
+ */
+export declare class AssetNodeCollection extends NodeCollection {
+    static readonly classToken = "AssetNodeCollection";
+    private readonly _client;
+    private _indexSet;
+    private _areas;
+    private readonly _modelMetadataProvider;
+    private _fetchResultHelper;
+    private _filter;
+    constructor(client: CogniteClient, modelMetadataProvider: CdfModelNodeCollectionDataProvider);
+    get isLoading(): boolean;
+    /**
+     * Updates the node collection to hold nodes associated with the asset given, or
+     * assets within the bounding box or all assets associated with the 3D model.
+     * @param filter
+     * @param filter.assetId      ID of a single [asset]{@link https://docs.cognite.com/dev/concepts/resource_types/assets.html} (optional)
+     * @param filter.boundingBox  When provided, only assets within the provided bounds will be included in the filter.
+     */
+    executeFilter(filter: {
+        assetId?: number;
+        boundingBox?: THREE.Box3;
+    }): Promise<void>;
+    private fetchBoundingBoxesForAssetMappings;
+    getFilter(): {
+        assetId?: number | undefined;
+        boundingBox?: THREE.Box3 | undefined;
+    } | undefined;
+    clear(): void;
+    getIndexSet(): IndexSet;
+    getAreas(): AreaCollection;
+    serialize(): SerializedNodeCollection;
+}

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

@@ -1,26 +1,26 @@
-/*!
- * Copyright 2022 Cognite AS
- */
-import * as THREE from 'three';
-/**
- * Provides metadata needed to get asset mappings for a CDF 3D model
- */
-export interface CdfModelNodeCollectionDataProvider {
-    /**
-     * Maps a box from Reveal space to CDF space
-     */
-    mapBoxFromModelToCdfCoordinates: (box: THREE.Box3, out?: THREE.Box3) => THREE.Box3;
-    /**
-     * Maps a box from CDF space to Reveal space
-     */
-    mapBoxFromCdfToModelCoordinates: (box: THREE.Box3, out?: THREE.Box3) => THREE.Box3;
-    /**
-     * Total count of nodes in the model
-     */
-    nodeCount: number;
-    /**
-     * Model and revision IDs for the model
-     */
-    modelId: number;
-    revisionId: number;
-}
+/*!
+ * Copyright 2022 Cognite AS
+ */
+import * as THREE from 'three';
+/**
+ * Provides metadata needed to get asset mappings for a CDF 3D model
+ */
+export interface CdfModelNodeCollectionDataProvider {
+    /**
+     * Maps a box from Reveal space to CDF space
+     */
+    mapBoxFromModelToCdfCoordinates: (box: THREE.Box3, out?: THREE.Box3) => THREE.Box3;
+    /**
+     * Maps a box from CDF space to Reveal space
+     */
+    mapBoxFromCdfToModelCoordinates: (box: THREE.Box3, out?: THREE.Box3) => THREE.Box3;
+    /**
+     * Total count of nodes in the model
+     */
+    nodeCount: number;
+    /**
+     * Model and revision IDs for the model
+     */
+    modelId: number;
+    revisionId: number;
+}

package/packages/cad-styling/src/CombineNodeCollectionBase.d.ts

@@ -1,34 +1,34 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { IndexSet } from '../../utilities';
-import { AreaCollection } from './prioritized/AreaCollection';
-import { NodeCollection } from './NodeCollection';
-import { SerializedNodeCollection } from './SerializedNodeCollection';
-/**
- * Node collection that combines the result from multiple underlying node collections.
- */
-export declare abstract class CombineNodeCollectionBase extends NodeCollection {
-    private readonly _changedUnderlyingNodeCollectionHandler;
-    private _cachedCombinedIndexSet;
-    protected _nodeCollections: NodeCollection[];
-    constructor(classToken: string, nodeCollections?: NodeCollection[]);
-    add(nodeCollection: NodeCollection): void;
-    remove(nodeCollection: NodeCollection): void;
-    /**
-     * Clears all underlying node collections.
-     */
-    clear(): void;
-    protected makeDirty(): void;
-    /**
-     * @override
-     */
-    getIndexSet(): IndexSet;
-    /**
-     * @override
-     */
-    get isLoading(): boolean;
-    abstract serialize(): SerializedNodeCollection;
-    abstract getAreas(): AreaCollection;
-    protected abstract createCombinedIndexSet(): IndexSet;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { IndexSet } from '../../utilities';
+import { AreaCollection } from './prioritized/AreaCollection';
+import { NodeCollection } from './NodeCollection';
+import { SerializedNodeCollection } from './SerializedNodeCollection';
+/**
+ * Node collection that combines the result from multiple underlying node collections.
+ */
+export declare abstract class CombineNodeCollectionBase extends NodeCollection {
+    private readonly _changedUnderlyingNodeCollectionHandler;
+    private _cachedCombinedIndexSet;
+    protected _nodeCollections: NodeCollection[];
+    constructor(classToken: string, nodeCollections?: NodeCollection[]);
+    add(nodeCollection: NodeCollection): void;
+    remove(nodeCollection: NodeCollection): void;
+    /**
+     * Clears all underlying node collections.
+     */
+    clear(): void;
+    protected makeDirty(): void;
+    /**
+     * @override
+     */
+    getIndexSet(): IndexSet;
+    /**
+     * @override
+     */
+    get isLoading(): boolean;
+    abstract serialize(): SerializedNodeCollection;
+    abstract getAreas(): AreaCollection;
+    protected abstract createCombinedIndexSet(): IndexSet;
+}

package/packages/cad-styling/src/IntersectionNodeCollection.d.ts

@@ -1,20 +1,20 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { SerializedNodeCollection } from './SerializedNodeCollection';
-import { CombineNodeCollectionBase } from './CombineNodeCollectionBase';
-import { AreaCollection } from './prioritized/AreaCollection';
-import { IndexSet } from '../../utilities';
-import { NodeCollection } from './NodeCollection';
-/**
- * Node collection that is the intersection between a set of underlying node collections.
- */
-export declare class IntersectionNodeCollection extends CombineNodeCollectionBase {
-    private _cachedNodeAreas;
-    static readonly classToken = "IntersectionNodeCollection";
-    constructor(nodeCollections?: NodeCollection[]);
-    serialize(): SerializedNodeCollection;
-    protected createCombinedIndexSet(): IndexSet;
-    makeDirty(): void;
-    getAreas(): AreaCollection;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { SerializedNodeCollection } from './SerializedNodeCollection';
+import { CombineNodeCollectionBase } from './CombineNodeCollectionBase';
+import { AreaCollection } from './prioritized/AreaCollection';
+import { IndexSet } from '../../utilities';
+import { NodeCollection } from './NodeCollection';
+/**
+ * Node collection that is the intersection between a set of underlying node collections.
+ */
+export declare class IntersectionNodeCollection extends CombineNodeCollectionBase {
+    private _cachedNodeAreas;
+    static readonly classToken = "IntersectionNodeCollection";
+    constructor(nodeCollections?: NodeCollection[]);
+    serialize(): SerializedNodeCollection;
+    protected createCombinedIndexSet(): IndexSet;
+    makeDirty(): void;
+    getAreas(): AreaCollection;
+}

package/packages/cad-styling/src/InvertedNodeCollection.d.ts

@@ -1,27 +1,27 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { IndexSet } from '../../utilities';
-import { AreaCollection } from './prioritized/AreaCollection';
-import { CdfModelNodeCollectionDataProvider } from './CdfModelNodeCollectionDataProvider';
-import { NodeCollection } from './NodeCollection';
-import { SerializedNodeCollection } from './SerializedNodeCollection';
-/**
- * Node collection that inverts the result from another node collection.
- */
-export declare class InvertedNodeCollection extends NodeCollection {
-    static readonly classToken = "InvertedNodeCollection";
-    private readonly _allTreeIndicesRange;
-    private readonly _innerCollection;
-    private _cachedIndexSet?;
-    constructor(model: CdfModelNodeCollectionDataProvider, innerSet: NodeCollection);
-    get isLoading(): boolean;
-    getIndexSet(): IndexSet;
-    getAreas(): AreaCollection;
-    serialize(): SerializedNodeCollection;
-    /**
-     * Not supported.
-     * @throws Always throws an error.
-     */
-    clear(): never;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { IndexSet } from '../../utilities';
+import { AreaCollection } from './prioritized/AreaCollection';
+import { CdfModelNodeCollectionDataProvider } from './CdfModelNodeCollectionDataProvider';
+import { NodeCollection } from './NodeCollection';
+import { SerializedNodeCollection } from './SerializedNodeCollection';
+/**
+ * Node collection that inverts the result from another node collection.
+ */
+export declare class InvertedNodeCollection extends NodeCollection {
+    static readonly classToken = "InvertedNodeCollection";
+    private readonly _allTreeIndicesRange;
+    private readonly _innerCollection;
+    private _cachedIndexSet?;
+    constructor(model: CdfModelNodeCollectionDataProvider, innerSet: NodeCollection);
+    get isLoading(): boolean;
+    getIndexSet(): IndexSet;
+    getAreas(): AreaCollection;
+    serialize(): SerializedNodeCollection;
+    /**
+     * Not supported.
+     * @throws Always throws an error.
+     */
+    clear(): never;
+}

package/packages/cad-styling/src/NodeAppearance.d.ts

@@ -1,85 +1,85 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-export declare enum NodeOutlineColor {
-    NoOutline = 0,
-    White = 1,
-    Black = 2,
-    Cyan = 3,
-    Blue = 4,
-    Green = 5,
-    Red = 6,
-    Orange = 7
-}
-/**
- * Type for defining node appearance profiles to style a 3D CAD model.
- * @see {@link DefaultNodeAppearance}
- */
-export declare type NodeAppearance = {
-    /**
-     * Overrides the default color of the node in RGB. Each component
-     * is in range [0, 255]. `[0, 0, 0]` means no override.
-     */
-    readonly color?: [number, number, number];
-    /**
-     * Overrides the visibility of the node.
-     */
-    readonly visible?: boolean;
-    /**
-     * When set to true, the node is rendered in front
-     * of all other nodes even if it's occluded.
-     * Note that this take precedence over {@link renderGhosted}.
-     */
-    readonly renderInFront?: boolean;
-    /**
-     * When set to true, the node is rendered ghosted, i.e.
-     * transparent with a fixed color. This has no effect if {@link renderInFront}
-     * is `true`.
-     */
-    readonly renderGhosted?: boolean;
-    /**
-     * When set, an outline is drawn around the
-     * node to make it stand out.
-     */
-    readonly outlineColor?: NodeOutlineColor;
-    /**
-     * When provided, this value can be used to prioritize certain areas of the
-     * 3D model to be loaded. This can be useful to prioritize key objects in the
-     * 3D model to always be loaded.
-     *
-     * When non-zero, sectors containing geometry in the vicinity of the prioritized
-     * sectors are given an *extra* priority. Recommended values are in range 1 (somewhat
-     * higher priority to be loaded) to 10 (very likely to be loaded). Usually values around 4-5
-     * is recommended.
-     *
-     * Prioritized nodes are loaded at the expense of non-prioritized areas. There are no
-     * guarantees that the nodes are actually loaded, and the more prioritized areas/nodes
-     * provided, the less likely it is that the hint is obeyed.
-     *
-     * Extra priority doesn't accumulate when sectors are prioritized because they intersect/contain
-     * several nodes.
-     *
-     * **This is an advanced feature and not recommended for most users**
-     *
-     * @version Only works with 3D models converted later than Q4 2021.
-     */
-    readonly prioritizedForLoadingHint?: number;
-};
-/**
- * A set of default node appearances used in Reveal.
- */
-export declare const DefaultNodeAppearance: {
-    Default: NodeAppearance;
-    Outlined: NodeAppearance;
-    Hidden: NodeAppearance;
-    InFront: NodeAppearance;
-    Ghosted: NodeAppearance;
-    Highlighted: {
-        color?: [number, number, number] | undefined;
-        visible?: boolean | undefined;
-        renderInFront?: boolean | undefined;
-        renderGhosted?: boolean | undefined;
-        outlineColor?: NodeOutlineColor | undefined;
-        prioritizedForLoadingHint?: number | undefined;
-    };
-};
+/*!
+ * Copyright 2021 Cognite AS
+ */
+export declare enum NodeOutlineColor {
+    NoOutline = 0,
+    White = 1,
+    Black = 2,
+    Cyan = 3,
+    Blue = 4,
+    Green = 5,
+    Red = 6,
+    Orange = 7
+}
+/**
+ * Type for defining node appearance profiles to style a 3D CAD model.
+ * @see {@link DefaultNodeAppearance}
+ */
+export declare type NodeAppearance = {
+    /**
+     * Overrides the default color of the node in RGB. Each component
+     * is in range [0, 255]. `[0, 0, 0]` means no override.
+     */
+    readonly color?: [number, number, number];
+    /**
+     * Overrides the visibility of the node.
+     */
+    readonly visible?: boolean;
+    /**
+     * When set to true, the node is rendered in front
+     * of all other nodes even if it's occluded.
+     * Note that this take precedence over {@link renderGhosted}.
+     */
+    readonly renderInFront?: boolean;
+    /**
+     * When set to true, the node is rendered ghosted, i.e.
+     * transparent with a fixed color. This has no effect if {@link renderInFront}
+     * is `true`.
+     */
+    readonly renderGhosted?: boolean;
+    /**
+     * When set, an outline is drawn around the
+     * node to make it stand out.
+     */
+    readonly outlineColor?: NodeOutlineColor;
+    /**
+     * When provided, this value can be used to prioritize certain areas of the
+     * 3D model to be loaded. This can be useful to prioritize key objects in the
+     * 3D model to always be loaded.
+     *
+     * When non-zero, sectors containing geometry in the vicinity of the prioritized
+     * sectors are given an *extra* priority. Recommended values are in range 1 (somewhat
+     * higher priority to be loaded) to 10 (very likely to be loaded). Usually values around 4-5
+     * is recommended.
+     *
+     * Prioritized nodes are loaded at the expense of non-prioritized areas. There are no
+     * guarantees that the nodes are actually loaded, and the more prioritized areas/nodes
+     * provided, the less likely it is that the hint is obeyed.
+     *
+     * Extra priority doesn't accumulate when sectors are prioritized because they intersect/contain
+     * several nodes.
+     *
+     * **This is an advanced feature and not recommended for most users**
+     *
+     * @version Only works with 3D models converted later than Q4 2021.
+     */
+    readonly prioritizedForLoadingHint?: number;
+};
+/**
+ * A set of default node appearances used in Reveal.
+ */
+export declare const DefaultNodeAppearance: {
+    Default: NodeAppearance;
+    Outlined: NodeAppearance;
+    Hidden: NodeAppearance;
+    InFront: NodeAppearance;
+    Ghosted: NodeAppearance;
+    Highlighted: {
+        color?: [number, number, number] | undefined;
+        visible?: boolean | undefined;
+        renderInFront?: boolean | undefined;
+        renderGhosted?: boolean | undefined;
+        outlineColor?: NodeOutlineColor | undefined;
+        prioritizedForLoadingHint?: number | undefined;
+    };
+};

package/packages/cad-styling/src/NodeAppearanceProvider.d.ts

@@ -1,38 +1,38 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { NodeAppearance } from './NodeAppearance';
-import { NodeCollection } from './NodeCollection';
-import { PrioritizedArea } from './prioritized/types';
-import { IndexSet } from '../../utilities';
-/**
- * Delegate for applying styles in {@see NodeStyleProvider}.
- * @param treeIndices Set of tree indices that the style is applied to.
- * @param appearance  Style to be applied to the nodes.
- */
-export declare type ApplyStyleDelegate = (treeIndices: IndexSet, appearance: NodeAppearance) => void;
-export declare class NodeAppearanceProvider {
-    private readonly _styledCollections;
-    private _lastFiredLoadingState?;
-    private _cachedPrioritizedAreas?;
-    private readonly _events;
-    on(event: 'changed', listener: () => void): void;
-    on(event: 'loadingStateChanged', listener: (isLoading: boolean) => void): void;
-    on(event: 'prioritizedAreasChanged', listener: () => void): void;
-    off(event: 'changed', listener: () => void): void;
-    off(event: 'loadingStateChanged', listener: (isLoading: boolean) => void): void;
-    assignStyledNodeCollection(nodeCollection: NodeCollection, appearance: NodeAppearance): void;
-    unassignStyledNodeCollection(nodeCollection: NodeCollection): void;
-    applyStyles(applyCb: ApplyStyleDelegate): void;
-    getPrioritizedAreas(): PrioritizedArea[];
-    clear(): void;
-    get isLoading(): boolean;
-    private notifyChanged;
-    /**
-     * Schedules event 'changed' to trigger at the next tick.
-     */
-    private readonly scheduleNotifyChanged;
-    private notifyLoadingStateChanged;
-    private handleNodeCollectionChanged;
-    private notifyPrioritizedAreasChanged;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { NodeAppearance } from './NodeAppearance';
+import { NodeCollection } from './NodeCollection';
+import { PrioritizedArea } from './prioritized/types';
+import { IndexSet } from '../../utilities';
+/**
+ * Delegate for applying styles in {@see NodeStyleProvider}.
+ * @param treeIndices Set of tree indices that the style is applied to.
+ * @param appearance  Style to be applied to the nodes.
+ */
+export declare type ApplyStyleDelegate = (treeIndices: IndexSet, appearance: NodeAppearance) => void;
+export declare class NodeAppearanceProvider {
+    private readonly _styledCollections;
+    private _lastFiredLoadingState?;
+    private _cachedPrioritizedAreas?;
+    private readonly _events;
+    on(event: 'changed', listener: () => void): void;
+    on(event: 'loadingStateChanged', listener: (isLoading: boolean) => void): void;
+    on(event: 'prioritizedAreasChanged', listener: () => void): void;
+    off(event: 'changed', listener: () => void): void;
+    off(event: 'loadingStateChanged', listener: (isLoading: boolean) => void): void;
+    assignStyledNodeCollection(nodeCollection: NodeCollection, appearance: NodeAppearance): void;
+    unassignStyledNodeCollection(nodeCollection: NodeCollection): void;
+    applyStyles(applyCb: ApplyStyleDelegate): void;
+    getPrioritizedAreas(): PrioritizedArea[];
+    clear(): void;
+    get isLoading(): boolean;
+    private notifyChanged;
+    /**
+     * Schedules event 'changed' to trigger at the next tick.
+     */
+    private readonly scheduleNotifyChanged;
+    private notifyLoadingStateChanged;
+    private handleNodeCollectionChanged;
+    private notifyPrioritizedAreasChanged;
+}

package/packages/cad-styling/src/NodeCollection.d.ts

@@ -1,26 +1,31 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { AreaCollection } from './prioritized/AreaCollection';
-import { SerializedNodeCollection } from './SerializedNodeCollection';
-import { IndexSet } from '../../utilities';
-/**
- * Abstract class for implementing a set of nodes to be styled.
- */
-export declare abstract class NodeCollection {
-    private readonly _changedEvent;
-    private readonly _classToken;
-    protected constructor(classToken: string);
-    get classToken(): string;
-    on(event: 'changed', listener: () => void): void;
-    off(event: 'changed', listener: () => void): void;
-    abstract get isLoading(): boolean;
-    abstract getIndexSet(): IndexSet;
-    abstract getAreas(): AreaCollection;
-    abstract clear(): void;
-    abstract serialize(): SerializedNodeCollection;
-    /**
-     * Triggers the changed-event.
-     */
-    protected notifyChanged(): void;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { AreaCollection } from './prioritized/AreaCollection';
+import { SerializedNodeCollection } from './SerializedNodeCollection';
+import { IndexSet } from '../../utilities';
+/**
+ * Abstract class for implementing a set of nodes to be styled.
+ */
+export declare abstract class NodeCollection {
+    private readonly _changedEvent;
+    private readonly _classToken;
+    protected constructor(classToken: string);
+    get classToken(): string;
+    on(event: 'changed', listener: () => void): void;
+    off(event: 'changed', listener: () => void): void;
+    abstract get isLoading(): boolean;
+    abstract getIndexSet(): IndexSet;
+    /**
+     * Returns areas surrounding the nodes in the collection. The areas
+     * are boxes in "ThreeJS coordinates". Note that not all
+     * implementations supports this.
+     */
+    abstract getAreas(): AreaCollection;
+    abstract clear(): void;
+    abstract serialize(): SerializedNodeCollection;
+    /**
+     * Triggers the changed-event.
+     */
+    protected notifyChanged(): void;
+}