@ -88,19 +88,65 @@ acceleration involved. One just presses them.
* `Key_mouseBtnL` , `Key_mouseBtnM` , `Key_mouseBtnR` : The left, middle, and right
mouse buttons, respectively.
### Warping
## Warping
Warping is one of the most interesting features of the plugin, and is a feature
unique to Kaleidoscope, as far as we can tell. The warping keys position the
mouse cursor within a quadrant of the screen on first press, and any subsequent
taps will warp within the previously selected quadrant. For example, pressing
the north-west warp key twice will first jump to the middle of the north-west
quadrant of your screen, then select the north-west quadrant of that, and jump
to the middle of it.
mouse cursor within a sector of the screen on first press, and any subsequent
taps will warp within the previously selected sector. For example, pressing the
north-west warp key twice will first jump to the middle of the north-west
sector of your screen, then select the north-west sector of that, and jump to
the middle of it.
To stop warping, use any other mouse key, or hit the "warp end" key.
The warping keys are the following:
### Warp grid size
The warp grid size determines how MouseKeys partitions the screen to select the
next position to jump to when pressing a warp key. The plugin provides two grid
sizes to choose from: a *2x2* grid that splits the screen into quadrants, and a
*3x3* grid with nine cells similar to a navigation feature included with some
speech recognition software. By default, the plugin splits the screen into the
2x2 grid.
To change the warp grid size, call the plugin's `setWarpGridSize()` method:
```c++
MouseKeys.setWarpGridSize(MOUSE_WARP_GRID_3X3);
```
#### 2x2 grid
As described above, MouseKeys warps the pointer using a grid model that reflects
locations on the screen. By default, the plugin uses a 2x2 grid. To understand
how warping works, examine this diagram of a screen split into that 2x2 grid:
+-----------------------+-----------------------+
| | | |
| G | tab | |
| | | |
|-----------+-----------| tab |
| | | |
| B | esc | |
| | | |
+-----------------------+-----------------------+
| | |
| | |
| | |
| B | esc |
| | |
| | |
| | |
+-----------------------+-----------------------+
Each quadrant is labed with a key that, when pressed, moves the mouse pointer
to the center of that quadrant. With this layout, pressing < kbd > G< / kbd > warps
the pointer to the top-left quadant. Then, the plugin "zooms" into that sector
with a smaller grid so that the next warp key pressed jumps the pointer more
precisely within the sector. In this case, if we press < kbd > esc< / kbd > next,
the pointer warps to the bottom-right corner within that quadrant.
The warping keys for the 2x2 grid are the following:
* `Key_mouseWarpNW` , `Key_mouseWarpNE` , `Key_mouseWarpSW` , `Key_mouseWarpSE` :
Warp towards the north-west, north-east, south-west, or south-east quadrants,
@ -109,6 +155,64 @@ The warping keys are the following:
state. Using any of the warping keys after this will start from the whole
screen again.
#### 3x3 grid
A 3x3 warp grid assigns a key to each of nine sectors of the screen. The next
diagram shows a screen with a key label that warps to each sector. As we can
see, pressing < kbd > W< / kbd > warps the pointer into the top-left sector, and
pressing < kbd > V< / kbd > warps to the bottom-right corner within that sector:
+-----------------+-----------------+-----------------+
| W | E | R | | |
|-----+-----+-----| | |
| S | D | F | E | R |
|-----+-----+-----| | |
| X | C | V | | |
+-----------------+-----------------+-----------------+
| | | |
| | | |
| S | D | F |
| | | |
| | | |
+-----------------+-----------------+-----------------+
| | | |
| | | |
| X | C | V |
| | | |
| | | |
+-----------------+-----------------+-----------------+
To use a 3x3 warp grid, we may need to remap some keys. A suggested warp key
mapping is shown below on the left side of a keyboard with a QWERTY layout:
W | E | R T A - End Warping (Key_mouseWarpEnd)
---+---+--- W - Warp NW Sector (Key_mouseWarpNW)
A S | D | F G E - Warp N Sector (Key_mouseWarpN)
---+---+--- R - Warp NE Sector (Key_mouseWarpNE)
X | C | V B S - Warp E Sector (Key_mouseWarpE)
D - Warp/Zoom Center (Key_mouseWarpIn)
F - Warp W Sector (Key_mouseWarpW)
K - Warp SE Sector (Key_mouseWarpSE)
C - Warp S Sector (Key_mouseWarpS)
V - Warp SW Sector (Key_mouseWarpSW)
T - Right Click (Key_mouseBtnR)
G - Left Click (Key_mouseBtnL)
B - Middle Click (Key_mouseBtnM)
This example layout replaces the default directional mouse keys and sets the
warp keys in a comfortable position for a warp-only configuration. Of course,
a Kaleidoscope user may retain the directional keys and map the warp keys
elsewhere according to his or her liking.
A 3x3 warp grid layout contains all of the keys from the 2x2 grid layout with
the following additions:
* `Key_mouseWarpN` , `Key_mouseWarpE` , `Key_mouseWarpS` , `Key_mouseWarpW` :
Warp towards the north, east, south, and west sectors, respectively.
* `Key_mouseWarpIn` : Warp to the center sector of the grid. The plugin will
continue to "zoom" into center of the current cell with each consecutive
press of this key.
## Plugin methods
The plugin provides a `MouseKeys` object, with the following methods and
@ -137,3 +241,8 @@ properties available:
> scrolling speed. The former, `.wheelSpeed` , controls the amount of ticks the
> wheel shall scroll, and defaults to 1. The second, `.wheelDelay` , controls the
> delay between two scroll events, and defaults to 50 milliseconds.
### `.setWarpGridSize`
> This method changes the size of the grid used for [warping ](#warping ). The
> following are valid sizes: `MOUSE_WARP_GRID_2X2` , `MOUSE_WARP_GRID_3X3`
Cy Rossignol
7 years ago