Class MeasurementsState

constructor

• new MeasurementsState(renderer: BaseRenderer): MeasurementsState

  Constructor for MeasurementsState.

  Parameters

  • renderer: BaseRenderer

    The renderer instance.

  Returns MeasurementsState

snapAvailable

snapPointShowing

pointToSnapX

pointToSnapY

pointToSnapZ

measurementsExtruded

• get measurementsExtruded(): boolean

  Returns boolean

commandChangedEvent

• get commandChangedEvent(): IEvent<MEASUREMENT_COMMAND, MEASUREMENT_COMMAND>

  Gets the command changed event.

  Returns IEvent<MEASUREMENT_COMMAND, MEASUREMENT_COMMAND>

measuring

• get measuring(): boolean

  Checks if measuring is in progress.

  Returns boolean

measurementsUpdatedEvent

• get measurementsUpdatedEvent(): IEvent<BaseRenderer, Measurement[]>

  Gets the measurements updated event.

  Returns IEvent<BaseRenderer, Measurement[]>

measurementsDeletedEvent

• get measurementsDeletedEvent(): IEvent<
      BaseRenderer,
      { id: Int64; userObject: any }[],
  >

  Gets the measurements deleted event.

  Returns IEvent<BaseRenderer, { id: Int64; userObject: any }[]>

measurementsSelectedEvent

• get measurementsSelectedEvent(): IEvent<BaseRenderer, Measurement[]>

  Gets the measurements selected event.

  Returns IEvent<BaseRenderer, Measurement[]>

measurementsPointPushBackEvent

• get measurementsPointPushBackEvent(): IEvent<BaseRenderer, Measurement[]>

  Gets the measurements point push back event.

  Returns IEvent<BaseRenderer, Measurement[]>

pointJustInserted

• get pointJustInserted(): boolean

  Gets the point just inserted status.

  Returns boolean
• set pointJustInserted(ji: boolean): void

  Sets the point just inserted status.

  Parameters

  • ji: boolean

    The status.

  Returns void

lastX

• get lastX(): number

  Gets the last X coordinate.

  Returns number
• set lastX(lastX: number): void

  Sets the last X coordinate.

  Parameters

  • lastX: number

    The X coordinate.

  Returns void

lastY

• get lastY(): number

  Gets the last Y coordinate.

  Returns number
• set lastY(lastY: number): void

  Sets the last Y coordinate.

  Parameters

  • lastY: number

    The Y coordinate.

  Returns void

lastMovingPoint

• get lastMovingPoint(): Vector3D

  Gets the last moving point.

  Returns Vector3D
• set lastMovingPoint(movePoint: Vector3D): void

  Sets the last moving point.

  Parameters

  • movePoint: Vector3D

    The moving point.

  Returns void

lastMovedPivotPoint

• get lastMovedPivotPoint(): Vector3D

  Gets the last moved pivot point.

  Returns Vector3D
• set lastMovedPivotPoint(pivotPoint: Vector3D): void

  Sets the last moved pivot point.

  Parameters

  • pivotPoint: Vector3D

    The pivot point.

  Returns void

lastSegmentPoints

• get lastSegmentPoints(): Vector3D[]

  Gets the last segment points.

  Returns Vector3D[]
• set lastSegmentPoints(lastSegmentPoints: Vector3D[]): void

  Sets the last segment points.

  Parameters

  • lastSegmentPoints: Vector3D[]

    The segment points.

  Returns void

isMovementByDuplicate

• get isMovementByDuplicate(): boolean

  Gets the movement by duplicate status.

  Returns boolean

aggregationMode

• get aggregationMode(): AGGREGATION_MODE

  Gets the aggregation mode.

  Returns AGGREGATION_MODE
• set aggregationMode(aggregationMode: AGGREGATION_MODE): void

  Sets the aggregation mode.

  Parameters

  • aggregationMode: AGGREGATION_MODE

    The aggregation mode.

  Returns void

measureSystem

• get measureSystem(): BIM_MEASUREMENT_UNITS

  Gets the measurement system.

  Returns BIM_MEASUREMENT_UNITS
• set measureSystem(unit: BIM_MEASUREMENT_UNITS): void

  Sets the measurement system.

  Parameters

  • unit: BIM_MEASUREMENT_UNITS

    The measurement unit.

  Returns void

currentCommand

• get currentCommand(): MEASUREMENT_COMMAND

  Gets the current command.

  Returns MEASUREMENT_COMMAND

previousCommand

• get previousCommand(): MEASUREMENT_COMMAND

  Gets the previous command.

  Returns MEASUREMENT_COMMAND

ghostPointVisible

• get ghostPointVisible(): boolean

  Gets the ghost point visible status.

  Returns boolean
• set ghostPointVisible(val: boolean): void

  Sets the ghost point visible status.

  Parameters

  • val: boolean

    The status.

  Returns void

lastId

• get lastId(): number

  Gets the last ID.

  Returns number

nextId

• get nextId(): number

  Gets the next ID.

  Returns number

currentMeasurement

• get currentMeasurement(): Measurement

  Gets the current measurement.

  Returns Measurement

setMeasurementsExtruded

• setMeasurementsExtruded(value: boolean): Promise<void>

  Parameters

  • value: boolean

  Returns Promise<void>

setMeasurementsInsertKeyCallback

• setMeasurementsInsertKeyCallback(
      measurementsInsertKeyCallback: () => Promise<boolean>,
  ): () => Promise<boolean>

  Gets the measurements insert key event.

  Parameters

  • measurementsInsertKeyCallback: () => Promise<boolean>

  Returns () => Promise<boolean>

removeMeasurementsInsertKeyCallback

• removeMeasurementsInsertKeyCallback(): void

  Removes the measurements insert key callback.

  Returns void

dispatchMeasurementsSelected

• dispatchMeasurementsSelected(dispatchElementSelection?: boolean): void

  Dispatches the measurements selected event.

  Parameters

  • dispatchElementSelection: boolean = true

    Whether to dispatch the element selection event as well.

  Returns void

dispatchMeasurementsUpdated

• dispatchMeasurementsUpdated(): void

  Dispatches the measurements updated event.

  Returns void

dispatchMeasurementsUpdatedSync

• dispatchMeasurementsUpdatedSync(): Promise<void>

  Returns Promise<void>

dispatchMeasurementsDeleted

• dispatchMeasurementsDeleted(ms: { id: Int64; userObject: any }[]): void

  Dispatches the measurements updated event.

  Parameters

  • ms: { id: Int64; userObject: any }[]

  Returns void

dispatchMeasurementsPointPushBack

• dispatchMeasurementsPointPushBack(): void

  Dispatches the measurements point push back event.

  Returns void

getSnapModeEnabled

• getSnapModeEnabled(mode: SNAP_MODE): boolean

  Gets the snap mode enabled status.

  Parameters

  • mode: SNAP_MODE

    The snap mode.

  Returns boolean

setSnapModeEnabled

• setSnapModeEnabled(mode: SNAP_MODE, val: boolean): void

  Sets the snap mode enabled status.

  Parameters

  • mode: SNAP_MODE

    The snap mode.
  • val: boolean

    The enabled status.

  Returns void

startDrawingARC

• startDrawingARC(): boolean

  Starts drawing an arc.

  Returns boolean

isDrawingARC

• isDrawingARC(): boolean

  Returns boolean

clearDrawingARC

• clearDrawingARC(): void

  Clears the drawing arc mode.

  Returns void

isLastPointControlPoint

• isLastPointControlPoint(): Promise<boolean>

  Checks if the last point is a control point.

  Returns Promise<boolean>

canDrawARC

• canDrawARC(): Promise<boolean>

  Checks if an arc can be drawn.

  Returns Promise<boolean>

refreshDrawingARC

• refreshDrawingARC(): Promise<void>

  Refreshes the drawing arc mode.

  Returns Promise<void>

setLabelsVisible

• setLabelsVisible(visible: boolean): void

  Parameters

  • visible: boolean

  Returns void

initialize

• initialize(): Promise<void>

  Initializes the measurements state.

  Returns Promise<void>

destroy

• destroy(): Promise<void>

  Destroys the measurements state.

  Returns Promise<void>

clearGhostMeasurement

• clearGhostMeasurement(): Promise<void>

  Clears the ghost measurement.

  Returns Promise<void>

reflectGhostMeasurement

• reflectGhostMeasurement(fromMeasurement: Measurement): Promise<void>

  Reflects the ghost measurement from another measurement.

  Parameters

  • fromMeasurement: Measurement

    The measurement to reflect from.

  Returns Promise<void>

updateRenderer

• updateRenderer(): Promise<boolean>

  Updates the renderer.

  Returns Promise<boolean>

getMeasurementsBBox

• getMeasurementsBBox(measurementIds: Int64[]): Promise<BoundingBox3D>

  Gets the bounding box of measurements.

  Parameters

  • measurementIds: Int64[]

    The IDs of the measurements.

  Returns Promise<BoundingBox3D>

getGhostSegmentPointAtDistance

• getGhostSegmentPointAtDistance(distanceInMM: number): Promise<Vector3D>

  Gets the ghost segment point at a distance.

  Parameters

  • distanceInMM: number

    The distance in millimeters.

  Returns Promise<Vector3D>

fillGhostSegmentPoints

• fillGhostSegmentPoints(distanceInMM: number): Promise<Vector3D[]>

  Fills the ghost segment points at a distance.

  Parameters

  • distanceInMM: number

    The distance in millimeters.

  Returns Promise<Vector3D[]>

drawGhostSegmentExtensionAtDistance

• drawGhostSegmentExtensionAtDistance(distanceInMM: number): Promise<void>

  Draws the ghost segment extension at a distance.

  Parameters

  • distanceInMM: number

    The distance in millimeters.

  Returns Promise<void>

isOverPoint

• isOverPoint(m: Measurement, x: number, y: number): Promise<boolean>

  Checks if over a point.

  Parameters

  • m: Measurement

    The measurement.
  • x: number

    The X coordinate.
  • y: number

    The Y coordinate.

  Returns Promise<boolean>

isOverSegment

• isOverSegment(m: Measurement, x: number, y: number): Promise<boolean>

  Checks if over a segment.

  Parameters

  • m: Measurement

    The measurement.
  • x: number

    The X coordinate.
  • y: number

    The Y coordinate.

  Returns Promise<boolean>

isOverPlane

• isOverPlane(x: number, y: number): Promise<boolean>

  Checks if over a plane.

  Parameters

  • x: number

    The X coordinate.
  • y: number

    The Y coordinate.

  Returns Promise<boolean>

canEditPoint

• canEditPoint(): boolean

  Checks if a point can be edited.

  Returns boolean

setCommand

• setCommand(cmd: MEASUREMENT_COMMAND): void

  Sets the current command.

  Parameters

  • cmd: MEASUREMENT_COMMAND

    The command.

  Returns void

setHighlightedCommand

• setHighlightedCommand(cmd: MEASUREMENT_COMMAND): Promise<boolean>

  Sets the highlighted command.

  Parameters

  • cmd: MEASUREMENT_COMMAND

    The command.

  Returns Promise<boolean>

hasTaggedMeasurements

• hasTaggedMeasurements(): boolean

  Checks if there are tagged measurements.

  Returns boolean

hasMeasurements

• hasMeasurements(): boolean

  Checks if there are measurements.

  Returns boolean

addMeasurementDialog

• addMeasurementDialog(
      type?: TakeoffType,
      takeoffAdded: (takeoff: TakeoffBase) => void,
      disableOCRAndMeasure?: boolean,
      renderer?: BaseRenderer,
  ): Promise<void>

  Shows the Add Measurement dialog.

  Parameters

  • type: TakeoffType = TakeoffType.LINEAR_TAKEOFF
  • takeoffAdded: (takeoff: TakeoffBase) => void
  • OptionaldisableOCRAndMeasure: boolean
  • Optionalrenderer: BaseRenderer

  Returns Promise<void>

updateMeasurementDialog

• updateMeasurementDialog(
      takeoff: TakeoffBase,
      takeoffUpdated: (takeoff: TakeoffBase) => void,
      disableOCRAndMeasure?: boolean,
      renderer?: BaseRenderer,
  ): Promise<void>

  Parameters

  • takeoff: TakeoffBase
  • takeoffUpdated: (takeoff: TakeoffBase) => void
  • OptionaldisableOCRAndMeasure: boolean
  • Optionalrenderer: BaseRenderer

  Returns Promise<void>

appendMeasurementDialog

• appendMeasurementDialog(
      takeoff: TakeoffBase,
      takeoffUpdated: (takeoff: TakeoffBase) => void,
      disableOCRAndMeasure?: boolean,
      renderer?: BaseRenderer,
  ): Promise<void>

  Parameters

  • takeoff: TakeoffBase
  • takeoffUpdated: (takeoff: TakeoffBase) => void
  • OptionaldisableOCRAndMeasure: boolean
  • Optionalrenderer: BaseRenderer

  Returns Promise<void>

addOrUpdateMeasurementDialog

• addOrUpdateMeasurementDialog(
      takeoff: TakeoffBase,
      isEditDialog: boolean,
      takeoffAddedOrUpdated: (takeoff: TakeoffBase) => void,
      disableOCRAndMeasure?: boolean,
      renderer?: BaseRenderer,
  ): Promise<void>

  Parameters

  • takeoff: TakeoffBase
  • isEditDialog: boolean
  • takeoffAddedOrUpdated: (takeoff: TakeoffBase) => void
  • OptionaldisableOCRAndMeasure: boolean
  • Optionalrenderer: BaseRenderer

  Returns Promise<void>

addMeasurement

• addMeasurement(
      type: MEASUREMENT_TYPE,
      negative: boolean,
      color: RGB,
      pattern?: BIM_MEASUREMENT2D_FILL_PATTERN,
      options?: TakeoffBase | MeasurementsOptions,
  ): Promise<Measurement>

  Adds a measurement.

  Parameters

  • type: MEASUREMENT_TYPE

    The measurement type.
  • negative: boolean

    Whether the measurement is negative.
  • color: RGB

    The measurement color.
  • pattern: BIM_MEASUREMENT2D_FILL_PATTERN = BIM_MEASUREMENT2D_FILL_PATTERN.BM2DFP_NONE

    The fill pattern.
  • Optionaloptions: TakeoffBase | MeasurementsOptions

  Returns Promise<Measurement>

addMeasurementFromData

• addMeasurementFromData(
      data: MeasurementData,
      options?: TakeoffBase | MeasurementsOptions,
  ): Promise<Measurement>

  Adds a measurement from data.

  Parameters

  • data: MeasurementData

    The measurement data.
  • Optionaloptions: TakeoffBase | MeasurementsOptions

  Returns Promise<Measurement>

addTaggedMeasurementFromData

• addTaggedMeasurementFromData(
      data: MeasurementData,
      color: RGB,
      offset?: SceneOffset,
      options?: TakeoffBase | MeasurementsOptions,
  ): Promise<Measurement>

  Adds a tagged measurement from data.

  Parameters

  • data: MeasurementData

    The measurement data.
  • color: RGB

    The measurement color.
  • Optionaloffset: SceneOffset

    The scene offset.
  • Optionaloptions: TakeoffBase | MeasurementsOptions

  Returns Promise<Measurement>

addMeasurementFromMeasurement

• addMeasurementFromMeasurement(
      ms: Measurement,
      cloneGeometry: boolean,
      options?: TakeoffBase | MeasurementsOptions,
  ): Promise<Measurement>

  Adds a measurement from another measurement.

  Parameters

  • ms: Measurement

    The measurement to add from.
  • cloneGeometry: boolean

    Whether to clone the geometry.
  • Optionaloptions: TakeoffBase | MeasurementsOptions

  Returns Promise<Measurement>

clearAllTaggedMeasurements

• clearAllTaggedMeasurements(): Promise<void>

  Clears all tagged measurements.

  Returns Promise<void>

removeTaggedMeasurement

• removeTaggedMeasurement(measurementId: Int64): Promise<void>

  Removes a tagged measurement.

  Parameters

  • measurementId: Int64

    The measurement ID.

  Returns Promise<void>

size

• size(): number

  Gets the size of the measurement map.

  Returns number

getMeasurementById

• getMeasurementById(id: number | Int64): Measurement

  Gets a measurement by ID.

  Parameters

  • id: number | Int64

    The measurement ID.

  Returns Measurement

getMeasurementsById

• getMeasurementsById(IDS: Int64[]): Measurement[]

  Gets measurements by ID.

  Parameters

  • IDS: Int64[]

    The measurement IDs.

  Returns Measurement[]

setSelectedMeasurements

• setSelectedMeasurements(measurements: Measurement[]): Promise<void>

  Sets the selected measurements.

  Parameters

  • measurements: Measurement[]

    The measurements to select.

  Returns Promise<void>

clearSelectedMeasurements

• clearSelectedMeasurements(): Promise<boolean>

  Clears the selected measurements.

  Returns Promise<boolean>

clear

• clear(): Promise<void>

  Clears all measurements.

  Returns Promise<void>

clearCurrentMeasurement

• clearCurrentMeasurement(dispatchSelectionEvent?: boolean): Promise<void>

  Clears the current measurement.

  Parameters

  • dispatchSelectionEvent: boolean = true

  Returns Promise<void>

clearSelection

• clearSelection(): Promise<void>

  Clears the selection.

  Returns Promise<void>

setCurrentMeasurement

• setCurrentMeasurement(measurement: number | Int64 | Measurement): Promise<void>

  Sets the current measurement.

  Parameters

  • measurement: number | Int64 | Measurement

    The measurement to set.

  Returns Promise<void>

getMeasurementAt

• getMeasurementAt(x: number, y: number): Promise<Measurement>

  Gets a measurement at a specified position.

  Parameters

  • x: number

    The X coordinate.
  • y: number

    The Y coordinate.

  Returns Promise<Measurement>

getHighlightedMeasurement

• getHighlightedMeasurement(): Measurement

  Returns the currently highlighted measurement.

  Returns Measurement

  The currently highlighted Measurement object, or null if none exists.

getHighlightedMeasurements

• getHighlightedMeasurements(): Measurement[]

  Retrieves all highlighted measurements.

  Returns Measurement[]

  An array of Measurement objects that are currently highlighted.

getHighlightedMeasurementIds

• getHighlightedMeasurementIds(): Promise<Int64[]>

  Retrieves the IDs of all highlighted measurements.

  Returns Promise<Int64[]>

  A promise that resolves to an array of Int64 IDs for the highlighted measurements.

getNumMeasurements

• getNumMeasurements(): number

  Gets the total number of measurements.

  Returns number

getAllMeasurements

• getAllMeasurements(): Measurement[]

  Retrieves all measurements.

  Returns Measurement[]

getNegativeMeasurements

• getNegativeMeasurements(groupId?: any): Measurement[]

  Retrieves all negative measurements.

  Parameters

  • OptionalgroupId: any

    Optional group object to filter measurements.

  Returns Measurement[]

  An array of negative Measurement objects.

getPositiveMeasurements

• getPositiveMeasurements(groupId?: any): Measurement[]

  Retrieves all negative measurements.

  Parameters

  • OptionalgroupId: any

    Optional group object to filter measurements.

  Returns Measurement[]

  An array of negative Measurement objects.

getMeasurementsInRegion

• getMeasurementsInRegion(region: ClippingRegion): Promise<Measurement[]>

  Retrieves measurements in a specified region.

  Parameters

  • region: ClippingRegion

    The clipping region.

  Returns Promise<Measurement[]>

getTotalPoints

• getTotalPoints(measurements?: Measurement[]): number

  Gets the total number of points in measurements.

  Parameters

  • measurements: Measurement[] = null

    The measurements to calculate points from.

  Returns number

getTotalLengthMM

• getTotalLengthMM(measurements?: Measurement[]): Promise<number>

  Gets the total length of measurements in millimeters.

  Parameters

  • measurements: Measurement[] = null

    The measurements to calculate length from.

  Returns Promise<number>

getTotalAreaMM

• getTotalAreaMM(measurements?: Measurement[]): Promise<number>

  Gets the total area of measurements in square millimeters.

  Parameters

  • measurements: Measurement[] = null

    The measurements to calculate area from.

  Returns Promise<number>

highlightMeasurement

• highlightMeasurement(
      measurement: Measurement,
      cmd: MEASUREMENT_COMMAND,
      dispatchSelectEvent?: boolean,
  ): Promise<Measurement>

  Highlights a measurement.

  Parameters

  • measurement: Measurement

    The measurement to highlight.
  • cmd: MEASUREMENT_COMMAND

    The command associated with the highlight.
  • dispatchSelectEvent: boolean = false

    Whether to dispatch a selection event.

  Returns Promise<Measurement>

addHighlightedMeasurement

• addHighlightedMeasurement(measurement: Measurement): Promise<void>

  Adds a highlighted measurement.

  Parameters

  • measurement: Measurement

    The measurement to add.

  Returns Promise<void>

removeHighlightedMeasurement

• removeHighlightedMeasurement(measurement: Measurement): Promise<void>

  Removes a highlighted measurement.

  Parameters

  • measurement: Measurement

    The measurement to remove.

  Returns Promise<void>

moveMeasurements

• moveMeasurements(x: number, y: number): Promise<boolean>

  Moves measurements to a new position.

  Parameters

  • x: number

    The X coordinate.
  • y: number

    The Y coordinate.

  Returns Promise<boolean>

duplicateHighlightedMeasurements

• duplicateHighlightedMeasurements(cmd: MEASUREMENT_COMMAND): Promise<boolean>

  Duplicates highlighted measurements.

  Parameters

  • cmd: MEASUREMENT_COMMAND

    The command associated with the duplication.

  Returns Promise<boolean>

duplicateMeasurement

• duplicateMeasurement(x: number, y: number): Promise<boolean>

  Duplicates the highlighted measurement and moves it to a new position.

  Parameters

  • x: number

    The x-coordinate of the new position.
  • y: number

    The y-coordinate of the new position.

  Returns Promise<boolean>

  A promise that resolves to true if duplication was successful, false otherwise.

removeMeasurePoint

• removeMeasurePoint(x: number, y: number): Promise<boolean>

  Removes a measurement point at a specified position.

  Parameters

  • x: number

    The x-coordinate of the point to remove.
  • y: number

    The y-coordinate of the point to remove.

  Returns Promise<boolean>

  A promise that resolves to true if the point was removed successfully, false otherwise.

storeLastMovedSegment

• storeLastMovedSegment(): Promise<void>

  Returns Promise<void>

terminateMeasurement

• terminateMeasurement(
      closeIfLength: boolean,
      deleteIfNoPoints?: boolean,
      keepHighlight?: boolean,
  ): Promise<boolean>

  Terminates the measurement.

  Parameters

  • closeIfLength: boolean

    Whether to close the measurement if it has length.
  • deleteIfNoPoints: boolean = true

    Whether to delete the measurement if it has no points.
  • keepHighlight: boolean = false

    Whether to keep the measurement highlighted.

  Returns Promise<boolean>

insertMeasurePoint

• insertMeasurePoint(
      x: number,
      y: number,
      controlPoint?: boolean,
      dispatchEvent?: boolean,
  ): Promise<void>

  Inserts a measurement point.

  Parameters

  • x: number

    The X coordinate.
  • y: number

    The Y coordinate.
  • controlPoint: boolean = false

    Whether the point is a control point.
  • dispatchEvent: boolean = false

  Returns Promise<void>

moveMeasurePoint

• moveMeasurePoint(
      x: number,
      y: number,
      pointJustInserted?: boolean,
  ): Promise<boolean>

  Moves a measurement point.

  Parameters

  • x: number

    The X coordinate.
  • y: number

    The Y coordinate.
  • pointJustInserted: boolean = false

    Whether the point was just inserted.

  Returns Promise<boolean>

mirrorHighlightedMeasurements

• mirrorHighlightedMeasurements(
      mirrorX: boolean,
      mirrorY: boolean,
      cmd: MEASUREMENT_COMMAND,
  ): Promise<boolean>

  Mirrors highlighted measurements.

  Parameters

  • mirrorX: boolean

    Whether to mirror along the X axis.
  • mirrorY: boolean

    Whether to mirror along the Y axis.
  • cmd: MEASUREMENT_COMMAND

    The command associated with the mirror operation.

  Returns Promise<boolean>

mirrorMeasurements

• mirrorMeasurements(
      x: number,
      y: number,
      mirrorX: boolean,
      mirrorY: boolean,
  ): Promise<boolean>

  Mirrors measurements.

  Parameters

  • x: number

    The X coordinate.
  • y: number

    The Y coordinate.
  • mirrorX: boolean

    Whether to mirror along the X axis.
  • mirrorY: boolean

    Whether to mirror along the Y axis.

  Returns Promise<boolean>

rotateMeasurement

• rotateMeasurement(x: number, y: number, degrees: number): Promise<boolean>

  Rotates a measurement.

  Parameters

  • x: number

    The X coordinate.
  • y: number

    The Y coordinate.
  • degrees: number

    The degrees to rotate.

  Returns Promise<boolean>

rotateHighlightedMeasurements

• rotateHighlightedMeasurements(
      degrees: number,
      cmd: MEASUREMENT_COMMAND,
  ): Promise<boolean>

  Rotates highlighted measurements.

  Parameters

  • degrees: number

    The degrees to rotate.
  • cmd: MEASUREMENT_COMMAND

    The command associated with the rotation.

  Returns Promise<boolean>

deleteMeasurement

• deleteMeasurement(measurement: Measurement): Promise<void>

  Deletes a measurement.

  Parameters

  • measurement: Measurement

    The measurement to delete.

  Returns Promise<void>

deleteHighlightedMeasurements

• deleteHighlightedMeasurements(dispatchUpdate?: boolean): Promise<boolean>

  Deletes highlighted measurements.

  Parameters

  • dispatchUpdate: boolean = false

    Whether to dispatch an update event.

  Returns Promise<boolean>

isMeasuringOrStarting

• isMeasuringOrStarting(): boolean

  Checks if measuring or starting.

  Returns boolean

isMeasuring

• isMeasuring(): boolean

  Checks if measuring.

  Returns boolean

isMovingMeasurement

• isMovingMeasurement(): boolean

  Checks if moving a measurement.

  Returns boolean

isWaitingForCustomScale

• isWaitingForCustomScale(): boolean

  Checks if waiting for custom scale selection.

  Returns boolean

  True if waiting for custom scale selection (for example in two click scale), false otherwise.

getSnapDistance2D

• getSnapDistance2D(mode: SNAP_MODE): number

  Gets the snap distance in 2D.

  Parameters

  • mode: SNAP_MODE

    The snap mode.

  Returns number

findByDynRendererId

• findByDynRendererId(rendererId: Int64, x: number, y: number): Measurement

  Finds a measurement by dynamic renderer ID.

  Parameters

  • rendererId: Int64

    The renderer ID.
  • x: number

    The X coordinate.
  • y: number

    The Y coordinate.

  Returns Measurement

findByMousePosition

• findByMousePosition(
      x: number,
      y: number,
      highlightedOnly: boolean,
  ): Promise<Measurement>

  Finds a measurement by mouse position.

  Parameters

  • x: number

    The X coordinate.
  • y: number

    The Y coordinate.
  • highlightedOnly: boolean

    Whether to find only highlighted measurements.

  Returns Promise<Measurement>

getCuttingPlaneParameters

• getCuttingPlaneParameters(
      planeIndex: number,
      planePoint: number[],
      planeNormal: number[],
  ): Promise<boolean>

  Gets the cutting plane parameters.

  Parameters

  • planeIndex: number

    The plane index.
  • planePoint: number[]

    The plane point.
  • planeNormal: number[]

    The plane normal.

  Returns Promise<boolean>

saveState

• saveState(): Promise<string>

  Returns Promise<string>

restoreState

• restoreState(json: string, keepExisting?: boolean): Promise<void>

  Parameters

  • json: string
  • keepExisting: boolean = false

  Returns Promise<void>