Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Measurement

Hierarchy

  • Measurement

Index

Accessors

Methods

Accessors

color

  • get color(): RGB

  • Returns RGB

elementId

  • get elementId(): Int64
  • set elementId(elementId: Int64): void

  • Returns Int64

  • Parameters

    Returns void

highlighted

  • get highlighted(): boolean

  • Returns boolean

id

  • Returns Int64

negative

  • get negative(): boolean
  • set negative(negative: boolean): void

  • Returns boolean

  • Parameters

    • negative: boolean

    Returns void

pattern

pointIds

  • get pointIds(): number[]

  • Returns number[]

type

Methods

addArcPoint3D

  • addArcPoint3D(x: number, y: number, z: number, useElevation: boolean, faceId?: Int64): Promise<boolean>

  • Parameters

    • x: number
    • y: number
    • z: number
    • useElevation: boolean
    • faceId: Int64 = null

    Returns Promise<boolean>

addPoint3D

  • addPoint3D(x: number, y: number, z: number, useElevation: boolean, faceId?: Int64, is_control?: boolean): Promise<number>

  • Parameters

    • x: number
    • y: number
    • z: number
    • useElevation: boolean
    • faceId: Int64 = null
    • is_control: boolean = false

    Returns Promise<number>

clearArcPoint3D

  • clearArcPoint3D(): void

  • Returns void

clearLabels

  • clearLabels(): void

  • Returns void

close

  • close(closeIfLength: boolean): Promise<false | BR3D_CloseMeasurementResult>

  • Parameters

    • closeIfLength: boolean

    Returns Promise<false | BR3D_CloseMeasurementResult>

computePerpendicularPointsOnLine

  • computePerpendicularPointsOnLine(lineData: number[], skipCurrentPoint: boolean): Promise<Vector3d[]>

  • Parameters

    • lineData: number[]
    • skipCurrentPoint: boolean

    Returns Promise<Vector3d[]>

computePerpendicularPointsOnLineExcludePoint

  • computePerpendicularPointsOnLineExcludePoint(lineData: number[], pointToExclude: number, skipCurrentPoint: boolean): Promise<Vector3d[]>

  • Parameters

    • lineData: number[]
    • pointToExclude: number
    • skipCurrentPoint: boolean

    Returns Promise<Vector3d[]>

containsPoint

  • containsPoint(xe: number, ye: number, ze: number): Promise<number>

  • Parameters

    • xe: number
    • ye: number
    • ze: number

    Returns Promise<number>

deleteCurrentPoint

  • deleteCurrentPoint(): Promise<boolean>

  • Returns Promise<boolean>

deletePoint

  • deletePoint(screenX: number, screenY: number): Promise<boolean>

  • Parameters

    • screenX: number
    • screenY: number

    Returns Promise<boolean>

destroy

  • Returns Promise<void>

findElementIdInFaces

  • Returns Promise<Int64>

findOrUpdateNormalBehind

  • findOrUpdateNormalBehind(): Promise<Vector3d>

  • Returns Promise<Vector3d>

getArcPoint3D

  • getArcPoint3D(): Vector3d

  • Returns Vector3d

getCurrentPoint

  • getCurrentPoint(): Promise<Vector3d>

  • Returns Promise<Vector3d>

getCurrentPointId

  • getCurrentPointId(): number

  • Returns number

getCurrentSegmentPoints

  • getCurrentSegmentPoints(): Promise<Vector3d[]>

  • Returns Promise<Vector3d[]>

getData

  • Returns Promise<string>

getFirstPoint

  • getFirstPoint(): number

  • Returns number

getLastPoint

  • getLastPoint(): number

  • Returns number

getNumPoints

  • getNumPoints(): number

  • Returns number

getPixelCenter

  • Returns Promise<Point2D>

getPreviousPointOf

  • getPreviousPointOf(point_id: number): Promise<number>

  • Parameters

    • point_id: number

    Returns Promise<number>

getTotalArea

  • Returns Promise<number>

getTotalAreaMM

  • getTotalAreaMM(extraPoint?: Vector3d): Promise<number>

  • Parameters

    • extraPoint: Vector3d = null

    Returns Promise<number>

getTotalLength

  • Returns Promise<number>

getTotalLengthMM

  • getTotalLengthMM(extraPoint?: Vector3d): Promise<number>

  • Parameters

    • extraPoint: Vector3d = null

    Returns Promise<number>

insertPoint

  • insertPoint(x: number, y: number, faceId?: Int64, is_control?: boolean): Promise<void>

  • Parameters

    • x: number
    • y: number
    • faceId: Int64 = null
    • is_control: boolean = false

    Returns Promise<void>

isClosedMeasurement

  • isClosedMeasurement(): boolean

  • Returns boolean

isOverPoint

  • isOverPoint(screenX: number, screenY: number): Promise<boolean>

  • Parameters

    • screenX: number
    • screenY: number

    Returns Promise<boolean>

isOverSegment

  • isOverSegment(screenX: number, screenY: number): Promise<boolean>

  • Parameters

    • screenX: number
    • screenY: number

    Returns Promise<boolean>

isPointAcceptedForAddition

  • isPointAcceptedForAddition(cur_point_id: number): Promise<boolean>

  • Parameters

    • cur_point_id: number

    Returns Promise<boolean>

moveCurrentPoint

  • moveCurrentPoint(screenX: number, screenY: number, degreeSnapping?: boolean): Promise<void>

  • Parameters

    • screenX: number
    • screenY: number
    • Optional degreeSnapping: boolean

    Returns Promise<void>

moveCurrentPoint3D

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

  • Parameters

    • x: number
    • y: number
    • z: number

    Returns Promise<boolean>

moveCurrentSegment

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

  • Parameters

    • x: number
    • y: number

    Returns Promise<boolean>

moveCurrentSegmentPoints

  • moveCurrentSegmentPoints(p1: Vector3d, p2: Vector3d): Promise<boolean>

  • Parameters

    • p1: Vector3d
    • p2: Vector3d

    Returns Promise<boolean>

pointFaceId

  • pointFaceId(pointId: number): Int64

  • Parameters

    • pointId: number

    Returns Int64

reconstructLabels

  • Returns Promise<void>

removeLastPoint

  • Returns Promise<void>

setClosedMeasurement

  • setClosedMeasurement(closed: boolean): void

  • Parameters

    • closed: boolean

    Returns void

setColor

  • Parameters

    • color: RGB
    • Optional pointColor: RGB

    Returns Promise<void>

setCurrentPoint

  • setCurrentPoint(screenX: number, screenY: number): Promise<boolean>

  • Parameters

    • screenX: number
    • screenY: number

    Returns Promise<boolean>

setCurrentPointToFirstPoint

  • setCurrentPointToFirstPoint(): Promise<boolean>

  • Returns Promise<boolean>

setHighlighted

  • setHighlighted(highlighted: boolean): Promise<void>

  • Parameters

    • highlighted: boolean

    Returns Promise<void>

terminateArcPoint3D

  • terminateArcPoint3D(): Promise<void>

  • Returns Promise<void>

updateLabels

  • Returns Promise<boolean>

Static createMeasurement