Class Input

Manages and registers all viewer user inputs for mouse, keyboard and touch

Hierarchy

Input

Index

Constructors

Properties

keyboard mouse touch

Accessors

onContextMenu onPointerModeChanged onPointerOverrideChanged pointerActive pointerFallback pointerOverride scheme

Methods

ContextMenu IdleAction KeyAction MainAction registerAll resetAll unregisterAll

Constructors

constructor

new Input(viewer: Viewer): Input
Parameters
- viewer: Viewer
Returns Input
- Defined in src/vim-webgl-viewer/inputs/input.ts:142

Properties

keyboard

keyboard: KeyboardHandler

Keyboard input handler

mouse

mouse: MouseHandler

Mouse input handler

touch

touch: TouchHandler

Touch input handler

Accessors

onContextMenu

get onContextMenu(): ISimpleEvent<Vector2>
Event called when when context menu could be displayed

Returns ISimpleEvent<Vector2>
- Defined in src/vim-webgl-viewer/inputs/input.ts:221

onPointerModeChanged

get onPointerModeChanged(): ISignal
Event called when pointer interaction mode changes.

Returns ISignal
- Defined in src/vim-webgl-viewer/inputs/input.ts:202

onPointerOverrideChanged

get onPointerOverrideChanged(): ISignal
Event called when the pointer is temporarily overriden.

Returns ISignal
- Defined in src/vim-webgl-viewer/inputs/input.ts:210

pointerActive

get pointerActive(): PointerMode
Returns current pointer mode.

Returns PointerMode
- Defined in src/vim-webgl-viewer/inputs/input.ts:167
set pointerActive(value: PointerMode): void
Changes pointer interaction mode. Look mode will set camera orbitMode to false.
Parameters
- value: PointerMode
Returns void
- Defined in src/vim-webgl-viewer/inputs/input.ts:187

pointerFallback

get pointerFallback(): PointerMode
Returns the last main mode (orbit, look) that was active.

Returns PointerMode
- Defined in src/vim-webgl-viewer/inputs/input.ts:160

pointerOverride

get pointerOverride(): PointerMode
A temporary pointer mode used for temporary icons.

Returns PointerMode
- Defined in src/vim-webgl-viewer/inputs/input.ts:174
set pointerOverride(value: PointerMode): void
Parameters
- value: PointerMode
Returns void
- Defined in src/vim-webgl-viewer/inputs/input.ts:178

scheme

get scheme(): InputScheme
Get or set the current viewer input scheme, set undefined to revert to default.

Returns InputScheme
- Defined in src/vim-webgl-viewer/inputs/input.ts:230
set scheme(value: InputScheme): void
Parameters
- value: InputScheme
Returns void
- Defined in src/vim-webgl-viewer/inputs/input.ts:234

Methods

ContextMenu

ContextMenu(position: Vector2): void
Calls context menu action
Parameters
- position: Vector2
Returns void
- Defined in src/vim-webgl-viewer/inputs/input.ts:262

IdleAction

IdleAction(action: InputAction): void
Calls idle action on the current input scheme
Parameters
- action: InputAction
Returns void
- Defined in src/vim-webgl-viewer/inputs/input.ts:248

KeyAction

KeyAction(key: number): boolean
Calls key action on the current input scheme
Parameters
- key: number
Returns boolean
- Defined in src/vim-webgl-viewer/inputs/input.ts:255

MainAction

MainAction(action: InputAction): void
Calls main action on the current input scheme
Parameters
- action: InputAction
Returns void
- Defined in src/vim-webgl-viewer/inputs/input.ts:241

registerAll

registerAll(): void
Register inputs handlers for default viewer behavior

Returns void
- Defined in src/vim-webgl-viewer/inputs/input.ts:269

resetAll

resetAll(): void
Resets all input state

Returns void
- Defined in src/vim-webgl-viewer/inputs/input.ts:287

unregisterAll

unregisterAll(): void
Unregisters all input handlers

Returns void
- Defined in src/vim-webgl-viewer/inputs/input.ts:278

Generated using TypeDoc