Class: CognitePointCloudModel
@cognite/reveal.CognitePointCloudModel
Hierarchy
-
Object3D↳
CognitePointCloudModel
Implements
Properties
modelId
• Readonly modelId: number
Defined in
packages/pointclouds/src/CognitePointCloudModel.ts:21
revisionId
• Readonly revisionId: number
The modelId of the point cloud model in Cognite Data Fusion.
Defined in
packages/pointclouds/src/CognitePointCloudModel.ts:25
type
• Readonly type: SupportedModelTypes = 'pointcloud'
Implementation of
Overrides
THREE.Object3D.type
Defined in
packages/pointclouds/src/CognitePointCloudModel.ts:20
Accessors
pointColorType
• get pointColorType(): PotreePointColorType
Determines how points currently are colored.
Returns
Defined in
packages/pointclouds/src/CognitePointCloudModel.ts:147
• set pointColorType(type): void
Specifies how points are colored.
default PotreePointColorType.Rgb
example
model.pointColorType = PotreePointColorType.Rgb
Parameters
| Name | Type |
|---|---|
type | PotreePointColorType |
Returns
void
Defined in
packages/pointclouds/src/CognitePointCloudModel.ts:159
pointShape
• get pointShape(): PotreePointShape
Sets the point shape of each rendered point in the point cloud.
default PotreePointShape.Circle
see PotreePointShape.
Returns
Defined in
packages/pointclouds/src/CognitePointCloudModel.ts:199
• set pointShape(shape): void
Gets the point shape of each rendered point in the point cloud.
see PotreePointShape.
Parameters
| Name | Type |
|---|---|
shape | PotreePointShape |
Returns
void
Defined in
packages/pointclouds/src/CognitePointCloudModel.ts:207
pointSize
• get pointSize(): number
Returns the size of each rendered point in the point cloud.
Returns
number
Defined in
packages/pointclouds/src/CognitePointCloudModel.ts:166
• set pointSize(size): void
Sets the size of each rendered point in the point cloud.
default 1
Parameters
| Name | Type |
|---|---|
size | number |
Returns
void
Defined in
packages/pointclouds/src/CognitePointCloudModel.ts:174
pointSizeType
• get pointSizeType(): PotreePointSizeType
Get the point size type.
Returns
Defined in
packages/pointclouds/src/CognitePointCloudModel.ts:181
• set pointSizeType(type): void
Set the point size type for the point cloud. The point size type can be either Fixed or Adaptive.
default PotreePointSizeType.Adaptive
Parameters
| Name | Type |
|---|---|
type | PotreePointSizeType |
Returns
void
Defined in
packages/pointclouds/src/CognitePointCloudModel.ts:190
visiblePointCount
• get visiblePointCount(): number
Returns the current number of visible/loaded points.
Returns
number
Defined in
packages/pointclouds/src/CognitePointCloudModel.ts:140
Methods
dispose
▸ dispose(): void
Used to clean up memory.
Returns
void
Implementation of
Defined in
packages/pointclouds/src/CognitePointCloudModel.ts:49
getCameraConfiguration
▸ getCameraConfiguration(): 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
Implementation of
CogniteModelBase.getCameraConfiguration
Defined in
packages/pointclouds/src/CognitePointCloudModel.ts:77
getClasses
▸ getClasses(): number[]
Returns a list of sorted classification codes present in the model.
Returns
number[]
A sorted list of classification codes from the model.
Defined in
packages/pointclouds/src/CognitePointCloudModel.ts:133
getModelBoundingBox
▸ getModelBoundingBox(outBbox?): Box3
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();
Parameters
| Name | Type | Description |
|---|---|---|
outBbox? | Box3 | Optional. Used to write result to. |
Returns
Box3
Model's bounding box.
Implementation of
CogniteModelBase.getModelBoundingBox
Defined in
packages/pointclouds/src/CognitePointCloudModel.ts:68
getModelTransformation
▸ getModelTransformation(out?): Matrix4
Gets transformation matrix of the model.
Parameters
| Name | Type | Description |
|---|---|---|
out? | Matrix4 | Preallocated THREE.Matrix4 (optional). |
Returns
Matrix4
Implementation of
CogniteModelBase.getModelTransformation
Defined in
packages/pointclouds/src/CognitePointCloudModel.ts:93
hasClass
▸ hasClass(pointClass): boolean
Returns true if the model has values with the given classification class.
Parameters
| Name | Type | Description |
|---|---|---|
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:125
isClassVisible
▸ isClassVisible(pointClass): boolean
Determines if points from a given class are visible.
throws Error if the model doesn't have the class given.
Parameters
| Name | Type | Description |
|---|---|---|
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.
Defined in
packages/pointclouds/src/CognitePointCloudModel.ts:115
setClassVisible
▸ setClassVisible(pointClass, visible): void
Sets a visible filter on points of a given class.
throws Error if the model doesn't have the class given.
Parameters
| Name | Type | Description |
|---|---|---|
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
Defined in
packages/pointclouds/src/CognitePointCloudModel.ts:104
setModelTransformation
▸ setModelTransformation(transformationMatrix): void
Sets transformation matrix of the model. This overrides the current transformation.
Parameters
| Name | Type |
|---|---|
transformationMatrix | Matrix4 |
Returns
void
Implementation of
CogniteModelBase.setModelTransformation