Class CloudMarkupTool

Hierarchy

TapTool
- CloudMarkupTool

Index

Constructors

Properties

Accessors

allowedSnapTypes enabled snapTypes Name

Methods

Constructors

constructor

new CloudMarkupTool(api, model, markupSettings): CloudMarkupTool
Parameters
- api: Api
- model: MarkupModel
- markupSettings: MarkupSettings
Returns CloudMarkupTool
Overrides TapTool.constructor
- Defined in packages/web3d-plugin-markup/src/Tools/CloudMarkupTool.ts:16

Properties

name

name: string

Accessors

allowedSnapTypes

get allowedSnapTypes(): SnapType[]
Returns SnapType[]
Overrides TapTool.allowedSnapTypes
- Defined in packages/web3d-plugin-markup/src/Tools/CloudMarkupTool.ts:12

enabled

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

snapTypes

get snapTypes(): SnapType[]
Returns SnapType[]
Inherited from TapTool.snapTypes
- Defined in packages/web3d-plugin-markup/src/Tools/MarkupTool.ts:26
set snapTypes(value): void
Parameters
- value: SnapType[]
Returns void
Inherited from TapTool.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/CloudMarkupTool.ts:10

Methods

add

add(pick, width, height, color?, origin?): CloudMarkup
Parameters
- pick: SnapPick
- width: number
- height: number
- Optional color: Color
- Optional origin: any
Returns CloudMarkup
- Defined in packages/web3d-plugin-markup/src/Tools/CloudMarkupTool.ts:27

cancel

cancel(): void
Returns void
Inherited from TapTool.cancel
- Defined in packages/web3d-plugin-markup/src/Tools/MarkupTool.ts:46

tap

tap(event): Promise<void>
Parameters
- event: PointerInput
Returns Promise<void>
Inherited from TapTool.tap
- Defined in packages/web3d-plugin-markup/src/Tools/TapTool.ts:39