Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MeasurementPlugin

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly id

id: string

selectedDrawable

selectedDrawable: undefined | BaseMeasureDrawable = undefined

Methods

activate

  • description

    {en} Activates one of "Distance", "Area" or "Angle" measurement

    description

    {zh} 激活"距离", "面积" 或者 "角度"测量

    Parameters

    Returns void

add

  • Parameters

    Returns void

cancel

  • cancel(): void
  • description

    {en} Cancels current measurement. This won't deactivate measurement, rather, you can start a new measurement.

    description

    {zh} 取消当前的测量绘制。这并不会退出测量，用户可以开始一个新的测量。

    Returns void

clear

  • clear(): void
  • description

    {en} Clears measurement results.

    description

    {zh} 清除测量结果。

    Returns void

create

deactivate

  • deactivate(): void
  • description

    {en} Deactivates measurement.

    description

    {zh} 退出测量。

    Returns void

destroy

  • destroy(): void
  • description

    Destroy measure plugin

    Returns void

getActiveMeasurementType

  • Returns undefined | MeasurementType

getById

  • Gets a measurement drawable by id.

    Parameters

    • id: string

    Returns BaseMeasureDrawable

getData

  • description

    {en} Gets all measurements.

    description

    {zh} 获取所有测量数据。

    Returns DrawableData[]

getScale

  • getScale(): undefined | number

  • Gets the scale value. Scale is the ratio of real world value and the value in three.js(pdf, a map, etc.). e.g., Real world distance is 1000, and the value in three.js is 1, then scale is 1000. We should display 1000 rather than 1 while measuring.

    Returns undefined | number

isActive

  • isActive(): boolean
  • description

    Is measure plugin active

    Returns boolean

isMeasuring

  • isMeasuring(): boolean

  • Returns boolean

    Is measuring now

remove

  • Parameters

    Returns void

removeById

  • removeById(id: string): void

  • Parameters

    • id: string

    Returns void

select

  • Selects a measurement drawable.

    Parameters

    Returns void

selectById

  • selectById(id: string): void

  • Selects a measurement drawable by id.

    description

    Selects a measurement by id

    Parameters

    • id: string

    Returns void

setData

  • description

    {en} Sets measurement data.

    description

    {zh} 设置测量数据。

    Parameters

    Returns void

setScale

  • setScale(scale: undefined | number): void

  • Sets the scale value.

    Parameters

    • scale: undefined | number

    Returns void

setSnapTolerance

  • setSnapTolerance(toleranceInPixel: number): void

  • Set osnap tolerance in pixcel size. The pixcel size will be converted to a size in world coordinate and pass to OSnapHelper.

    Parameters

    • toleranceInPixel: number

    Returns void

setVisibilities

  • setVisibilities(visible: boolean): void

  • Sets all measurement drawables' visibilities.

    Parameters

    • visible: boolean

    Returns void

setVisibilityById

  • setVisibilityById(id: string, visible: boolean): boolean

  • Sets a measurement drawable's visibility by id.

    description

    Sets a measurement's visibility.

    Parameters

    • id: string
    • visible: boolean

    Returns boolean

unselect

  • unselect(renderEnabled?: boolean): void
  • description

    Unselects a measurement.

    Parameters

    • renderEnabled: boolean = true

      If need render measurement

    Returns void

Generated using TypeDoc