Skip to content

Commit 5fb606e

Browse files
doc: improve CognitePointCloudModel doc (#1135)
* doc: fix broken links in doc * doc: more improvements Co-authored-by: cognite-bulldozer[bot] <51074376+cognite-bulldozer[bot]@users.noreply.github.com>
1 parent 9a62822 commit 5fb606e

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

viewer/src/public/migration/CognitePointCloudModel.ts

+14-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,13 @@ import { PointCloudNode } from '@/datamodels/pointcloud/PointCloudNode';
1717
export class CognitePointCloudModel extends THREE.Object3D implements CogniteModelBase {
1818
public readonly type: SupportedModelTypes = 'pointcloud';
1919
public readonly modelId: number;
20+
/**
21+
* The modelId of the point cloud model in Cognite Data Fusion.
22+
*/
2023
public readonly revisionId: number;
24+
/**
25+
* The revisionId of the specific model revision in Cognite Data Fusion.
26+
*/
2127
private readonly pointCloudNode: PointCloudNode;
2228

2329
/**
@@ -88,6 +94,9 @@ export class CognitePointCloudModel extends THREE.Object3D implements CogniteMod
8894
return this.pointCloudNode.getModelTransformation(out);
8995
}
9096

97+
/**
98+
* Returns the current budget measured in number of points.
99+
*/
91100
get pointBudget(): number {
92101
return this.pointCloudNode.pointBudget;
93102
}
@@ -101,12 +110,16 @@ export class CognitePointCloudModel extends THREE.Object3D implements CogniteMod
101110
this.pointCloudNode.pointBudget = count;
102111
}
103112

113+
/**
114+
* Determines how points currently are colored.
115+
*/
104116
get pointColorType(): PotreePointColorType {
105117
return this.pointCloudNode.pointColorType;
106118
}
107119

108120
/**
109-
* @see {@link PotreePointColorType} For available types.
121+
* Specifies how points are colored.
122+
* @default PotreePointColorType.Rgb
110123
* @example
111124
* ```js
112125
* model.pointColorType = PotreePointColorType.Rgb

0 commit comments

Comments
 (0)