MeasurementAPI#

Interface MeasurementAPI

These functions allow the creation of Measurements. A Measurement describes the distance between two points in the world.

Hierarchy

MeasurementAPI
- ContextAPI

Index

Methods

changeMeasurement createMeasurement getMeasurementData getMeasurements measureTangent removeMeasurement requestAdditionalMeasurementData restoreMeasurement

Methods

changeMeasurement

changeMeasurement(measurementID: number, progress: MeasurementProgress, visible?: boolean, name?: string): void
Parameters
- measurementID: number
- progress: MeasurementProgress
- Optional visible: boolean
- Optional name: string
Returns void

createMeasurement

createMeasurement(type: MeasurementType, clickResult1: IClickResult, clickResult2?: IClickResult, name?: string): number
Creates a new measurement and returns the ID. If no name is given, the measurement will be automatically named (e.g., “Measurement 23”).
Parameters
- type: MeasurementType
- clickResult1: IClickResult
- Optional clickResult2: IClickResult
- Optional name: string
Returns number

getMeasurementData

getMeasurementData(measurementID: number): MeasurementData
Parameters
- measurementID: number
  
  The ID of the Measurement.
Returns MeasurementData
The MeasurementData.

getMeasurements

getMeasurements(): number[]
Returns number[]
The IDs of all available Measurements.

measureTangent

measureTangent(measurementDescriptor: MeasurementDescriptor, l3dToShapeInstanceIDMap: Map<number, number[]>): Promise<TangentMeasurementResult>
Parameters
- measurementDescriptor: MeasurementDescriptor
- l3dToShapeInstanceIDMap: Map<number, number[]>
Returns Promise<TangentMeasurementResult>

removeMeasurement

removeMeasurement(measurementID: number): void
The measurement for the given measurementID is removed.
Parameters
- measurementID: number
Returns void

requestAdditionalMeasurementData

requestAdditionalMeasurementData(measurementID: number): void
Calculates the additional measurement information like thickness and displays it in the UI.
Parameters
- measurementID: number
  
  the ID of a Measurement
Returns void

restoreMeasurement

restoreMeasurement(data: MeasurementData, measurementID?: number): number
Parameters
- data: MeasurementData
  
  The MeasurementData that should be restored.
- Optional measurementID: number
  
  The ID of the restored Measurement.
Returns number

Did you find this page useful? Please give it a rating:

★ ★ ★ ★ ★

Thank you for rating this page!

Any issues or feedback?

What kind of problem would you like to report?

This page needs code samples
Code samples do not work
Information is missing
Please tell us more about what's wrong:
Information is incorrect
Please tell us more about what's wrong:
Information is unclear or confusing
Please tell us more about what's wrong:
The page is rendered incorrectly (styling/CSS)
Give Feedback