Skip to content

Commit

Permalink
Updated first gesture setup to use hold instead of tap due to issues
Browse files Browse the repository at this point in the history
  • Loading branch information
Mrcubix committed May 5, 2024
1 parent 2d62f5e commit f1574b1
Show file tree
Hide file tree
Showing 11 changed files with 130 additions and 2 deletions.
128 changes: 128 additions & 0 deletions getting_started/hold_setup_gesture.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# Setting up a new Gesture

We will now set up a new gesture. Let's start with by clicking the `Setup a new Gesture` button.
(or the `+` button in the top right corner)

```{figure} img/gesture_selection_screen.png
:alt: Gesture Selection Screen
:width: 100%
```

Here you will see a list of all the gestures that are available to set up. \
You can search for a specific gesture by typing in the search bar at the top.

## Setting up a simple Tap Gesture

```{warning}
Some users reported the gesture dedicated for taps, named `Tap`, is not working reliably. \
As a result, i have decided to now use the hold gesture (with low threshold) as a replacement for the tap gesture in the guide,
as it works more reliably and will suit most use cases better.
```

For this example, we will set up the most basic gesture, a single touch **Hold**. \
A **Hold** will keep a specified Binding pressed until the specified amount of fingers are lifted.

```{note}
A Binding is a key, mouse button, or any actions that may be triggered by another plugin.
```

Click on the **Hold** gesture to proceed.

### Options

```{figure} img/hold_setup_screen_options.png
:alt: Hold Setup Screen (Options Part)
:width: 100%
```

You are now on the first part of the setup screen. Here you can configure the option for the **Tap** gesture. \
The option in question for this gesture is the number of touches required to trigger the gesture.

```{figure} img/hold_setup_screen_options_dropdown.png
:alt: Hold Setup Screen (Options Part - Dropdown)
:align: center
```

Let's keep this number at `1` for now. \
Click on the `Next` button to proceed.

### Binding

```{figure} img/hold_setup_screen_binding.png
:alt: Hold Setup Screen (Binding Part)
:width: 100%
```

You are now on the second part of the setup screen. \
Here you can configure the Binding that will be triggered by the **Tap** gesture.

```{note}
A Binding is a key, mouse button, or any actions that may be triggered by another plugin.
```

This interface should be familiar to you if you have used OpenTabletDriver before:
The large button will open the simple binding editor,
while the small button containing `...` will open the advanced binding editor.

For this example, we will use the simple binding editor. \
Click on the large button to proceed.

```{figure} img/binding_editor_simple.png
:alt: Simple Binding Editor
:align: center
```

Here you can press most keys on your keyboard, or click on the mouse buttons to select them. \
For this example, let's left click within the white outlined area. \
Once that's done, the window will close, and the Binding will appear in the Binding Display.

```{figure} img/hold_setup_screen_binding_set.png
:alt: Hold Setup Screen (Binding Part - Set)
```

Let's proceed with the final part of the setup by clicking on `Next` again.

### Boundaries & Additional Tweaks

```{figure} img/hold_setup_screen_tweaks.png
:alt: Hold Setup Screen (Tweaks Part)
:width: 100%
```

You are now on the final part of the setup screen. \
Here you can configure the boundaries and additional tweaks for the **Tap** gesture.

Again, if you have used OpenTabletDriver before, you have probably setup your area in a specific way. \
Here however, it is slightly different, as a gesture may only be trigerred if it is started within the specified area.

```{warning}
The boundaries size must be non-zero.
```

let's keep it at the default values for now and focus on the only available tweak for this gesture: \
The `Deadline` tweak.

If you hover your cursor over the tweak, you will see a tooltip explaining what it does. \
In this case, the `Deadline` represents the amount of time within which the gesture must be completed. \
This include the you put your finger down, until it is lifted up again.

80ms is the default value, but you can change it to your liking.

```{note}
This value was chosen as it was the average accross all Wacom CTH-xxx & PTH-x51 tablets.
```

When you are done, click on the `Complete` button to finish the setup.

```{figure} img/hold_gesture_overview_new.png
:alt: Gesture Overview - New Gesture Added
:width: 100%
```

Congratulations! You have successfully set up a new **Tap** gesture.

```{tip}
You may choose to save your configuration by clicking on the `Save` button in the bottom right corner.
```

We will now move on to the next step: Editing an existing Gesture.
Binary file modified getting_started/img/gesture_overview_screen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added getting_started/img/hold_gesture_overview_new.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added getting_started/img/hold_setup_screen_binding.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added getting_started/img/hold_setup_screen_options.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added getting_started/img/hold_setup_screen_tweaks.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion getting_started/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ you should be able to start adding new gestures & tweaking them. \

running_ux
gestures_overview
setup_gesture
hold_setup_gesture
editing_gestures
deleting_gestures
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ This value was chosen as it was the average accross all Wacom CTH-xxx & PTH-x51

When you are done, click on the `Complete` button to finish the setup.

```{figure} img/gesture_overview_new.png
```{figure} img/tap_gesture_overview_new.png
:alt: Gesture Overview - New Gesture Added
:width: 100%
```
Expand Down

0 comments on commit f1574b1

Please sign in to comment.