MeasurementAPI#

Interface MeasurementAPI

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

Hierarchy

Methods

  • Parameters

    • measurementID: number
    • progress: MeasurementProgress
    • Optional visible: boolean
    • Optional name: string

    Returns void

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

    Parameters

    Returns number

  • Parameters

    • measurementID: number

      The ID of the Measurement.

    Returns MeasurementData

    The MeasurementData.

  • Returns number[]

    The IDs of all available Measurements.

  • 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

    Returns Promise<BetweenMeasurementResult>

    The result of the measurement between the two specified targets.

  • 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.

    • 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.

  • 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.

    • 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.

  • The measurement for the given measurementID is removed.

    Parameters

    • measurementID: number

    Returns void

  • Calculates the additional measurement information like thickness and displays it in the UI.

    Parameters

    • measurementID: number

      the ID of a Measurement

    Returns void

  • 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?
Please tell us more about what's wrong: