Returns the unit the coordinates for the model is stored. Returns an empty string if no unit has been stored. Note that coordinates in Reveal always are converted to meters using CogniteCadModel.modelUnitToMetersFactor.

Returns

"" | WellKnownUnit

Defined in

packages/cad-model/src/wrappers/CogniteCadModel.ts:42

modelUnitToMetersFactor

• get modelUnitToMetersFactor(): undefined | number

Returns the conversion factor that converts from model coordinates to meters. Note that this can return undefined if the model has been stored in an unsupported unit.

Returns

undefined | number

Defined in

packages/cad-model/src/wrappers/CogniteCadModel.ts:52

nodeCount

• get nodeCount(): number

Returns the number of nodes in the model.

Returns

number

Implementation of

CdfModelNodeCollectionDataProvider.nodeCount

Defined in

packages/cad-model/src/wrappers/CogniteCadModel.ts:541

styledNodeCollections

• get styledNodeCollections(): { appearance: NodeAppearance ; nodeCollection: NodeCollection }[]

Returns all currently registered node collections and associated appearance.

Returns

{ appearance: NodeAppearance ; nodeCollection: NodeCollection }[]

Defined in

packages/cad-model/src/wrappers/CogniteCadModel.ts:144

visible

• get visible(): boolean

Returns the model visibility.

Returns

boolean

Defined in

packages/cad-model/src/wrappers/CogniteCadModel.ts:70

• set visible(value): void

Sets the model visibility.

Parameters

Name	Type
`value`	`boolean`

Returns

void

Example

model.visible = false

Defined in

packages/cad-model/src/wrappers/CogniteCadModel.ts:63

Methods

assignStyledNodeCollection

▸ assignStyledNodeCollection(nodeCollection, appearance, importance?): void

Customizes rendering style for a set of nodes, e.g. to highlight, hide or color code a set of 3D objects. This allows for custom look and feel of the 3D model which is useful to highlight certain parts or to color code the 3D model based on information (e.g. coloring the 3D model by construction status).

The NodeCollection can be updated dynamically and the rendered nodes will be updated automatically as the styling changes. The appearance of the style nodes cannot be changed.

When nodes are in several styled sets, the style is combined in the order the sets were added, i.e. styled sets added late can overwrite styled sets added early.

If the nodeCollection provided already has an assigned style, this style will be replaced with style provided.

Parameters

Name	Type	Default value	Description
`nodeCollection`	`NodeCollection`	`undefined`	Dynamic set of nodes to apply the provided appearance to.
`appearance`	`NodeAppearance`	`undefined`	Appearance to style the provided set with.
`importance`	`number`	`0`	The importance of this style. Can be used to manually order the order of styles, this can avoid the order of adding styles affecting the outcome. Optional and defaults to 0.

Returns

void

Example

model.setDefaultNodeAppearance({ rendererGhosted: true });
const visibleNodes = new TreeIndexNodeCollection(someTreeIndices);
model.assignStyledNodeCollection(visibleSet, { rendererGhosted: false });

Defined in

packages/cad-model/src/wrappers/CogniteCadModel.ts:176

dispose

▸ dispose(): void

Cleans up used resources.

Returns

void

Defined in

packages/cad-model/src/wrappers/CogniteCadModel.ts:317

getAncestorTreeIndices

▸ getAncestorTreeIndices(treeIndex, generation): Promise<NumericRange>

Determines the tree index range of a subtree of an ancestor of the provided node defined by a tree index.

Parameters

Name	Type	Description
`treeIndex`	`number`	Tree index of node to find ancestor tree index range for.
`generation`	`number`	What "generation" to find. 0 is the node itself, 1 means parent, 2 means grandparent etc. If the node doesn't have as many ancestors, the root of the model is returned. This can be determined by checking that the range returned includes 0.

Returns

Promise<NumericRange>

Tree index range of the subtree spanned by the ancestor at the "generation" specified, or the root.

Defined in

packages/cad-model/src/wrappers/CogniteCadModel.ts:341

getBoundingBoxByNodeId

▸ getBoundingBoxByNodeId(nodeId, box?): Promise<Box3>

Fetches a bounding box from the CDF by the nodeId.

Parameters

Name	Type	Description
`nodeId`	`number`
`box?`	`Box3`	Optional. Used to write result to.

Returns

Promise<Box3>

Example

const box = new THREE.Box3()
const nodeId = 100500;
await model.getBoundingBoxByNodeId(nodeId, box);
// box now has the bounding box

// the following code does the same
const box = await model.getBoundingBoxByNodeId(nodeId);

Defined in

packages/cad-model/src/wrappers/CogniteCadModel.ts:471

getBoundingBoxByTreeIndex

▸ getBoundingBoxByTreeIndex(treeIndex, box?): Promise<Box3>

Determine the bounding box of the node identified by the tree index provided. Note that this function uses the CDF API to look up the bounding box.

Parameters

Name	Type	Description
`treeIndex`	`number`	Tree index of the node to find bounding box for.
`box?`	`Box3`	Optional preallocated container to hold the bounding box.

Returns

Promise<Box3>

Example

const box = new THREE.Box3()
const treeIndex = 42;
await model.getBoundingBoxByTreeIndex(treeIndex, box);
// box now has the bounding box

// the following code does the same
const box = await model.getBoundingBoxByTreeIndex(treeIndex);

Defined in

packages/cad-model/src/wrappers/CogniteCadModel.ts:517

getBoundingBoxesByNodeIds

▸ getBoundingBoxesByNodeIds(nodeIds): Promise<Box3[]>

Fetches a bounding box from the CDF by a list of nodeIds.

Parameters

Name	Type
`nodeIds`	`number`[]

Returns

Promise<Box3[]>

Example

const box = await model.getBoundingBoxByNodeIds([158239, 192837]);

Defined in

packages/cad-model/src/wrappers/CogniteCadModel.ts:486

getCameraConfiguration

▸ getCameraConfiguration(): undefined | CameraConfiguration

Retrieves the camera position and target stored for the model. Typically this is used to store a good starting position for a model. Returns undefined if there isn't any stored camera configuration for the model.

Returns

undefined | CameraConfiguration

Defined in

packages/cad-model/src/wrappers/CogniteCadModel.ts:388

getCdfToDefaultModelTransformation

▸ getCdfToDefaultModelTransformation(out?): 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 CogniteCadModel.setModelTransformation

Parameters

Name	Type	Description
`out?`	`Matrix4`	Preallocated `THREE.Matrix4` (optional)

Returns

Matrix4

Implementation of

CdfModelNodeCollectionDataProvider.getCdfToDefaultModelTransformation

Defined in

packages/cad-model/src/wrappers/CogniteCadModel.ts:431

getDefaultNodeAppearance

▸ getDefaultNodeAppearance(): NodeAppearance

Gets the default appearance for nodes that are not styled using CogniteCadModel.assignStyledNodeCollection.

Returns

NodeAppearance

Defined in

packages/cad-model/src/wrappers/CogniteCadModel.ts:137

getModelBoundingBox

▸ getModelBoundingBox(outBbox?, restrictToMostGeometry?): Box3

Determines the full bounding box of the model.

Parameters

Name	Type	Description
`outBbox?`	`Box3`	Optional. Used to write result to.
`restrictToMostGeometry?`	`boolean`	Optional. When true, returned bounds are restricted to where most of the geometry is located. This is useful for models that have junk geometry located far from the "main" model. Added in version 1.3.0.

Returns

Box3

Model bounding box.

Example

const box = new THREE.Box3()
model.getModelBoundingBox(box);
// box now has the bounding box

// the following code does the same
const box = model.getModelBoundingBox();

Defined in

packages/cad-model/src/wrappers/CogniteCadModel.ts:372

getModelClippingPlanes

▸ getModelClippingPlanes(): Plane[]

Get the clipping planes for this model.

Returns

Plane[]

Defined in

packages/cad-model/src/wrappers/CogniteCadModel.ts:421

getModelTransformation

▸ getModelTransformation(out?): Matrix4

Gets transformation matrix that has previously been set with CogniteCadModel.setModelTransformation.

Parameters

Name	Type	Description
`out?`	`Matrix4`	Preallocated `THREE.Matrix4` (optional).

Returns

Matrix4

Implementation of

CdfModelNodeCollectionDataProvider.getModelTransformation

Defined in

packages/cad-model/src/wrappers/CogniteCadModel.ts:406

getSubtreeTreeIndices

▸ getSubtreeTreeIndices(treeIndex): Promise<NumericRange>

Determines the range of tree indices for a given subtree.

Parameters

Name	Type	Description
`treeIndex`	`number`	Index of the root of the subtree to get the index range for.

Returns

Promise<NumericRange>

Defined in

packages/cad-model/src/wrappers/CogniteCadModel.ts:325

iterateNodesByTreeIndex

▸ iterateNodesByTreeIndex(action): Promise<void>

Iterates over all nodes in the model and applies the provided action to each node (identified by tree index). The passed action is applied incrementally to avoid main thread blocking, meaning that the changes can be partially applied until promise is resolved (iteration is done).

Parameters

Name	Type	Description
`action`	(`treeIndex`: `number`) => `void`	Function that will be called with a treeIndex argument.

Returns

Promise<void>

Promise that is resolved once the iteration is done.

Example

const logIndex = (treeIndex) => console.log(treeIndex);
await model.iterateNodesByTreeIndex(logIndex); // 0, 1, 2, ...

Defined in

packages/cad-model/src/wrappers/CogniteCadModel.ts:534

iterateSubtreeByTreeIndex

▸ iterateSubtreeByTreeIndex(treeIndex, action): Promise<void>

Iterates over all nodes in a subtree of the model and applies the provided action to each node (identified by tree index). The provided node is included in the visited set. The passed action is applied incrementally to avoid main thread blocking, meaning that the changes can be partially applied until promise is resolved (iteration is done).

Parameters

Name	Type	Description
`treeIndex`	`number`	Tree index of the top parent of the subtree.
`action`	(`treeIndex`: `number`) => `void`	Function that will be called with a treeIndex argument.

Returns

Promise<void>

Promise that is resolved once the iteration is done.

Example

// make a subtree to be gray
await model.iterateNodesByTreeIndex(treeIndex => {
  model.setNodeColorByTreeIndex(treeIndex, 127, 127, 127);
});

Defined in

packages/cad-model/src/wrappers/CogniteCadModel.ts:561

mapBoxFromCdfToModelCoordinates

▸ mapBoxFromCdfToModelCoordinates(box, out?): Box3

Map bounding box from CDF to model space, taking the model's custom transformation into account

Parameters

Name	Type	Description
`box`	`Box3`	Box to compute transformation from
`out`	`Box3`	Optional pre-allocated box

Returns

Box3

Defined in

packages/cad-model/src/wrappers/CogniteCadModel.ts:450

mapNodeIdToTreeIndex

▸ mapNodeIdToTreeIndex(nodeId): Promise<number>

Maps a single node ID to tree index. This is useful when you e.g. have a node ID from an asset mapping and want to highlight the given asset using CogniteCadModel.mapNodeIdsToTreeIndices is recommended for better performance when mapping multiple IDs.

Parameters

Name	Type	Description
`nodeId`	`number`	A Node ID to map to a tree index.

Returns

Promise<number>

TreeIndex of the provided node.

Throws

If an invalid/non-existant node ID is provided the function throws an error.

Defined in

packages/cad-model/src/wrappers/CogniteCadModel.ts:589

mapNodeIdsToTreeIndices

▸ mapNodeIdsToTreeIndices(nodeIds): Promise<number[]>

Maps a list of Node IDs to tree indices. This function is useful when you have a list of nodes, e.g. from Asset Mappings, that you want to highlight, hide, color etc in the viewer.

Parameters

Name	Type	Description
`nodeIds`	`number`[]	List of node IDs to map to tree indices.

Returns

Promise<number[]>

A list of tree indices corresponing to the elements in the input.

Throws

If an invalid/non-existant node ID is provided the function throws an error.

Defined in

packages/cad-model/src/wrappers/CogniteCadModel.ts:575

mapPointFromCdfToModelCoordinates

▸ mapPointFromCdfToModelCoordinates(point, out?): Vector3

Map point from CDF to model space, taking the model's custom transformation into account

Parameters

Name	Type	Description
`point`	`Vector3`	Point to compute transformation from
`out`	`Vector3`	Optional pre-allocated point

Returns

Vector3

Defined in

packages/cad-model/src/wrappers/CogniteCadModel.ts:440

mapTreeIndexToNodeId

▸ mapTreeIndexToNodeId(treeIndex): Promise<number>

Maps a single tree index to node ID for use with the API. If you have multiple tree indices to map, CogniteCadModel.mapNodeIdsToTreeIndices is recommended for better performance.

Parameters

Name	Type	Description
`treeIndex`	`number`	A tree index to map to a Node ID.

Returns

Promise<number>

TreeIndex of the provided node.

Throws

If an invalid/non-existent node ID is provided the function throws an error.

Defined in

packages/cad-model/src/wrappers/CogniteCadModel.ts:615

mapTreeIndicesToNodeIds

▸ mapTreeIndicesToNodeIds(treeIndices): Promise<number[]>

Maps a list of tree indices to node IDs for use with the Cognite SDK. This function is useful if you have a list of tree indices, e.g. from CogniteCadModel.iterateSubtreeByTreeIndex, and want to perform some operations on these nodes using the SDK.

Parameters

Name	Type	Description
`treeIndices`	`number`[]	Tree indices to map to node IDs.

Returns

Promise<number[]>

A list of node IDs corresponding to the elements of the input.

Throws

If an invalid tree index is provided the function throws an error.

Defined in

packages/cad-model/src/wrappers/CogniteCadModel.ts:603

removeAllStyledNodeCollections

▸ removeAllStyledNodeCollections(): void

Removes all styled collections, resetting the appearance of all nodes to the default appearance.

Returns

void

Defined in

packages/cad-model/src/wrappers/CogniteCadModel.ts:209

resetNodeTransform

▸ resetNodeTransform(treeIndices): void

Resets the transformation for the nodes given.

Parameters

Name	Type	Description
`treeIndices`	`NumericRange`	Tree indices of the nodes to reset transforms for.

Returns

void

Defined in

packages/cad-model/src/wrappers/CogniteCadModel.ts:295

resetNodeTransformByTreeIndex

▸ resetNodeTransformByTreeIndex(treeIndex, applyToChildren?): Promise<number>

Remove override transform of the node by tree index.

Parameters

Name	Type	Default value
`treeIndex`	`number`	`undefined`
`applyToChildren`	`boolean`	`true`

Returns

Promise<number>

Defined in

packages/cad-model/src/wrappers/CogniteCadModel.ts:308

setDefaultNodeAppearance

▸ setDefaultNodeAppearance(appearance): void

Sets the default appearance for nodes that are not styled using CogniteCadModel.assignStyledNodeCollection. Updating the default style can be an expensive operation, so use with care.

Parameters

Name	Type	Description
`appearance`	`NodeAppearance`	Default node appearance.

Returns

void

Defined in

packages/cad-model/src/wrappers/CogniteCadModel.ts:129

setModelClippingPlanes

▸ setModelClippingPlanes(clippingPlanes): void

Sets the clipping planes for this model. They will be combined with the global clipping planes.

Parameters

Name	Type
`clippingPlanes`	`Plane`[]

Returns

void

Defined in

packages/cad-model/src/wrappers/CogniteCadModel.ts:414

setModelTransformation

▸ setModelTransformation(matrix): void

Sets transformation matrix of the model. This overrides the current transformation.

Parameters

Name	Type	Description
`matrix`	`Matrix4`	Transformation matrix.

Returns

void

Defined in

packages/cad-model/src/wrappers/CogniteCadModel.ts:396

setNodeTransform

▸ setNodeTransform(treeIndices, transformMatrix, boundingBox?, space?): void

Apply a transformation matrix to the tree indices given, changing rotation, scale and/or position.

Note that setting multiple transformations for the same node isn't supported and might lead to undefined results.

Parameters

Name	Type	Default value	Description
`treeIndices`	`NumericRange`	`undefined`	Tree indices of nodes to apply the transformation to.
`transformMatrix`	`Matrix4`	`undefined`	Transformation to apply.
`boundingBox?`	`Box3`	`undefined`	Optional bounding box for the nodes before any transformation is applied. If given, it is assumed that all the nodes' geometry fit inside.
`space`	`"model"` \| `"world"`	`'world'`	Space to apply the transformation in. Defaults to 'world'.

Returns

void

Defined in

packages/cad-model/src/wrappers/CogniteCadModel.ts:225

setNodeTransformByTreeIndex

▸ setNodeTransformByTreeIndex(treeIndex, transform, applyToChildren?, space?): Promise<number>

Set override transform of the node by tree index.

Parameters

Name	Type	Default value
`treeIndex`	`number`	`undefined`
`transform`	`Matrix4`	`undefined`
`applyToChildren`	`boolean`	`true`
`space`	`"model"` \| `"world"`	`'world'`

Returns

Promise<number>

Defined in

packages/cad-model/src/wrappers/CogniteCadModel.ts:279

unassignStyledNodeCollection

▸ unassignStyledNodeCollection(nodeCollection): void

Removes styling for previously added styled collection, resetting the style to the default (or the style imposed by other styled collections).

Parameters

Name	Type	Description
`nodeCollection`	`NodeCollection`	Node collection previously added using CogniteCadModel.assignStyledNodeCollection.

Returns

void

Throws

Error if node collection isn't assigned to the model.

Defined in

packages/cad-model/src/wrappers/CogniteCadModel.ts:195

Implements​

Properties​

modelId​

Implementation of​

Defined in​

revisionId​

Implementation of​

Defined in​

type​

Defined in​

Accessors​

modelUnit​

Returns​

Defined in​

modelUnitToMetersFactor​

Returns​

Defined in​

nodeCount​

Returns​

Implementation of​

Defined in​

styledNodeCollections​

Returns​

Defined in​

visible​

Returns​

Defined in​

Parameters​

Returns​

Defined in​

Methods​

assignStyledNodeCollection​

Parameters​

Returns​

Defined in​

dispose​

Returns​

Defined in​

getAncestorTreeIndices​

Parameters​

Returns​

Defined in​

getBoundingBoxByNodeId​

Parameters​

Returns​

Defined in​

getBoundingBoxByTreeIndex​

Parameters​

Returns​

Defined in​

getBoundingBoxesByNodeIds​

Parameters​

Returns​

Defined in​

getCameraConfiguration​

Returns​

Defined in​

getCdfToDefaultModelTransformation​

Parameters​

Returns​

Implementation of​

Defined in​

getDefaultNodeAppearance​

Returns​

Defined in​

getModelBoundingBox​

Parameters​

Returns​

Defined in​

getModelClippingPlanes​

Returns​

Defined in​

getModelTransformation​

Parameters​

Returns​

Implementation of​

Defined in​

getSubtreeTreeIndices​

Parameters​

Returns​

Implements

Properties

modelId

Implementation of

Defined in

revisionId

Implementation of

Defined in

type

Defined in

Accessors

modelUnit

Returns

Defined in

modelUnitToMetersFactor

Returns

Defined in

nodeCount

Returns

Implementation of

Defined in

styledNodeCollections

Returns

Defined in

visible

Returns

Defined in

Parameters

Returns

Defined in

Methods

assignStyledNodeCollection

Parameters

Returns

Defined in

dispose

Returns

Defined in

getAncestorTreeIndices

Parameters

Returns

Defined in

getBoundingBoxByNodeId

Parameters

Returns

Defined in

getBoundingBoxByTreeIndex

Parameters

Returns

Defined in

getBoundingBoxesByNodeIds

Parameters

Returns

Defined in

getCameraConfiguration

Returns

Defined in

getCdfToDefaultModelTransformation

Parameters

Returns

Implementation of

Defined in

getDefaultNodeAppearance

Returns

Defined in

getModelBoundingBox

Parameters

Returns

Defined in

getModelClippingPlanes

Returns

Defined in

getModelTransformation

Parameters

Returns

Implementation of

Defined in

getSubtreeTreeIndices

Parameters

Returns