MeasurementAPI

Description

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

changeMeasurement(measurementID, progress, visible, name)

Arguments

• measurementID (number()) –

• progress – (MeasurementProgress )

• visible (boolean()) – Optional

• name (string()) – Optional

Returns

void

createMeasurement(type, clickResult1, clickResult2, name)

Creates a new measurement and returns the ID. If no name is given, the measurement will be automatically named (e.g., “Measurement 23”).

Arguments

• type – (MeasurementType )

• clickResult1 – (IClickResult )

• clickResult2 –

  (IClickResult ) Optional

• name (string()) – Optional

Returns

number –

getMeasurementData(measurementID)

Arguments

• measurementID (number()) –

Returns

MeasurementData

getMeasurements()

Returns the ids of all available measurements

Returns

Array<number> – The ids of all available measurements

measureTangent(measurementDescriptor, l3dToShapeInstanceIDMap)

Arguments

• measurementDescriptor – (MeasurementDescriptor )

• l3dToShapeInstanceIDMap (Map) –

Returns

Promise<ITangentMeasurementResult>

removeMeasurement(measurementID)

The measurement for the given measurementID is removed.

Arguments

• measurementID (number()) –

Returns

void

requestAdditionalMeasurementData(measurementID)

Arguments

• measurementID (number()) –

Returns

void

restoreMeasurement(data, measurementID)

Arguments

• data (MeasurementData()) –

• measurementID (number()) – Optional

Returns

number