Class MeasurementsState

Class representing the state of measurements.

Hierarchy

  • MeasurementsState

Constructors

constructor

Properties

pointToSnapX pointToSnapY pointToSnapZ snapAvailable snapPointShowing

Accessors

aggregationMode commandChangedEvent currentCommand currentMeasurement ghostPointVisible isMovementByDuplicate lastId lastMovedPivotPoint lastMovingPoint lastSegmentPoints lastX lastY measureSystem measurementsPointPushBackEvent measurementsSelectedEvent measurementsUpdatedEvent measuring nextId pointJustInserted previousCommand

Methods

addHighlightedMeasurement addMeasurement addMeasurementFromData addMeasurementFromMeasurement addTaggedMeasurementFromData canDrawARC canEditPoint clear clearAllTaggedMeasurements clearCurrentMeasurement clearDrawingARC clearGhostMeasurement clearSelectedMeasurements clearSelection deleteHighlightedMeasurements deleteMeasurement destroy dispatchMeasurementsPointPushBack dispatchMeasurementsSelected dispatchMeasurementsUpdated drawGhostSegmentExtensionAtDistance duplicateHighlightedMeasurements duplicateMeasurement fillGhostSegmentPoints findByDynRendererId findByMousePosition getAllMeasurements getCuttingPlaneParameters getDynamicElementIds getGhostSegmentPointAtDistance getHighlightedMeasurement getHighlightedMeasurementIds getHighlightedMeasurements getMeasurementAt getMeasurementById getMeasurementsBBox getMeasurementsById getMeasurementsInRegion getNumMeasurements getSnapDistance2D getSnapModeEnabled getTotalAreaMM getTotalLengthMM getTotalPoints hasMeasurements hasTaggedMeasurements highlightMeasurement initialize insertMeasurePoint isDrawingARC isLastPointControlPoint isMeasuring isMeasuringOrStarting isMovingMeasurement isOverPlane isOverPoint isOverSegment mirrorHighlightedMeasurements mirrorMeasurements moveMeasurePoint moveMeasurements reflectGhostMeasurement refreshDrawingARC removeHighlightedMeasurement removeMeasurePoint removeTaggedMeasurement rotateHighlightedMeasurements rotateMeasurement setCommand setCurrentMeasurement setHighlightedCommand setSelectedMeasurements setSnapModeEnabled size startDrawingARC storeLastMovedSegment terminateMeasurement updateRenderer

Constructors

constructor

Properties

pointToSnapX

pointToSnapX: number = -1

pointToSnapY

pointToSnapY: number = -1

pointToSnapZ

pointToSnapZ: number = -1

snapAvailable

snapAvailable: boolean = false

snapPointShowing

snapPointShowing: boolean = false

Accessors

aggregationMode

  • get aggregationMode(): AGGREGATION_MODE

  • Gets the aggregation mode.

    Returns AGGREGATION_MODE

  • set aggregationMode(aggregationMode: AGGREGATION_MODE): void

  • Sets the aggregation mode.

    Parameters

    Returns void

commandChangedEvent

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

  • Gets the command changed event.

    Returns IEvent<MEASUREMENT_COMMAND, MEASUREMENT_COMMAND>

currentCommand

  • get currentCommand(): MEASUREMENT_COMMAND

  • Gets the current command.

    Returns MEASUREMENT_COMMAND

currentMeasurement

  • get currentMeasurement(): Measurement

  • Gets the current measurement.

    Returns Measurement

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

isMovementByDuplicate

  • get isMovementByDuplicate(): boolean

  • Gets the movement by duplicate status.

    Returns boolean

lastId

  • get lastId(): number

  • Gets the last ID.

    Returns number

lastMovedPivotPoint

  • get lastMovedPivotPoint(): Vector3D

  • Gets the last moved pivot point.

    Returns Vector3D

  • set lastMovedPivotPoint(pivotPoint: Vector3D): void

  • Sets the last moved pivot point.

    Parameters

    Returns void

lastMovingPoint

  • get lastMovingPoint(): Vector3D

  • Gets the last moving point.

    Returns Vector3D

  • set lastMovingPoint(movePoint: Vector3D): void

  • Sets the last moving point.

    Parameters

    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

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

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

measurementsPointPushBackEvent

measurementsSelectedEvent

measurementsUpdatedEvent

measuring

  • get measuring(): boolean

  • Checks if measuring is in progress.

    Returns boolean

nextId

  • get nextId(): number

  • Gets the next ID.

    Returns number

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

previousCommand

  • get previousCommand(): MEASUREMENT_COMMAND

  • Gets the previous command.

    Returns MEASUREMENT_COMMAND

Methods

addHighlightedMeasurement

  • Adds a highlighted measurement.

    Parameters

    Returns Promise<void>

addMeasurement

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

    Returns Promise<Measurement>

addMeasurementFromData

addMeasurementFromMeasurement

  • Adds a measurement from another measurement.

    Parameters

    • ms: Measurement

      The measurement to add from.

    • cloneGeometry: boolean

      Whether to clone the geometry.

    Returns Promise<Measurement>

addTaggedMeasurementFromData

canDrawARC

  • Checks if an arc can be drawn.

    Returns Promise<boolean>

canEditPoint

  • Checks if a point can be edited.

    Returns boolean

clear

  • Clears all measurements.

    Returns Promise<void>

clearAllTaggedMeasurements

  • Clears all tagged measurements.

    Returns Promise<void>

clearCurrentMeasurement

  • Clears the current measurement.

    Returns Promise<void>

clearDrawingARC

  • Clears the drawing arc mode.

    Returns void

clearGhostMeasurement

  • Clears the ghost measurement.

    Returns Promise<void>

clearSelectedMeasurements

  • Clears the selected measurements.

    Returns Promise<void>

clearSelection

  • Clears the selection.

    Returns Promise<void>

deleteHighlightedMeasurements

  • Deletes highlighted measurements.

    Parameters

    • dispatchUpdate: boolean = false

      Whether to dispatch an update event.

    Returns Promise<boolean>

deleteMeasurement

  • Deletes a measurement.

    Parameters

    Returns Promise<void>

destroy

  • Destroys the measurements state.

    Returns Promise<void>

dispatchMeasurementsPointPushBack

  • Dispatches the measurements point push back event.

    Returns void

dispatchMeasurementsSelected

  • Dispatches the measurements selected event.

    Returns void

dispatchMeasurementsUpdated

  • Dispatches the measurements updated event.

    Returns void

drawGhostSegmentExtensionAtDistance

  • Draws the ghost segment extension at a distance.

    Parameters

    • distanceInMM: number

      The distance in millimeters.

    Returns Promise<void>

duplicateHighlightedMeasurements

  • Duplicates highlighted measurements.

    Parameters

    • cmd: MEASUREMENT_COMMAND

      The command associated with the duplication.

    Returns Promise<boolean>

duplicateMeasurement

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

    Returns

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

    Parameters

    • x: number

      The x-coordinate of the new position.

    • y: number

      The y-coordinate of the new position.

    Returns Promise<boolean>

fillGhostSegmentPoints

  • Fills the ghost segment points at a distance.

    Parameters

    • distanceInMM: number

      The distance in millimeters.

    Returns Promise<Vector3D[]>

findByDynRendererId

  • Finds a measurement by dynamic renderer ID.

    Parameters

    • rendererId: Int64

      The renderer ID.

    • x: number

      The X coordinate.

    • y: number

      The Y coordinate.

    Returns Promise<Measurement>

findByMousePosition

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

    • excludeDynamicElementsIn2D: boolean

      Whether to exclude dynamic elements in 2D.

    Returns Promise<Measurement>

getAllMeasurements

  • Retrieves all measurements.

    Returns Measurement[]

getCuttingPlaneParameters

  • Gets the cutting plane parameters.

    Parameters

    • planeIndex: number

      The plane index.

    • planePoint: number[]

      The plane point.

    • planeNormal: number[]

      The plane normal.

    Returns Promise<boolean>

getDynamicElementIds

  • Gets the dynamic element IDs.

    Returns Int64[]

getGhostSegmentPointAtDistance

  • Gets the ghost segment point at a distance.

    Parameters

    • distanceInMM: number

      The distance in millimeters.

    Returns Promise<Vector3D>

getHighlightedMeasurement

  • Returns the currently highlighted measurement.

    Returns

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

    Returns Measurement

getHighlightedMeasurementIds

  • Retrieves the IDs of all highlighted measurements.

    Returns

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

    Returns Promise<Int64[]>

getHighlightedMeasurements

  • Retrieves all highlighted measurements.

    Returns

    An array of Measurement objects that are currently highlighted.

    Returns Measurement[]

getMeasurementAt

  • Gets a measurement at a specified position.

    Parameters

    • x: number

      The X coordinate.

    • y: number

      The Y coordinate.

    Returns Promise<Measurement>

getMeasurementById

  • Gets a measurement by ID.

    Parameters

    • id: number | Int64

      The measurement ID.

    Returns Measurement

getMeasurementsBBox

  • Gets the bounding box of measurements.

    Parameters

    • measurementIds: Int64[]

      The IDs of the measurements.

    Returns Promise<BoundingBox3D>

getMeasurementsById

  • Gets measurements by ID.

    Parameters

    • IDS: Int64[]

      The measurement IDs.

    Returns Measurement[]

getMeasurementsInRegion

  • Retrieves measurements in a specified region.

    Parameters

    Returns Promise<Measurement[]>

getNumMeasurements

  • Gets the total number of measurements.

    Returns number

getSnapDistance2D

  • Gets the snap distance in 2D.

    Parameters

    Returns number

getSnapModeEnabled

  • Gets the snap mode enabled status.

    Parameters

    Returns boolean

getTotalAreaMM

  • Gets the total area of measurements in square millimeters.

    Parameters

    • measurements: Measurement[] = null

      The measurements to calculate area from.

    Returns Promise<number>

getTotalLengthMM

  • Gets the total length of measurements in millimeters.

    Parameters

    • measurements: Measurement[] = null

      The measurements to calculate length from.

    Returns Promise<number>

getTotalPoints

  • Gets the total number of points in measurements.

    Parameters

    • measurements: Measurement[] = null

      The measurements to calculate points from.

    Returns number

hasMeasurements

  • Checks if there are measurements.

    Returns boolean

hasTaggedMeasurements

  • Checks if there are tagged measurements.

    Returns boolean

highlightMeasurement

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

initialize

  • Initializes the measurements state.

    Returns Promise<void>

insertMeasurePoint

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

    Returns Promise<void>

isDrawingARC

  • Checks if drawing an arc.

    Returns boolean

isLastPointControlPoint

  • Checks if the last point is a control point.

    Returns Promise<boolean>

isMeasuring

  • Checks if measuring.

    Returns boolean

isMeasuringOrStarting

  • Checks if measuring or starting.

    Returns boolean

isMovingMeasurement

  • Checks if moving a measurement.

    Returns boolean

isOverPlane

  • Checks if over a plane.

    Parameters

    • x: number

      The X coordinate.

    • y: number

      The Y coordinate.

    Returns Promise<boolean>

isOverPoint

  • Checks if over a point.

    Parameters

    • m: Measurement

      The measurement.

    • x: number

      The X coordinate.

    • y: number

      The Y coordinate.

    Returns Promise<boolean>

isOverSegment

  • Checks if over a segment.

    Parameters

    • m: Measurement

      The measurement.

    • x: number

      The X coordinate.

    • y: number

      The Y coordinate.

    Returns Promise<boolean>

mirrorHighlightedMeasurements

  • 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

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

moveMeasurePoint

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

moveMeasurements

  • Moves measurements to a new position.

    Parameters

    • x: number

      The X coordinate.

    • y: number

      The Y coordinate.

    Returns Promise<boolean>

reflectGhostMeasurement

  • Reflects the ghost measurement from another measurement.

    Parameters

    • fromMeasurement: Measurement

      The measurement to reflect from.

    Returns Promise<void>

refreshDrawingARC

  • Refreshes the drawing arc mode.

    Returns Promise<void>

removeHighlightedMeasurement

  • Removes a highlighted measurement.

    Parameters

    Returns Promise<void>

removeMeasurePoint

  • Removes a measurement point at a specified position.

    Returns

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

    Parameters

    • x: number

      The x-coordinate of the point to remove.

    • y: number

      The y-coordinate of the point to remove.

    Returns Promise<boolean>

removeTaggedMeasurement

  • Removes a tagged measurement.

    Parameters

    • measurementId: Int64

      The measurement ID.

    Returns Promise<void>

rotateHighlightedMeasurements

  • Rotates highlighted measurements.

    Parameters

    • degrees: number

      The degrees to rotate.

    • cmd: MEASUREMENT_COMMAND

      The command associated with the rotation.

    Returns Promise<boolean>

rotateMeasurement

  • Rotates a measurement.

    Parameters

    • x: number

      The X coordinate.

    • y: number

      The Y coordinate.

    • degrees: number

      The degrees to rotate.

    Returns Promise<boolean>

setCommand

  • Sets the current command.

    Parameters

    • cmd: MEASUREMENT_COMMAND

      The command.

    Returns void

setCurrentMeasurement

  • Sets the current measurement.

    Parameters

    Returns Promise<void>

setHighlightedCommand

  • Sets the highlighted command.

    Parameters

    • cmd: MEASUREMENT_COMMAND

      The command.

    Returns Promise<boolean>

setSelectedMeasurements

  • Sets the selected measurements.

    Parameters

    • measurements: Measurement[]

      The measurements to select.

    Returns Promise<void>

setSnapModeEnabled

  • Sets the snap mode enabled status.

    Parameters

    • mode: SNAP_MODE

      The snap mode.

    • val: boolean

      The enabled status.

    Returns void

size

  • Gets the size of the measurement map.

    Returns number

startDrawingARC

  • Starts drawing an arc.

    Returns boolean

storeLastMovedSegment

  • Returns Promise<void>

terminateMeasurement

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

updateRenderer

  • Updates the renderer.

    Returns Promise<boolean>

Settings

Member Visibility

Theme