MeasurementAPI

• webVis API Reference
• 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 measureBetween measureTangent measureThickness removeMeasurement requestAdditionalMeasurementData restoreMeasurement

Methods

changeMeasurement

• changeMeasurement(measurementID, progress, visible?, name?): void

• Parameters

  • measurementID: number

  • progress: MeasurementProgress

  • Optional visible: boolean

  • Optional name: string

  Returns void

createMeasurement

• createMeasurement(type, descriptors, name?): 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

  • descriptors: MeasurementDescriptor[]

  • Optional name: string

  Returns number

getMeasurementData

• getMeasurementData(measurementID): MeasurementData

• Parameters

  • measurementID: number

    The ID of the Measurement.

  Returns MeasurementData

  The MeasurementData.

getMeasurements

• getMeasurements(): number[]

• Returns number[]

  The IDs of all available Measurements.

measureBetween

• measureBetween(target0, target1): Promise<BetweenMeasurementResult>
• Experimental

  Measures the distance and if possible the angle between two measurement targets.

  ATTENTION This API is experimental and may be changed in the future without notice!

  Parameters

  • target0: MeasurementTarget

    The first measurement target.

  • target1: MeasurementTarget

    The second measurement target.

  Returns Promise<BetweenMeasurementResult>

  The result of the measurement between the two specified targets.

measureTangent

• measureTangent(topology, point): Promise<TangentMeasurementResult>
• Experimental

  Measures the tangent of an edge at the specified point.

  ATTENTION This API is experimental and may be changed in the future without notice!

  Parameters

  • topology: {
        class: TOPOLOGY;
        value: TopologyHandle;
    }

    The topological target.

    • class: TOPOLOGY

      Describes the MeasurementTargetClass of the target.

    • value: TopologyHandle

      Describes the value of the target depending on the specified class.

  • point: {
        class: POINT;
        value: [number, number, number];
    }

    The point target.

    • class: POINT

      Describes the MeasurementTargetClass of the target.

    • value: [number, number, number]

      Describes the value of the target depending on the specified class.

  Returns Promise<TangentMeasurementResult>

  The result of the tangent measurement.

measureThickness

• measureThickness(topology, point): Promise<ThicknessMeasurementResult>
• Experimental

  Measures the thickness of a shape at the specified point.

  ATTENTION This API is experimental and may be changed in the future without notice!

  Parameters

  • topology: {
        class: TOPOLOGY;
        value: TopologyHandle;
    }

    The topological target.

    • class: TOPOLOGY

      Describes the MeasurementTargetClass of the target.

    • value: TopologyHandle

      Describes the value of the target depending on the specified class.

  • point: {
        class: POINT;
        value: [number, number, number];
    }

    The point target.

    • class: POINT

      Describes the MeasurementTargetClass of the target.

    • value: [number, number, number]

      Describes the value of the target depending on the specified class.

  Returns Promise<ThicknessMeasurementResult>

  The result of the thickness measurement.

removeMeasurement

• removeMeasurement(measurementID): void

• The measurement for the given measurementID is removed.

  Parameters

  • measurementID: number

  Returns void

requestAdditionalMeasurementData

• requestAdditionalMeasurementData(measurementID): 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, measurementID?): number

• Parameters

  • data: MeasurementData

    The MeasurementData that should be restored.

  • Optional measurementID: number

    The ID of the restored Measurement.

  Returns number