Class MeasurementTool

Hierarchy

TapMoveTapTool<Measurement>
- MeasurementTool

Index

Constructors

Properties

Accessors

allowedSnapTypes enabled snapTypes Name

Methods

Constructors

constructor

new MeasurementTool(api, model, markupSettings): MeasurementTool
Parameters
- api: Api
- model: MarkupModel
- markupSettings: MarkupSettings
Returns MeasurementTool
Overrides TapMoveTapTool<Measurement>.constructor
- Defined in packages/web3d-plugin-markup/src/Tools/MeasurementTool.ts:17

Properties

name

name: string

Accessors

allowedSnapTypes

get allowedSnapTypes(): SnapType[]
Returns SnapType[]
Inherited from TapMoveTapTool.allowedSnapTypes
- Defined in packages/web3d-plugin-markup/src/Tools/MarkupTool.ts:20

enabled

get enabled(): boolean
Returns boolean
Inherited from TapMoveTapTool.enabled
- Defined in packages/web3d-plugin-markup/src/Tools/TapMoveTapTool.ts:60
set enabled(enabled): void
Parameters
- enabled: boolean
Returns void
Inherited from TapMoveTapTool.enabled
- Defined in packages/web3d-plugin-markup/src/Tools/TapMoveTapTool.ts:29

snapTypes

get snapTypes(): SnapType[]
Returns SnapType[]
Inherited from TapMoveTapTool.snapTypes
- Defined in packages/web3d-plugin-markup/src/Tools/MarkupTool.ts:26
set snapTypes(value): void
Parameters
- value: SnapType[]
Returns void
Inherited from TapMoveTapTool.snapTypes
- Defined in packages/web3d-plugin-markup/src/Tools/MarkupTool.ts:30

`Static` Name

get Name(): string
Returns string
- Defined in packages/web3d-plugin-markup/src/Tools/MeasurementTool.ts:13

Methods

add

add(start, end, color?, origin?): Measurement
Parameters
- start: SnapPick
- end: SnapPick
- Optional color: Color
- Optional origin: any
Returns Measurement
Overrides TapMoveTapTool.add
- Defined in packages/web3d-plugin-markup/src/Tools/MeasurementTool.ts:34

cancel

cancel(): void
Returns void
Inherited from TapMoveTapTool.cancel
- Defined in packages/web3d-plugin-markup/src/Tools/TapMoveTool.ts:39