Class PickingTool

Hierarchy

SinglePointerTool
- PickingTool

Implements

SnappingTool

Index

Constructors

Properties

navigation onCancelled?

Accessors

allowedSnapTypes enabled mouseButton name snapTypes touchCount Name

Methods

Constructors

constructor

new PickingTool(_inputs, _cursor3D, _eventDispatcher): PickingTool
Parameters
- _inputs: InputHandler
- _cursor3D: Cursor3D
- _eventDispatcher: EventDispatcher
Returns PickingTool
Overrides SinglePointerTool.constructor
- Defined in packages/web3d/src/Tools/PickingTool.ts:83

Properties

navigation

navigation: boolean = false

`Optional` onCancelled

onCancelled?: (() => void)

Type declaration

- (): void
- Returns void

Accessors

allowedSnapTypes

get allowedSnapTypes(): SnapType[]
Returns SnapType[]
Implementation of SnappingTool.allowedSnapTypes
- Defined in packages/web3d/src/Tools/PickingTool.ts:25

enabled

get enabled(): boolean
Returns boolean
Overrides SinglePointerTool.enabled
- Defined in packages/web3d/src/Tools/PickingTool.ts:45
set enabled(enabled): void
Parameters
- enabled: boolean
Returns void
Overrides SinglePointerTool.enabled
- Defined in packages/web3d/src/Tools/PickingTool.ts:49

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/PickingTool.ts:21

snapTypes

get snapTypes(): SnapType[]
Returns SnapType[]
Implementation of SnappingTool.snapTypes
- Defined in packages/web3d/src/Tools/PickingTool.ts:41
set snapTypes(snapTypes): void
Parameters
- snapTypes: SnapType[]
Returns void
Implementation of SnappingTool.snapTypes
- Defined in packages/web3d/src/Tools/PickingTool.ts:29

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/PickingTool.ts:12

Methods

cancel

cancel(): void
Returns void
Inherited from SinglePointerTool.cancel
- Defined in packages/web3d/src/Tools/Tool.ts:7

restart

restart(): void
Returns void
Inherited from SinglePointerTool.restart
- Defined in packages/web3d/src/Tools/Tool.ts:12