Class MeasureControllerV2

OptionalcurrentMeasureMesh

Readonlyname

config

• get config(): MeasurePluginConfig

• Returns MeasurePluginConfig

• set config(config): void

• Parameters

  • config: MeasurePluginConfig

  Returns void

interactionState

• get interactionState(): Readonly<{
      measurementCount: number;
      phase:
          | "editing"
          | "idle"
          | "drawing"
          | "holding";
      pointCount: number;
      result?: "confirmed" | "cancelled";
  }>

• Returns Readonly<{
      measurementCount: number;
      phase:
          | "editing"
          | "idle"
          | "drawing"
          | "holding";
      pointCount: number;
      result?: "confirmed" | "cancelled";
  }>

cancel

• cancel(): void

• Returns void

  Description

  取消本次测量

clear

• clear(): void

• Returns void

  Description

  清空所有测量内容

clearCurrentMeasure

• clearCurrentMeasure(): void

• Returns void

  Description

  清空正在测量的内容

dispose

• dispose(): void

• Returns void

emit

• emit<K>(name, ...data): boolean

• 触发事件

  Type Parameters

  • K extends keyof MeasurePluginEventMap

    预设的监听事件名称

  Parameters

  • name: K

    事件类型
  • Rest...data: Parameters<MeasurePluginEventMap[K]>

    触发事件的数据

  Returns boolean

  canceled 是否被触发取消

emitWithResult

• emitWithResult<K>(name, ...data): Vector3

• 触发事件并返回监听器的返回值

  Type Parameters

  • K extends keyof MeasurePluginEventMap

    预设的监听事件名称

  Parameters

  • name: K

    事件类型
  • Rest...data: Parameters<MeasurePluginEventMap[K]>

    触发事件的数据

  Returns Vector3

  监听器的返回值数组

endMeasure

• endMeasure(): void

• Returns void

  Description

  结束测量

hasListener

• hasListener(name): boolean

• 判断是否注册了事件

  Parameters

  • name: keyof MeasurePluginEventMap

    事件类型

  Returns boolean

initEventListeners

• initEventListeners(): void

• Returns void

  Description

  Initialize event listeners for all existing meshes

load

• load(data): void

• Parameters

  • data: {
        points: Vector3[];
    }[]

    Array of point data for measurements

  Returns void

  Description

  Load measurement data from external source

measure

• measure(): void

• Returns void

  Description

  开始测量

off

• off<K>(name?, callback?): void

• 解除事件

  如果 name 不传的话解除对应所有事件 如果 name, callback 不传的话解除所有name的所有事件

  Type Parameters

  • K extends keyof MeasurePluginEventMap

    预设的监听事件名称

  Parameters

  • Optionalname: K

    事件类型
  • Optionalcallback: ((...args: Parameters<MeasurePluginEventMap[K]>) => ReturnType<MeasurePluginEventMap[K]>)

    事件回调函数

    • • (...args): ReturnType<MeasurePluginEventMap[K]>

      • Parameters

        • Rest...args: Parameters<MeasurePluginEventMap[K]>

        Returns ReturnType<MeasurePluginEventMap[K]>

  Returns void

on

• on<K>(name, callback, once?): (() => void)

• 注册事件

  Type Parameters

  • K extends keyof MeasurePluginEventMap

    预设的监听事件名称

  Parameters

  • name: K

    事件类型
  • callback: ((...args: Parameters<MeasurePluginEventMap[K]>) => ReturnType<MeasurePluginEventMap[K]>)

    事件回调函数

    • • (...args): ReturnType<MeasurePluginEventMap[K]>

      • Parameters

        • Rest...args: Parameters<MeasurePluginEventMap[K]>

        Returns ReturnType<MeasurePluginEventMap[K]>

  • Optionalonce: boolean

    是否只执行一次

  Returns (() => void)

  解除事件

  • • (): void

    • Returns void

once

• once<K>(name, callback): (() => void)

• 注册事件(是否只执行一次)

  Type Parameters

  • K extends keyof MeasurePluginEventMap

    预设的监听事件名称

  Parameters

  • name: K

    事件类型
  • callback: ((...args: Parameters<MeasurePluginEventMap[K]>) => ReturnType<MeasurePluginEventMap[K]>)

    事件回调函数

    • • (...args): ReturnType<MeasurePluginEventMap[K]>

      • Parameters

        • Rest...args: Parameters<MeasurePluginEventMap[K]>

        Returns ReturnType<MeasurePluginEventMap[K]>

  Returns (() => void)

  解除事件

  • • (): void

    • Returns void

setLengthEnable

• setLengthEnable(enable): void

• Enable or disable the display of length measurements

  Parameters

  • enable: boolean

    Whether to display length measurements

  Returns void

setPrecision

• setPrecision(precision): void

• Set the precision for length measurements

  Parameters

  • precision: number

    For metric (m): decimal places. For imperial (ft): inch fraction denominator (1 | 4 | 8 | 16). Area measurements remain at fixed 2 decimal places.

  Returns void

setUnit

• setUnit(unit): void

• Switch the measurement unit without resetting the plugin

  Parameters

  • unit: "m" | "mm" | "ft"

    The new unit to use ('m' for metric, 'ft' for imperial, or 'mm' for millimeters)

  Returns void

undo

• undo(): void

• Returns void

  Description

  撤销上一步