Class Measurement

Represents a measurement with various settings and properties.

Hierarchy

Measurement

Index

Accessors

color elementId highlighted id negative pattern pointColor pointIds type

Methods

addArcPoint3D addLastLengthOverride addPoint3D clearArcPoint3D clearLabels close computePerpendicularPointsOnLine computePerpendicularPointsOnLineExcludePoint containsPoint deleteCurrentPoint deletePoint destroy findElementIdInFaces findOrUpdateNormalBehind getArcPoint3D getBoundingBox getClosestSegmentPointLength getCurrentPoint getCurrentPointId getCurrentSegmentPoints getData getFirstPoint getIsometricLengths getLastLineImageDimensions getLastPoint getNumPoints getPixelCenter getPreviousPointOf getRectangle getTotalArea getTotalAreaMM getTotalLength getTotalLengthMM hasLengthOverrides insertPoint isClosedMeasurement isOverPoint isOverSegment isPointAcceptedForAddition moveCurrentPoint moveCurrentPoint3D moveCurrentSegment moveCurrentSegmentPoints moveToOffset pointFaceId reconstructLabels removeLastPoint setClosedMeasurement setColor setCurrentPoint setCurrentPointToFirstPoint setDrawOrder setHighlighted setIsometricLengths setSegmentPointLength terminateArcPoint3D updateLabels createMeasurement

Accessors

color

get color(): RGB
Gets the color of the measurement.

Returns
The color of the measurement.

Returns RGB
- Defined in measurements/measurement.ts:173

elementId

get elementId(): Int64
Gets the element ID associated with the measurement.

Returns
The element ID associated with the measurement.

Returns Int64
- Defined in measurements/measurement.ts:237
set elementId(elementId: Int64): void
Sets the element ID associated with the measurement.
Parameters
- elementId: Int64
  
  The element ID to set.
Returns void
- Defined in measurements/measurement.ts:245

highlighted

get highlighted(): boolean
Gets whether the measurement is highlighted.

Returns
Whether the measurement is highlighted.

Returns boolean
- Defined in measurements/measurement.ts:213

id

get id(): Int64
Gets the unique identifier of the measurement.

Returns
The unique identifier of the measurement.

Returns Int64
- Defined in measurements/measurement.ts:165

negative

get negative(): boolean
Gets whether the measurement is negative.

Returns
Whether the measurement is negative.

Returns boolean
- Defined in measurements/measurement.ts:221
set negative(negative: boolean): void
Sets whether the measurement is negative.
Parameters
- negative: boolean
  
  Whether the measurement is negative.
Returns void
- Defined in measurements/measurement.ts:229

pattern

get pattern(): BIM_MEASUREMENT2D_FILL_PATTERN
Gets the pattern of the measurement.

Returns
The pattern of the measurement.

Returns BIM_MEASUREMENT2D_FILL_PATTERN
- Defined in measurements/measurement.ts:189

pointColor

get pointColor(): RGB
Gets the point color of the measurement.

Returns
The point color of the measurement.

Returns RGB
- Defined in measurements/measurement.ts:181

pointIds

get pointIds(): number[]
Gets the point IDs of the measurement.

Returns
The point IDs of the measurement.

Returns number[]
- Defined in measurements/measurement.ts:197

type

get type(): MEASUREMENT_TYPE
Gets the type of the measurement.

Returns
The type of the measurement.

Returns MEASUREMENT_TYPE
- Defined in measurements/measurement.ts:205

Methods

addArcPoint3D

addArcPoint3D(x: number, y: number, z: number, useElevation: boolean, faceId?: Int64): Promise<boolean>
Adds a 3D arc point to the measurement.

Returns
A promise that resolves to a boolean indicating success or failure.
Parameters
- x: number
  
  The x-coordinate of the arc point.
- y: number
  
  The y-coordinate of the arc point.
- z: number
  
  The z-coordinate of the arc point.
- useElevation: boolean
  
  Whether to use elevation for the arc point.
- faceId: Int64 = null
  
  Optional face ID associated with the arc point.
Returns Promise<boolean>
- Defined in measurements/measurement.ts:609

addLastLengthOverride

addLastLengthOverride(length: number): void
Adds a length override for the last point in the measurement.
Parameters
- length: number
  
  The length to override.
Returns void
- Defined in measurements/measurement.ts:678

addPoint3D

addPoint3D(x: number, y: number, z: number, useElevation: boolean, faceId?: Int64, is_control?: boolean): Promise<number>
Adds a 3D point to the measurement.

Returns
A promise that resolves to the segment ID of the added point.
Parameters
- x: number
  
  The x-coordinate of the point.
- y: number
  
  The y-coordinate of the point.
- z: number
  
  The z-coordinate of the point.
- useElevation: boolean
  
  Whether to use elevation for the point.
- faceId: Int64 = null
  
  Optional face ID associated with the point.
- is_control: boolean = false
  
  Whether the point is a control point.
Returns Promise<number>
- Defined in measurements/measurement.ts:651

clearArcPoint3D

clearArcPoint3D(): void
Clears the 3D coordinates of the arc point.

Returns void
- Defined in measurements/measurement.ts:594

clearLabels

clearLabels(): void
Clears the labels of the measurement.

Returns void
- Defined in measurements/measurement.ts:344

close

close(closeIfLength: boolean): Promise<false | BR_FunctionOutput>
Closes the measurement.

Returns
A promise that resolves to a boolean indicating success or failure.
Parameters
- closeIfLength: boolean
  
  Whether to close if length is present.
Returns Promise<false | BR_FunctionOutput>
- Defined in measurements/measurement.ts:333

computePerpendicularPointsOnLine

computePerpendicularPointsOnLine(lineData: number[], skipCurrentPoint: boolean): Promise<Vector3D[]>
Computes the perpendicular points on a line.

Returns
A promise that resolves to an array of perpendicular points.
Parameters
- lineData: number[]
  
  The line data.
- skipCurrentPoint: boolean
  
  Whether to skip the current point.
Returns Promise<Vector3D[]>
- Defined in measurements/measurement.ts:1289

computePerpendicularPointsOnLineExcludePoint

computePerpendicularPointsOnLineExcludePoint(lineData: number[], pointToExclude: number, skipCurrentPoint: boolean): Promise<Vector3D[]>
Computes the perpendicular points on a line, excluding a specified point.

Returns
A promise that resolves to an array of perpendicular points.
Parameters
- lineData: number[]
  
  The line data.
- pointToExclude: number
  
  The point to exclude.
- skipCurrentPoint: boolean
  
  Whether to skip the current point.
Returns Promise<Vector3D[]>
- Defined in measurements/measurement.ts:1237

containsPoint

containsPoint(xe: number, ye: number, ze: number): Promise<number>
Checks if the measurement contains a point with the specified coordinates.

Returns
A promise that resolves to the point ID if the point is found, or -1 if not found.
Parameters
- xe: number
  
  The x-coordinate of the point.
- ye: number
  
  The y-coordinate of the point.
- ze: number
  
  The z-coordinate of the point.
Returns Promise<number>
- Defined in measurements/measurement.ts:1617

deleteCurrentPoint

deleteCurrentPoint(): Promise<boolean>
Deletes the current point in the measurement.

Returns
A promise that resolves to a boolean indicating success or failure.

Returns Promise<boolean>
- Defined in measurements/measurement.ts:899

deletePoint

deletePoint(screenX: number, screenY: number): Promise<boolean>
Deletes a point in the measurement at the given screen coordinates.

Returns
A promise that resolves to a boolean indicating success or failure.
Parameters
- screenX: number
  
  The x-coordinate of the screen.
- screenY: number
  
  The y-coordinate of the screen.
Returns Promise<boolean>
- Defined in measurements/measurement.ts:939

destroy

destroy(): Promise<void>
Destroys the measurement.

Returns Promise<void>
- Defined in measurements/measurement.ts:979

findElementIdInFaces

findElementIdInFaces(): Promise<Int64>
Finds the element ID in faces.

Returns
A promise that resolves to the element ID in faces.

Returns Promise<Int64>
- Defined in measurements/measurement.ts:304

findOrUpdateNormalBehind

findOrUpdateNormalBehind(doUpdate?: boolean): Promise<Vector3D>
Finds or updates the normal vector behind the measurement.

Returns
A promise that resolves to the normal vector.
Parameters
- doUpdate: boolean = true
  
  Optional flag to force the update.
Returns Promise<Vector3D>
- Defined in measurements/measurement.ts:1715

getArcPoint3D

getArcPoint3D(): Vector3D
Gets the 3D coordinates of the arc point.

Returns
The 3D coordinates of the arc point.

Returns Vector3D
- Defined in measurements/measurement.ts:587

getBoundingBox

getBoundingBox(): Promise<BoundingBox3D>
Gets the bounding box of the measurement.

Returns
A promise that resolves to the bounding box of the measurement.

Returns Promise<BoundingBox3D>
- Defined in measurements/measurement.ts:1758

getClosestSegmentPointLength

getClosestSegmentPointLength(x: number, y: number): Promise<{ length: number; pointId: number }>
Gets the length of the closest segment point to the given coordinates.

Returns
A promise that resolves to an object containing the point ID and length of the closest segment point.
Parameters
- x: number
  
  The x-coordinate.
- y: number
  
  The y-coordinate.
Returns Promise<{ length: number; pointId: number }>
- Defined in measurements/measurement.ts:754

getCurrentPoint

getCurrentPoint(): Promise<Vector3D>
Gets the current point in the measurement.

Returns
A promise that resolves to the current point in the measurement.

Returns Promise<Vector3D>
- Defined in measurements/measurement.ts:1141

getCurrentPointId

getCurrentPointId(): number
Gets the current point ID in the measurement.

Returns
The current point ID in the measurement.

Returns number
- Defined in measurements/measurement.ts:1133

getCurrentSegmentPoints

getCurrentSegmentPoints(): Promise<Vector3D[]>
Gets the points of the current segment in the measurement.

Returns
A promise that resolves to an array of points in the current segment.

Returns Promise<Vector3D[]>
- Defined in measurements/measurement.ts:1158

getData

getData(): Promise<string>
Gets the data of the measurement.

Returns
A promise that resolves to the data of the measurement.

Returns Promise<string>
- Defined in measurements/measurement.ts:1823

getFirstPoint

getFirstPoint(): number
Gets the first point ID in the measurement.

Returns
The first point ID in the measurement.

Returns number
- Defined in measurements/measurement.ts:528

getIsometricLengths

getIsometricLengths(): number[]
Gets the isometric lengths of the measurement.

Returns
The isometric lengths of the measurement.

Returns number[]
- Defined in measurements/measurement.ts:253

getLastLineImageDimensions

getLastLineImageDimensions(): Promise<{ x1: number; x2: number; y1: number; y2: number }>
Gets the dimensions of the last line image in the measurement.

Returns
A promise that resolves to an object containing the dimensions of the last line image.

Returns Promise<{ x1: number; x2: number; y1: number; y2: number }>
- Defined in measurements/measurement.ts:702

getLastPoint

getLastPoint(): number
Gets the last point ID in the measurement.

Returns
The last point ID in the measurement.

Returns number
- Defined in measurements/measurement.ts:540

getNumPoints

getNumPoints(): number
Gets the number of points in the measurement.

Returns
The number of points in the measurement.

Returns number
- Defined in measurements/measurement.ts:516

getPixelCenter

getPixelCenter(): Promise<Point2D>
Gets the pixel center of the measurement.

Returns
A promise that resolves to the pixel center of the measurement.

Returns Promise<Point2D>
- Defined in measurements/measurement.ts:1662

getPreviousPointOf

getPreviousPointOf(point_id: number): Promise<number>
Gets the previous point ID of a given point ID.

Returns
A promise that resolves to the previous point ID.
Parameters
- point_id: number
  
  The point ID to find the previous point for.
Returns Promise<number>
- Defined in measurements/measurement.ts:553

getRectangle

getRectangle(): Promise<Rectangle>
Gets the rectangle of the measurement.

Returns
A promise that resolves to the rectangle of the measurement.

Returns Promise<Rectangle>
- Defined in measurements/measurement.ts:1802

getTotalArea

getTotalArea(): Promise<number>
Gets the total area of the measurement in square meters.

Returns
A promise that resolves to the total area in square meters.

Returns Promise<number>
- Defined in measurements/measurement.ts:1393

getTotalAreaMM

getTotalAreaMM(extraPoint?: Vector3D): Promise<number>
Gets the total area of the measurement in square millimeters.

Returns
A promise that resolves to the total area in square millimeters.
Parameters
- extraPoint: Vector3D = null
  
  Optional extra point to include in the calculation.
Returns Promise<number>
- Defined in measurements/measurement.ts:1403

getTotalLength

getTotalLength(): Promise<number>
Gets the total length of the measurement in meters.

Returns
A promise that resolves to the total length in meters.

Returns Promise<number>
- Defined in measurements/measurement.ts:1443

getTotalLengthMM

getTotalLengthMM(extraPoint?: Vector3D): Promise<number>
Gets the total length of the measurement in millimeters.

Returns
A promise that resolves to the total length in millimeters.
Parameters
- extraPoint: Vector3D = null
  
  Optional extra point to include in the calculation.
Returns Promise<number>
- Defined in measurements/measurement.ts:1452

hasLengthOverrides

hasLengthOverrides(): boolean
Isometric Lengtgs contain Lenght Overrides

Returns
true if an isometric style measurement

Returns boolean
- Defined in measurements/measurement.ts:695

insertPoint

insertPoint(x: number, y: number, faceId?: Int64, is_control?: boolean): Promise<void>
Inserts a point into the measurement at the given coordinates.
Parameters
- x: number
  
  The x-coordinate of the point.
- y: number
  
  The y-coordinate of the point.
- faceId: Int64 = null
  
  Optional face ID associated with the point.
- is_control: boolean = false
  
  Whether the point is a control point.
Returns Promise<void>
- Defined in measurements/measurement.ts:807

isClosedMeasurement

isClosedMeasurement(): boolean
Checks if the measurement is closed.

Returns
Whether the measurement is closed.

Returns boolean
- Defined in measurements/measurement.ts:316

isOverPoint

isOverPoint(screenX: number, screenY: number): Promise<boolean>
Checks if the specified screen coordinates are over a point in the measurement.

Returns
A promise that resolves to a boolean indicating whether the coordinates are over a point.
Parameters
- screenX: number
  
  The x-coordinate of the screen.
- screenY: number
  
  The y-coordinate of the screen.
Returns Promise<boolean>
- Defined in measurements/measurement.ts:1192

isOverSegment

isOverSegment(screenX: number, screenY: number): Promise<boolean>
Checks if the specified screen coordinates are over a segment in the measurement.

Returns
A promise that resolves to a boolean indicating whether the coordinates are over a segment.
Parameters
- screenX: number
  
  The x-coordinate of the screen.
- screenY: number
  
  The y-coordinate of the screen.
Returns Promise<boolean>
- Defined in measurements/measurement.ts:1203

isPointAcceptedForAddition

isPointAcceptedForAddition(cur_point_id: number): Promise<boolean>
Checks if a point is accepted for addition to the measurement.

Returns
A promise that resolves to a boolean indicating whether the point is accepted for addition.
Parameters
- cur_point_id: number
  
  The current point ID.
Returns Promise<boolean>
- Defined in measurements/measurement.ts:1635

moveCurrentPoint

moveCurrentPoint(screenX: number, screenY: number, degreeSnapping?: boolean): Promise<void>
Moves the current point in the measurement to the specified screen coordinates.
Parameters
- screenX: number
  
  The x-coordinate of the screen.
- screenY: number
  
  The y-coordinate of the screen.
- Optional degreeSnapping: boolean
  
  Optional degree snapping flag.
Returns Promise<void>
- Defined in measurements/measurement.ts:1033

moveCurrentPoint3D

moveCurrentPoint3D(x: number, y: number, z: number): Promise<boolean>
Moves the current point in the measurement to the specified 3D coordinates.

Returns
A promise that resolves to a boolean indicating success or failure.
Parameters
- x: number
  
  The x-coordinate to move the point to.
- y: number
  
  The y-coordinate to move the point to.
- z: number
  
  The z-coordinate to move the point to.
Returns Promise<boolean>
- Defined in measurements/measurement.ts:1019

moveCurrentSegment

moveCurrentSegment(x: number, y: number): Promise<boolean>
Moves the current segment in the measurement to the specified coordinates.

Returns
A promise that resolves to a boolean indicating success or failure.
Parameters
- x: number
  
  The x-coordinate to move the segment to.
- y: number
  
  The y-coordinate to move the segment to.
Returns Promise<boolean>
- Defined in measurements/measurement.ts:1067

moveCurrentSegmentPoints

moveCurrentSegmentPoints(p1: Vector3D, p2: Vector3D): Promise<boolean>
Moves the points of the current segment in the measurement to the specified coordinates.

Returns
A promise that resolves to a boolean indicating success or failure.
Parameters
- p1: Vector3D
  
  The first point to move.
- p2: Vector3D
  
  The second point to move.
Returns Promise<boolean>
- Defined in measurements/measurement.ts:1214

moveToOffset

moveToOffset(offset: SceneOffset): Promise<void>
Moves the measurement to the specified offset.
Parameters
- offset: SceneOffset
  
  The offset to move the measurement to.
Returns Promise<void>
- Defined in measurements/measurement.ts:997

pointFaceId

pointFaceId(pointId: number): Int64
Gets the face ID associated with a point in the measurement.

Returns
The face ID associated with the point.
Parameters
- pointId: number
  
  The point ID.
Returns Int64
- Defined in measurements/measurement.ts:1703

reconstructLabels

reconstructLabels(): Promise<void>
Reconstructs the labels of the measurement.

Returns Promise<void>
- Defined in measurements/measurement.ts:359

removeLastPoint

removeLastPoint(): Promise<void>
Removes the last point from the measurement.

Returns Promise<void>
- Defined in measurements/measurement.ts:832

setClosedMeasurement

setClosedMeasurement(closed: boolean): void
Sets whether the measurement is closed.
Parameters
- closed: boolean
  
  Whether the measurement is closed.
Returns void
- Defined in measurements/measurement.ts:324

setColor

setColor(color: RGB, pointColor?: RGB): Promise<void>
Sets the color of the measurement.
Parameters
- color: RGB
  
  The color to set.
- Optional pointColor: RGB
  
  Optional point color to set.
Returns Promise<void>
- Defined in measurements/measurement.ts:144

setCurrentPoint

setCurrentPoint(screenX: number, screenY: number): Promise<boolean>
Sets the current point in the measurement to the point at the specified screen coordinates.

Returns
A promise that resolves to a boolean indicating success or failure.
Parameters
- screenX: number
  
  The x-coordinate of the screen.
- screenY: number
  
  The y-coordinate of the screen.
Returns Promise<boolean>
- Defined in measurements/measurement.ts:1098

setCurrentPointToFirstPoint

setCurrentPointToFirstPoint(): Promise<boolean>
Sets the current point in the measurement to the first point.

Returns
A promise that resolves to a boolean indicating success or failure.

Returns Promise<boolean>
- Defined in measurements/measurement.ts:1111

setDrawOrder

setDrawOrder(order: number): Promise<void>
Sets the draw order of the measurement.
Parameters
- order: number
  
  The draw order to set.
Returns Promise<void>
- Defined in measurements/measurement.ts:157

setHighlighted

setHighlighted(highlighted: boolean, force?: boolean): Promise<void>
Sets whether the measurement is highlighted.
Parameters
- highlighted: boolean
  
  Whether the measurement is highlighted.
- force: boolean = false
  
  Optional flag to force the update.
Returns Promise<void>
- Defined in measurements/measurement.ts:1329

setIsometricLengths

setIsometricLengths(lengths: number[]): Promise<void>
Sets the isometric lengths of the measurement.
Parameters
- lengths: number[]
  
  The isometric lengths to set.
Returns Promise<void>
- Defined in measurements/measurement.ts:272

setSegmentPointLength

setSegmentPointLength(pointId: number, length: number): void
Sets the length of a segment point in the measurement.
Parameters
- pointId: number
  
  The point ID of the segment point.
- length: number
  
  The length to set.
Returns void
- Defined in measurements/measurement.ts:687

terminateArcPoint3D

terminateArcPoint3D(): Promise<void>
Terminates the 3D arc point.

Returns Promise<void>
- Defined in measurements/measurement.ts:627

updateLabels

updateLabels(): Promise<boolean>
Updates the labels of the measurement.

Returns Promise<boolean>
- Defined in measurements/measurement.ts:408

`Static` createMeasurement

createMeasurement(id: Int64, renderer: BaseRenderer, settings?: MeasurementSettings, data?: MeasurementData): Promise<Measurement>
Creates a new measurement instance.

Returns
A promise that resolves to the new measurement instance.
Parameters
- id: Int64
  
  The unique identifier for the measurement.
- renderer: BaseRenderer
  
  The renderer associated with the measurement.
- Optional settings: MeasurementSettings
  
  Optional settings for the measurement.
- Optional data: MeasurementData
  
  Optional data for the measurement.
Returns Promise<Measurement>
- Defined in measurements/measurement.ts:124

Class Measurement

Hierarchy

Index

Accessors

Methods

Accessors

color

Returns

Returns RGB

elementId

Returns

Returns Int64

Parameters

elementId: Int64

Returns void

highlighted

Returns

Returns boolean

id

Returns

Returns Int64

negative

Returns

Returns boolean

Parameters

negative: boolean

Returns void

pattern

Returns

Returns BIM_MEASUREMENT2D_FILL_PATTERN

pointColor

Returns

Returns RGB

pointIds

Returns

Returns number[]

type

Returns

Returns MEASUREMENT_TYPE

Methods

addArcPoint3D

Returns

Parameters

x: number

y: number

z: number

useElevation: boolean

faceId: Int64 = null

Returns Promise<boolean>

addLastLengthOverride

Parameters

length: number

Returns void

addPoint3D

Returns

Parameters

x: number

y: number

z: number

useElevation: boolean

faceId: Int64 = null

is_control: boolean = false

Returns Promise<number>

clearArcPoint3D

Returns void

clearLabels

Returns void

close

Returns

Parameters

closeIfLength: boolean

Returns Promise<false | BR_FunctionOutput>

computePerpendicularPointsOnLine

Returns

Parameters

lineData: number[]

skipCurrentPoint: boolean

Returns Promise<Vector3D[]>

computePerpendicularPointsOnLineExcludePoint

Returns