MeasurementAPI

• webVis API Reference
• MeasurementAPI

Interface MeasurementAPI

These functions allow the creation of Measurements.

Example

// Get the context
const context : ContextAPI = webvis.getContext();

// Define a point target
const pointTarget : webvis.MeasurementTarget<MeasurementTargetClass.POINT> =
{
    class: webvis.MeasurementTargetClass.POINT,
    value: [ 0, 0, 0 ]
};

// Define a plane target
const planeTarget : webvis.MeasurementTarget<MeasurementTargetClass.PLANE> =
{
    class: webvis.MeasurementTargetClass.PLANE,
    value: [ 1, 0, 0, 1 ]
}

// Create a new single Measurement
const singleMeasurementID : number = context.createMeasurement(
    webvis.MeasurementType.SINGLE,
    [ pointTarget ],
    { enabled: true }
);

// Create a double Measurement between a point and a plane
const doubleMeasurementID : number = context.createMeasurement(
    webvis.MeasurementType.MULTIPLE,
    [ pointTarget, planeTarget ],
    { enabled: true }
);

Hierarchy

• MeasurementAPI
  • ContextAPI

Index

Methods

changeMeasurement createMeasurement getMeasurements measureBetween measureTangent measureThickness removeMeasurement requestMeasurementData

Methods

changeMeasurement

• changeMeasurement(measurementID, properties): MeasurementProperties

• Changes one or more properties of a Measurement with the specified id.

  Parameters

  • measurementID: number

    The id of the Measurement you want to change.

  • properties: MeasurementProperties

    The properties of the Measurement you want change.

  Returns MeasurementProperties

  An Object with the changed Properties.

createMeasurement

• createMeasurement<T>(type, targets, properties?): number

• Creates a new Measurement.

  Type Parameters

  • T extends keyof MeasurementTypeToTargetMap

  Parameters

  • type: T

    The type of the Measurement.

  • targets: MeasurementTypeToTargetMap[T]

    The targets of the Measurement.

  • Optional properties: MeasurementProperties

    The properties of the Measurement.

  Returns number

  The ID of the created Measurement.

getMeasurements

• getMeasurements(): number[]

• Returns number[]

  The IDs of all available Measurements.

measureBetween

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

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

  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>

• Measures the tangent of an edge at the specified point.

  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>

• Measures the thickness of a shape at the specified point.

  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, safe?): RemoveState

• Removes the Measurement from the scene and all related Snapshots.

  Parameters

  • measurementID: number

  • Optional safe: boolean

    Performs a safe remove which interrupt the removal process if the Measurement is part of one or more Snapshots.

  Returns RemoveState

requestMeasurementData

• requestMeasurementData(measurementID): Promise<MeasurementProperties>

• Returns the MeasurementProperties for the specified Measurement id.

  Parameters

  • measurementID: number

    The id of the Measurement you want to request the data for.

  Returns Promise<MeasurementProperties>

  The requested Measurement properties.