deploy: 4561ce1

Mrcubix · Oct 4, 2024 · 5870bd4 · 5870bd4
commit 5870bd4
Show file tree

Hide file tree

Showing 110 changed files with 9,213 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: bdb135dc898c83314774b015b8dc5bf6
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/faq/basic.doctree b/.doctrees/faq/basic.doctree
diff --git a/.doctrees/faq/index.doctree b/.doctrees/faq/index.doctree
diff --git a/.doctrees/faq/troubleshooting.doctree b/.doctrees/faq/troubleshooting.doctree
diff --git a/.doctrees/getting_started/deleting_gestures.doctree b/.doctrees/getting_started/deleting_gestures.doctree
diff --git a/.doctrees/getting_started/editing_gestures.doctree b/.doctrees/getting_started/editing_gestures.doctree
diff --git a/.doctrees/getting_started/gestures_overview.doctree b/.doctrees/getting_started/gestures_overview.doctree
diff --git a/.doctrees/getting_started/hold_setup_gesture.doctree b/.doctrees/getting_started/hold_setup_gesture.doctree
diff --git a/.doctrees/getting_started/index.doctree b/.doctrees/getting_started/index.doctree
diff --git a/.doctrees/getting_started/running_ux.doctree b/.doctrees/getting_started/running_ux.doctree
diff --git a/.doctrees/getting_started/tap_setup_gesture.doctree b/.doctrees/getting_started/tap_setup_gesture.doctree
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/.doctrees/installation_guide/dependencies.doctree b/.doctrees/installation_guide/dependencies.doctree
diff --git a/.doctrees/installation_guide/index.doctree b/.doctrees/installation_guide/index.doctree
diff --git a/.doctrees/installation_guide/installation.doctree b/.doctrees/installation_guide/installation.doctree
diff --git a/.nojekyll b/.nojekyll
diff --git a/_images/binding_display_delete_highlighted.png b/_images/binding_display_delete_highlighted.png
diff --git a/_images/binding_display_edit_highlighted.png b/_images/binding_display_edit_highlighted.png
diff --git a/_images/binding_editor_simple.png b/_images/binding_editor_simple.png
diff --git a/_images/delete_gesture_confirmation_dialog.png b/_images/delete_gesture_confirmation_dialog.png
diff --git a/_images/gesture_overview_screen.png b/_images/gesture_overview_screen.png
diff --git a/_images/gesture_selection_screen.png b/_images/gesture_selection_screen.png
diff --git a/_images/hold_gesture_overview_new.png b/_images/hold_gesture_overview_new.png
diff --git a/_images/hold_setup_screen_binding.png b/_images/hold_setup_screen_binding.png
diff --git a/_images/hold_setup_screen_binding_set.png b/_images/hold_setup_screen_binding_set.png
diff --git a/_images/hold_setup_screen_options.png b/_images/hold_setup_screen_options.png
diff --git a/_images/hold_setup_screen_options_dropdown.png b/_images/hold_setup_screen_options_dropdown.png
diff --git a/_images/hold_setup_screen_tweaks.png b/_images/hold_setup_screen_tweaks.png
diff --git a/_images/tap_gesture_overview_new.png b/_images/tap_gesture_overview_new.png
diff --git a/_images/tap_setup_screen_binding.png b/_images/tap_setup_screen_binding.png
diff --git a/_images/tap_setup_screen_binding_set.png b/_images/tap_setup_screen_binding_set.png
diff --git a/_images/tap_setup_screen_options.png b/_images/tap_setup_screen_options.png
diff --git a/_images/tap_setup_screen_options_dropdown.png b/_images/tap_setup_screen_options_dropdown.png
diff --git a/_images/tap_setup_screen_tweaks.png b/_images/tap_setup_screen_tweaks.png
diff --git a/_sources/faq/basic.md.txt b/_sources/faq/basic.md.txt
@@ -0,0 +1,20 @@
+# Basic
+
+- Q: Can i prevent my cursor from moving when i use certain gestures?
+  - A: Not currently, it is possible to cancel inputs via plugins, but i'm not sure on how to obtain the best of both worlds.
+
+<br>
+
+- Q: Can i use this without a touch tablet?
+    - A: Not currently, however, i do think that being able to trigger single-touch gestures with just a pen would be a good idea
+         (Soft Keys comes to mind).
+
+<br>
+
+- Q: Can i specify which tablet to configure?
+    - A: You can change the configured tablet the same way as OpenTabletDriver 0.6,x, using a dropdown located at the bottom left of the interface.
+         It is however only available in the 0.6.x version as it's the only version that currently supports multiple tablets.
+
+<br>
+
+This section is still in construction, if you have any questions, feel free to ask them on the [Github Discussions](https://github.com/Mrcubix/Touch-Gestures/discussions)
diff --git a/_sources/faq/index.rst.txt b/_sources/faq/index.rst.txt
@@ -0,0 +1,10 @@
+.. _faq:
+
+Frequently Asked Questions
+==========================
+
+.. toctree:: 
+    :maxdepth: 1
+
+    basic
+    troubleshooting
diff --git a/_sources/faq/troubleshooting.md.txt b/_sources/faq/troubleshooting.md.txt
@@ -0,0 +1,19 @@
+# Troubleshooting
+
+- Q: The Plugin does not seem to work.
+    - A: Make sure that you have followed the installation guide carefully, and that you have the correct dependencies installed. \
+         If the plugin has initialized properly, you should see any of the following lines in OpenTabletDriver's console:
+         ```log
+         [Touch Gestures Daemon:Info] Initialized
+         [Touch Gestures:Info] Now handling touch gesture for: Wacom CTH-470
+         ```
+         At that point you should also be able to trigger the gestures you have set up & you the interface should be able to connect to the plugin.
+
+<br>
+
+- Q: The driver does not seem to go past 'Waiting for debugger to attach...' in the console.
+    - A: Oops, i may have forgot to set the build configuration to Release instead of Debug, let me know on github if this is the case.
+
+<br>
+
+This section is still in construction, if you have any questions, feel free to ask them on the [Github Discussions](https://github.com/Mrcubix/Touch-Gestures/discussions)
diff --git a/_sources/getting_started/deleting_gestures.md.txt b/_sources/getting_started/deleting_gestures.md.txt
@@ -0,0 +1,21 @@
+# Deleting a Gestures
+
+To delete a gesture, you can click the red `-` button on the right most side of a gesture.
+
+```{figure} img/binding_display_delete_highlighted.png
+:alt: Binding Display (Delete Highlighted)
+:width: 100%
+```
+
+Once you have clicked it, a confirmation dialog will appear. Choose `Yes` to delete the gesture, or `No` to cancel the deletion.
+
+```{figure} img/delete_gesture_confirmation_dialog.png
+:alt: Delete Gesture Confirmation Dialog
+:align: center
+```
+
+If you have removed a gesture by accident, and have not yet clicked on the `Save` button, you can restart the application to restore the deleted gesture.
+
+%```{note}
+%There are plans to add an undo feature for deletions in the future.
+%```
diff --git a/_sources/getting_started/editing_gestures.md.txt b/_sources/getting_started/editing_gestures.md.txt
@@ -0,0 +1,22 @@
+# Editing an existing Gesture
+
+Now that you have set up a gesture, you may want to edit it. \
+If you only want to change the binding, you can do so without clicking on the `Edit` button, \
+using the same means as in OpenTabletDriver.
+
+Otherwise, you might want to for instance change the options or the tweaks of the gesture.
+In this case, you will need to click on the `Edit` button.
+
+```{figure} img/binding_display_edit_highlighted.png
+:alt: Binding Display (Edit Highlighted)
+:width: 100%
+```
+
+After clicking on the `Edit` button, you will be taken to the setup screen of the gesture. \
+From there, you can proceed to change settings as if you were setting up a new gesture.
+To cancel the editing process, click on the `Cancel` button.
+
+```{figure} img/tap_setup_screen_options.png
+:alt: Tap Setup Screen (Options Part)
+:width: 100%
+```
diff --git a/_sources/getting_started/gestures_overview.md.txt b/_sources/getting_started/gestures_overview.md.txt
@@ -0,0 +1,20 @@
+# Gestures Overview
+
+Once the UX has started & it has connected successfully to the plugin, you will see the following screen:
+
+```{figure} img/gesture_overview_screen.png
+:alt: Binding Overview
+:width: 100%
+```
+
+This page contains an overview of all the gesture you will have set up. \
+Currently, there are no gestures set up, so the application will let you know as above.
+
+The `+` button in the top right corner will allow you to add a new gesture. \
+The Search bar at the top will allow you to search for a specific gesture once you have some set up. \
+The `Save` button in the bottom right corner will allow you to save your current configuration.
+
+Most elements of this application have a tooltip that will appear when you hover over them, \
+so do not hesitate to hover over an element if you are unsure of what it does.
+
+Since there are no gestures set up, let's proceed with adding a new gesture in the next section.
diff --git a/_sources/getting_started/hold_setup_gesture.md.txt b/_sources/getting_started/hold_setup_gesture.md.txt
@@ -0,0 +1,130 @@
+# 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 **Hold** 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 **Hold** 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 **Hold** 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 available tweaks for this gesture: \
+The `Hold For` & `Threshold` tweak.
+
+If you hover your cursor over the tweak, you will see a tooltip explaining what it does.
+
+In this case, the `Hold For` represents the amount of time the specified number of fingers need to be held in place for the gesture to be triggered.
+After this time has passed, the binding will be pressed, and will only be released once all the fingers are lifted.
+
+1000ms is the default value, but in our case, we wan't to reproduce a tap, so we will set it to 80ms. \
+you may 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 **Hold** 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.
diff --git a/_sources/getting_started/index.rst.txt b/_sources/getting_started/index.rst.txt
@@ -0,0 +1,18 @@
+.. _getting_started:
+
+Getting Started
+===============
+
+Now that you have installed the plugin, Downloaded the Interface & made sure that it connects properly to the plugin, 
+you should be able to start adding new gestures & tweaking them. \
+
+(If you didn't follow the installation guide, it doesn't work & you complain on github, i will find you.)
+
+.. toctree:: 
+    :maxdepth: 1
+
+    running_ux
+    gestures_overview
+    hold_setup_gesture
+    editing_gestures
+    deleting_gestures
diff --git a/_sources/getting_started/running_ux.md.txt b/_sources/getting_started/running_ux.md.txt
@@ -0,0 +1,7 @@
+# Running the UX
+
+Make sure that you have completed the [](../installation_guide/installation.md) steps before running the UX. \
+The plugin is required to be enabled beforehand for the UX to be able to communicate with it.
+
+Open the Interface Application that you downloaded during [](../installation_guide/installation.md).
+Once that's done and it has connected successfully to the daemon, you may proceed to the next section of the guide.