Skip to main content
Version: Next

Class: CognitePointCloudModel<T>

Type Parameters

T extends DataSourceType = ClassicDataSourceType

Properties

modelId

readonly modelId: number = 0

The modelId of the point cloud model in Cognite Data Fusion. 0 if not applicable

Deprecated

Use modelIdentifier instead

Defined in

packages/pointclouds/src/CognitePointCloudModel.ts:35


modelIdentifier

readonly modelIdentifier: T["modelIdentifier"]

The identifier of this model

Defined in

packages/pointclouds/src/CognitePointCloudModel.ts:45


revisionId

readonly revisionId: number = 0

The revisionId of the specific model revision in Cognite Data Fusion. 0 if not applicable

Deprecated

Use modelIdentifier instead

Defined in

packages/pointclouds/src/CognitePointCloudModel.ts:40


type

readonly type: SupportedModelTypes = 'pointcloud'

Defined in

packages/pointclouds/src/CognitePointCloudModel.ts:29

Accessors

pointColorType

Get Signature

get pointColorType(): PointColorType

Determines how points currently are colored.

Returns

PointColorType

Set Signature

set pointColorType(type): void

Specifies how points are colored.

Default
PointColorType.Rgb
Example
model.pointColorType = PointColorType.Rgb
Parameters

type: PointColorType

Returns

void

Defined in

packages/pointclouds/src/CognitePointCloudModel.ts:200


pointShape

Get Signature

get pointShape(): PointShape

Sets the point shape of each rendered point in the point cloud.

Default

PointShape.Circle

See

PointShape.

Returns

PointShape

Set Signature

set pointShape(shape): void

Gets the point shape of each rendered point in the point cloud.

See

PointShape.

Parameters

shape: PointShape

Returns

void

Defined in

packages/pointclouds/src/CognitePointCloudModel.ts:252


pointSize

Get Signature

get pointSize(): number

Returns the size of each rendered point in the point cloud.

Returns

number

Set Signature

set pointSize(size): void

Sets the size of each rendered point in the point cloud.

Default

1

Parameters

size: number

Returns

void

Defined in

packages/pointclouds/src/CognitePointCloudModel.ts:219


pointSizeType

Get Signature

get pointSizeType(): PointSizeType

Get the point size type.

Returns

PointSizeType

Set Signature

set pointSizeType(type): void

Set the point size type for the point cloud. The point size type can be either Fixed or Adaptive.

Default

PointSizeType.Adaptive

Parameters

type: PointSizeType

Returns

void

Defined in

packages/pointclouds/src/CognitePointCloudModel.ts:234


stylableObjectCount

Get Signature

get stylableObjectCount(): number

Returns

number

The number of stylable objects

Defined in

packages/pointclouds/src/CognitePointCloudModel.ts:405


stylableObjects

Get Signature

get stylableObjects(): PointCloudObjectMetadata<T>[]

Gets array of stylable objects for the point cloud model.

Example
model.stylableObjects.forEach(pointCloudMetadata => console.log(pointCloudMetadata.annotationId));
// or
model.stylableObjects.forEach(pointCloudMetadata => {
if (isDMPointCloudVolume(pointCloudMetadata))
console.log(pointCloudMetadata.volumeInstanceRef);
});
Returns

PointCloudObjectMetadata<T>[]

All stylable objects for this model *

Defined in

packages/pointclouds/src/CognitePointCloudModel.ts:335


styledCollections

Get Signature

get styledCollections(): StyledPointCloudVolumeCollection<T>[]

Gets the object collections that have been assigned a style

Returns

StyledPointCloudVolumeCollection<T>[]

All object collections and their associated style

Defined in

packages/pointclouds/src/CognitePointCloudModel.ts:318


visible

Get Signature

get visible(): boolean

Returns the model visibility.

Returns

boolean

Set Signature

set visible(value): void

Sets the model visibility.

Example
model.visible = false
Parameters

value: boolean

Returns

void

Defined in

packages/pointclouds/src/CognitePointCloudModel.ts:278


visiblePointCount

Get Signature

get visiblePointCount(): number

Returns the current number of visible/loaded points.

Returns

number

Defined in

packages/pointclouds/src/CognitePointCloudModel.ts:193

Methods

assignStyledObjectCollection()

assignStyledObjectCollection(objectCollection, appearance): void

Assign a style to a collection of objects. If the object collection has been assigned a style previously, the previous style will be replaced by the new one.

Parameters

objectCollection: T["pointCloudCollectionType"]

The object collection to assign a style to

appearance: PointCloudAppearance

The style to assign to the object collection

Returns

void

Defined in

packages/pointclouds/src/CognitePointCloudModel.ts:345


dispose()

dispose(): void

Used to clean up memory.

Returns

void

Defined in

packages/pointclouds/src/CognitePointCloudModel.ts:72


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/pointclouds/src/CognitePointCloudModel.ts:98


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 CognitePointCloudModel.setModelTransformation

Parameters

out?: Matrix4

Preallocated THREE.Matrix4 (optional)

Returns

Matrix4

Defined in

packages/pointclouds/src/CognitePointCloudModel.ts:125


getClasses()

getClasses(): object[]

Returns a list of sorted classification names and codes present in the model. Names will be the custom names provided by the user, or a default one if none have been provided.

Returns

object[]

A sorted list of classification codes and names from the model.

Defined in

packages/pointclouds/src/CognitePointCloudModel.ts:186


getDefaultPointCloudAppearance()

getDefaultPointCloudAppearance(): PointCloudAppearance

Gets default point appearance

Returns

PointCloudAppearance

Defined in

packages/pointclouds/src/CognitePointCloudModel.ts:300


getModelBoundingBox()

getModelBoundingBox(outBoundingBox?): Box3

Parameters

outBoundingBox?: Box3

Optional. Used to write result to.

Returns

Box3

Model's bounding box.

Example

const boundingBox = new THREE.Box3()
model.getModelBoundingBox(boundingBox);
// boundingBox now has the bounding box
// the following code does the same
const boundingBox = model.getModelBoundingBox();

Defined in

packages/pointclouds/src/CognitePointCloudModel.ts:89


getModelClippingPlanes()

getModelClippingPlanes(): Plane[]

Get the clipping planes for this model.

Returns

Plane[]

Defined in

packages/pointclouds/src/CognitePointCloudModel.ts:293


getModelTransformation()

getModelTransformation(out?): Matrix4

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

Parameters

out?: Matrix4

Preallocated THREE.Matrix4 (optional).

Returns

Matrix4

Defined in

packages/pointclouds/src/CognitePointCloudModel.ts:115


hasClass()

hasClass(pointClass): boolean

Returns true if the model has values with the given classification class.

Parameters

pointClass: number

ASPRS classification class code. Either one of the well known classes from WellKnownAsprsPointClassCodes or a number for user defined classes.

Returns

boolean

True if model has values in the class given.

Defined in

packages/pointclouds/src/CognitePointCloudModel.ts:177


isClassVisible()

isClassVisible(pointClass): boolean

Determines if points from a given class are visible.

Parameters

pointClass: number

ASPRS classification class code. Either one of the well known classes from WellKnownAsprsPointClassCodes or a number for user defined classes.

Returns

boolean

True if points from the given class will be visible.

Throws

Error if the model doesn't have the class given.

Defined in

packages/pointclouds/src/CognitePointCloudModel.ts:167


mapBoxFromCdfToModelCoordinates()

mapBoxFromCdfToModelCoordinates(box, out): Box3

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

Parameters

box: Box3

Box to compute transformation from

out: Box3 = ...

Optional pre-allocated box

Returns

Box3

Defined in

packages/pointclouds/src/CognitePointCloudModel.ts:144


mapPointFromCdfToModelCoordinates()

mapPointFromCdfToModelCoordinates(point, out): Vector3

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

Parameters

point: Vector3

Point to compute transformation from

out: Vector3 = ...

Optional pre-allocated point

Returns

Vector3

Defined in

packages/pointclouds/src/CognitePointCloudModel.ts:134


removeAllStyledObjectCollections()

removeAllStyledObjectCollections(): void

Removes styling on all object collections in this model

Returns

void

Defined in

packages/pointclouds/src/CognitePointCloudModel.ts:397


setClassVisible()

setClassVisible(pointClass, visible): void

Sets a visible filter on points of a given class.

Parameters

pointClass: number

ASPRS classification class code. Either one of the well known classes from WellKnownAsprsPointClassCodes or a number for user defined classes.

visible: boolean

Boolean flag that determines if the point class type should be visible or not.

Returns

void

Throws

Error if the model doesn't have the class given.

Defined in

packages/pointclouds/src/CognitePointCloudModel.ts:156


setDefaultPointCloudAppearance()

setDefaultPointCloudAppearance(appearance): void

Sets default apparance for points that are not styled otherwise

Parameters

appearance: PointCloudAppearance

Appearance to assign as default

Returns

void

Defined in

packages/pointclouds/src/CognitePointCloudModel.ts:308


setModelClippingPlanes()

setModelClippingPlanes(clippingPlanes): void

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

Parameters

clippingPlanes: Plane[]

Returns

void

Defined in

packages/pointclouds/src/CognitePointCloudModel.ts:286


setModelTransformation()

setModelTransformation(transformationMatrix): void

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

Parameters

transformationMatrix: Matrix4

The new transformation matrix

Returns

void

Defined in

packages/pointclouds/src/CognitePointCloudModel.ts:106


traverseStylableObjects()

traverseStylableObjects(callback): void

Parameters

callback

Returns

void

Deprecated

Use CognitePointCloudModel.stylableObjects Iterates through all stylable objects for this model

Example

model.traverseStylableObjects(
annotationMetadata => console.log(annotationMetadata.annotationId)
);

Defined in

packages/pointclouds/src/CognitePointCloudModel.ts:419


unassignStyledObjectCollection()

unassignStyledObjectCollection(objectCollection): void

Unassign style from an already styled object collection.

Parameters

objectCollection: T["pointCloudCollectionType"]

The object collection from which to remove the style

Returns

void

Defined in

packages/pointclouds/src/CognitePointCloudModel.ts:365