Class: MeasurementTool
@cognite/reveal/tools.MeasurementTool
Enables Cognite3DViewer to perform a point to point measurement. This can be achieved by selecting a point on the 3D Object and drag the pointer to required point to get measurement of the distance. The tools default measurement is in "Meters" as supported in Reveal, but it also provides user to customise the measuring units based on their convinience with the callback.
Example
const measurementTool = new MeasurementTool(viewer);
measurementTool.enterMeasurementMode();
// ...
measurementTool.exitMeasurementMode();
// detach the tool from the viewer
measurementTool.dispose();
Example
Hierarchy
↳
MeasurementTool
Constructors
constructor
• new MeasurementTool(viewer
, options?
)
Parameters
Name | Type |
---|---|
viewer | Cognite3DViewer |
options? | MeasurementOptions |
Overrides
Cognite3DViewerToolBase.constructor
Defined in
packages/tools/src/Measurement/MeasurementTool.ts:91
Accessors
isInMeasurementMode
• get
isInMeasurementMode(): boolean
Returns measurement mode state, is measurement mode started or ended.
Returns
boolean
Defined in
packages/tools/src/Measurement/MeasurementTool.ts:54
Methods
dispose
▸ dispose(): void
Dispose Measurement Tool.
Returns
void
Overrides
Cognite3DViewerToolBase.dispose
Defined in
packages/tools/src/Measurement/MeasurementTool.ts:367
enterMeasurementMode
▸ enterMeasurementMode(): void
Enter into point to point measurement mode.
Returns
void
Defined in
packages/tools/src/Measurement/MeasurementTool.ts:235
exitMeasurementMode
▸ exitMeasurementMode(): void
Exit measurement mode.
Returns
void
Defined in
packages/tools/src/Measurement/MeasurementTool.ts:249
getAllMeasurements
▸ getAllMeasurements(): Measurement
[]
Get all measurements from Cognite3DViewer.
Returns
Array of Measurements containing Id, start point, end point & measured distance.
Defined in
packages/tools/src/Measurement/MeasurementTool.ts:346
off
▸ off(event
, callback
): void
Example
measurementTool.off('disposed', onMeasurementDispose);
Parameters
Name | Type |
---|---|
event | "disposed" |
callback | DisposedDelegate |
Returns
void
Overrides
Defined in
packages/tools/src/Measurement/MeasurementTool.ts:179
▸ off(event
, callback
): void
Example
measurementTool.off('added', onMeasurementAdded);
Parameters
Name | Type |
---|---|
event | "added" |
callback | MeasurementAddedDelegate |
Returns
void
Overrides
Cognite3DViewerToolBase.off
Defined in
packages/tools/src/Measurement/MeasurementTool.ts:187
▸ off(event
, callback
): void
Example
measurementTool.off('started', onMeasurementStarted);
Parameters
Name | Type |
---|---|
event | "started" |
callback | MeasurementStartedDelegate |
Returns
void
Overrides
Cognite3DViewerToolBase.off
Defined in
packages/tools/src/Measurement/MeasurementTool.ts:195
▸ off(event
, callback
): void
Example
measurementTool.off('ended', onMeasurementEnded);
Parameters
Name | Type |
---|---|
event | "ended" |
callback | MeasurementEndedDelegate |
Returns
void
Overrides
Cognite3DViewerToolBase.off
Defined in
packages/tools/src/Measurement/MeasurementTool.ts:203
on
▸ on(event
, callback
): void
Triggered when the tool is disposed. Listeners should clean up any resources held and remove the reference to the tool.
Example
measurementTool.on('disposed', onMeasurementDispose);
Parameters
Name | Type |
---|---|
event | "disposed" |
callback | DisposedDelegate |
Returns
void
Overrides
Cognite3DViewerToolBase.on
Defined in
packages/tools/src/Measurement/MeasurementTool.ts:117
▸ on(event
, callback
): void
Triggered when a measurement is added into the Cognite3DViewer.
Example
measurementTool.on('added', onMeasurementAdded);
Parameters
Name | Type |
---|---|
event | "added" |
callback | MeasurementAddedDelegate |
Returns
void
Overrides
Cognite3DViewerToolBase.on
Defined in
packages/tools/src/Measurement/MeasurementTool.ts:126
▸ on(event
, callback
): void
Triggered when a measurement mode is started.
Example
measurementTool.on('started', onMeasurementStarted);
Parameters
Name | Type |
---|---|
event | "started" |
callback | MeasurementStartedDelegate |
Returns
void
Overrides
Cognite3DViewerToolBase.on
Defined in
packages/tools/src/Measurement/MeasurementTool.ts:135
▸ on(event
, callback
): void
Triggered when measurement mode is ended.
Example
measurementTool.on('ended', onMeasurementEnded);
Parameters
Name | Type |
---|---|
event | "ended" |
callback | MeasurementEndedDelegate |
Returns
void
Overrides
Cognite3DViewerToolBase.on
Defined in
packages/tools/src/Measurement/MeasurementTool.ts:144
removeAllMeasurements
▸ removeAllMeasurements(): void
Removes all measurements from the Cognite3DViewer.
Returns
void
Defined in
packages/tools/src/Measurement/MeasurementTool.ts:279
removeMeasurement
▸ removeMeasurement(measurement
): void
Removes a measurement from the Cognite3DViewer.
Parameters
Name | Type | Description |
---|---|---|
measurement | Measurement | Measurement to be removed from Cognite3DViewer. |
Returns
void
Defined in
packages/tools/src/Measurement/MeasurementTool.ts:264
setLineOptions
▸ setLineOptions(options
): void
Sets Measurement line width, color and label units value for the next measurment.
Parameters
Name | Type | Description |
---|---|---|
options | MeasurementOptions | MeasurementOptions to set line width, color and callback for custom operation on measurement labels. |
Returns
void
Defined in
packages/tools/src/Measurement/MeasurementTool.ts:303
setMeasurementLabelsVisible
▸ setMeasurementLabelsVisible(enable
): void
Sets the visiblity of labels in the Measurement.
Parameters
Name | Type |
---|---|
enable | boolean |
Returns
void
Defined in
packages/tools/src/Measurement/MeasurementTool.ts:292
updateLineColor
▸ updateLineColor(measurement
, color
): void
Update selected line color.
Parameters
Name | Type | Description |
---|---|---|
measurement | Measurement | Measurement to be updated. |
color | Color | Color of the measuring line. |
Returns
void
Defined in
packages/tools/src/Measurement/MeasurementTool.ts:331
updateLineWidth
▸ updateLineWidth(measurement
, lineWidth
): void
Update selected line width.
Parameters
Name | Type | Description |
---|---|---|
measurement | Measurement | Measurement to be updated. |
lineWidth | number | Width of the measuring line. |
Returns
void
Defined in
packages/tools/src/Measurement/MeasurementTool.ts:315
visible
▸ visible(enable
): void
Hide/unhide all measurements
Parameters
Name | Type |
---|---|
enable | boolean |
Returns
void