Interface InputBindings

Class that serves as an interface to manage the viewer input bindings.

interface InputBindings {
    keyBindings: KeysActionBinding[];
    mouseBindings: MouseActionBinding[];
    scrollBindings: ScrollActionBinding[];
    getActionKeysBindings(theAction: KeyActions): KeysActionBinding[];
    getKeyBinding(theKey: number): KeysActionBinding;
    getMouseGestureBindings(theGesture: MouseGesture): MouseActionBinding[];
    getMouseKeyBinding(theMouseKey: number): MouseActionBinding;
    getScrollActionBindings(theAction: ScrollActions): ScrollActionBinding[];
    getScrollKeyBinding(theModifierKey: number): ScrollActionBinding;
    removeActionKeysBindings(theAction: KeyActions): void;
    removeKeyBinding(theKey: number): void;
    removeMouseGestureBindings(theGesture: MouseGesture): void;
    removeMouseKeyBinding(theMouseKey: number): void;
    removeScrollActionBindings(theAction: ScrollActions): void;
    removeScrollKeyBinding(theModifierKey: number): void;
    setKeyBinding(theBinding: KeysActionBinding): void;
    setMouseBinding(theBinding: MouseActionBinding): void;
    setScrollBinding(theBinding: ScrollActionBinding): void;
}

Index

Properties

keyBindings mouseBindings scrollBindings

Methods

getActionKeysBindings getKeyBinding getMouseGestureBindings getMouseKeyBinding getScrollActionBindings getScrollKeyBinding removeActionKeysBindings removeKeyBinding removeMouseGestureBindings removeMouseKeyBinding removeScrollActionBindings removeScrollKeyBinding setKeyBinding setMouseBinding setScrollBinding

Properties

`Readonly`keyBindings

keyBindings: KeysActionBinding[]

Get an array of all the key bindings active in the viewer.

`Readonly`mouseBindings

mouseBindings: MouseActionBinding[]

Get an array of all the mouse bindings active in the viewer.

`Readonly`scrollBindings

scrollBindings: ScrollActionBinding[]

Get an array of all the mouse bindings active in the viewer.

Methods

getActionKeysBindings

getActionKeysBindings(theAction: KeyActions): KeysActionBinding[]
Get all the current bindings for the specified action.
Parameters
- theAction: KeyActions
  The KeyActions to get bindings.
Returns KeysActionBinding[]
Vector with all the bindings of the KeyActions.

getKeyBinding

getKeyBinding(theKey: number): KeysActionBinding
Get the binding associated with the key passed.
Parameters
- theKey: number
  The key to get the binding.
Returns KeysActionBinding
Binding associated with the key.

getMouseGestureBindings

getMouseGestureBindings(theGesture: MouseGesture): MouseActionBinding[]
Get all the current bindings for the specified mouse gesture.
Parameters
- theGesture: MouseGesture
  The MouseGesture to get bindings.
Returns MouseActionBinding[]
Vector with all the bindings of the MouseGesture.

getMouseKeyBinding

getMouseKeyBinding(theMouseKey: number): MouseActionBinding
Get the binding associated with the mouse key passed.
Parameters
- theMouseKey: number
  The mouse key to get the binding.
Returns MouseActionBinding
Binding associated with the mouse key.

getScrollActionBindings

getScrollActionBindings(theAction: ScrollActions): ScrollActionBinding[]
Get all the current scroll bindings for the specified action.
Parameters
- theAction: ScrollActions
  The ScrollActions to get bindings.
Returns ScrollActionBinding[]
Vector with all the bindings of the ScrollActions.

getScrollKeyBinding

getScrollKeyBinding(theModifierKey: number): ScrollActionBinding
Get the scroll binding associated with the modifier key passed (NONE if only scroll).
Parameters
- theModifierKey: number
Returns ScrollActionBinding
Scroll binding associated with the key.

removeActionKeysBindings

removeActionKeysBindings(theAction: KeyActions): void
Remove all the bindings with the specified action.
Parameters
- theAction: KeyActions
  The KeyActions to remove bindings.
Returns void

removeKeyBinding

removeKeyBinding(theKey: number): void
Removes the binding associated with the key passed.
Parameters
- theKey: number
  The key to remove bindings.
Returns void

removeMouseGestureBindings

removeMouseGestureBindings(theGesture: MouseGesture): void
Remove all the bindings with the specified MouseGesture.
Parameters
- theGesture: MouseGesture
  The MouseGesture to remove bindings.
Returns void

removeMouseKeyBinding

removeMouseKeyBinding(theMouseKey: number): void
Removes the binding associated with the mouse key passed.
Parameters
- theMouseKey: number
  The mouse key to remove bindings.
Returns void

removeScrollActionBindings

removeScrollActionBindings(theAction: ScrollActions): void
Remove all the scroll bindings with the specified action.
Parameters
- theAction: ScrollActions
  The ScrollActions to remove bindings.
Returns void

removeScrollKeyBinding

removeScrollKeyBinding(theModifierKey: number): void
Removes the scroll binding associated with the modifier key passed (NONE if only scroll).
Parameters
- theModifierKey: number
Returns void

setKeyBinding

setKeyBinding(theBinding: KeysActionBinding): void
Binds the passed KeysActionBinding in the viewer.
Parameters
- theBinding: KeysActionBinding
  The key binding to set in the viewer.
Returns void

setMouseBinding

setMouseBinding(theBinding: MouseActionBinding): void
Binds the passed MouseActionBinding in the viewer.
Parameters
- theBinding: MouseActionBinding
  The mouse binding to set in the viewer.
Returns void

setScrollBinding

setScrollBinding(theBinding: ScrollActionBinding): void
Binds the passed ScrollActionBinding in the viewer.
Parameters
- theBinding: ScrollActionBinding
  The scroll binding to set in the viewer.
Returns void