Class AreaSelectionTool

Hierarchy

SinglePointerTool
- AreaSelectionTool

Implements

ISelectionTool

Index

Constructors

Properties

mode onCancelled? onChange onRestart

Accessors

enabled mouseButton name touchCount Name

Methods

cancel restart startAreaSelection

Constructors

constructor

new AreaSelectionTool(api): AreaSelectionTool
Parameters
- api: Api
Returns AreaSelectionTool
Overrides SinglePointerTool.constructor
- Defined in packages/web3d/src/Tools/AreaSelectionTool.ts:30

Properties

mode

mode: SelectionMode = SelectionMode.Replace

`Optional` onCancelled

onCancelled?: (() => void)

Type declaration

- (): void
- Returns void

onChange

onChange: ((modelId, ids, containedOnly) => Promise<number[]>)

Type declaration

- (modelId, ids, containedOnly): Promise<number[]>
- Parameters
  - modelId: string
  - ids: number[]
  - containedOnly: boolean
  Returns Promise<number[]>

onRestart

onRestart: (() => void)

Type declaration

- (): void
- Returns void

Accessors

enabled

get enabled(): boolean
Returns boolean
Overrides SinglePointerTool.enabled
- Defined in packages/web3d/src/Tools/AreaSelectionTool.ts:147
set enabled(enabled): void
Parameters
- enabled: boolean
Returns void
Overrides SinglePointerTool.enabled
- Defined in packages/web3d/src/Tools/AreaSelectionTool.ts:137

mouseButton

get mouseButton(): MouseButton
Returns MouseButton
Inherited from SinglePointerTool.mouseButton
- Defined in packages/web3d/src/Tools/SinglePointerTool.ts:6
set mouseButton(v): void
Parameters
- v: MouseButton
Returns void
Inherited from SinglePointerTool.mouseButton
- Defined in packages/web3d/src/Tools/SinglePointerTool.ts:10

name

get name(): string
Returns string
Overrides SinglePointerTool.name
- Defined in packages/web3d/src/Tools/AreaSelectionTool.ts:26

touchCount

get touchCount(): number
Returns number
Inherited from SinglePointerTool.touchCount
- Defined in packages/web3d/src/Tools/SinglePointerTool.ts:14
set touchCount(v): void
Parameters
- v: number
Returns void
Inherited from SinglePointerTool.touchCount
- Defined in packages/web3d/src/Tools/SinglePointerTool.ts:18

`Static` Name

get Name(): string
Returns string
- Defined in packages/web3d/src/Tools/AreaSelectionTool.ts:12

Methods

cancel

cancel(): void
Returns void
Overrides SinglePointerTool.cancel
- Defined in packages/web3d/src/Tools/AreaSelectionTool.ts:63

restart

restart(): void
Returns void
Overrides SinglePointerTool.restart
- Defined in packages/web3d/src/Tools/AreaSelectionTool.ts:69

startAreaSelection

startAreaSelection(downEvent): void
Parameters
- downEvent: PointerInput
Returns void
- Defined in packages/web3d/src/Tools/AreaSelectionTool.ts:53