gtk2/gtk/gtkgesturestylus.c
Carlos Garnacho cf20cfd31e gtk/gesturestylus: Convert motion history from surface coordinates
Motion history coordinates are based on GdkSurface coordinates. Transform
the coordinates from the GtkNative they are received on, accounting for the
possible transforms (e.g. due to window borders and shadows).

Fixes: https://gitlab.gnome.org/GNOME/gtk/-/issues/3491
2020-12-24 19:59:51 +01:00

395 lines
12 KiB
C

/* GTK - The GIMP Toolkit
* Copyright (C) 2017-2018, Red Hat, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*
* Author(s): Carlos Garnacho <carlosg@gnome.org>
*/
/**
* SECTION:gtkgesturestylus
* @Short_description: Gesture for stylus input
* @Title: GtkGestureStylus
* @See_also: #GtkGesture, #GtkGestureSingle
*
* #GtkGestureStylus is a #GtkGesture implementation specific to stylus
* input. The provided signals just relay the basic information of the
* stylus events.
*/
#include "config.h"
#include "gtkgesturestylus.h"
#include "gtkgesturestylusprivate.h"
#include "gtkprivate.h"
#include "gtkintl.h"
#include "gtkmarshalers.h"
#include "gtkmain.h"
#include "gtknative.h"
G_DEFINE_TYPE (GtkGestureStylus, gtk_gesture_stylus, GTK_TYPE_GESTURE_SINGLE)
enum {
PROXIMITY,
DOWN,
MOTION,
UP,
N_SIGNALS
};
static guint signals[N_SIGNALS] = { 0, };
static gboolean
gtk_gesture_stylus_handle_event (GtkEventController *controller,
GdkEvent *event,
double x,
double y)
{
GdkModifierType modifiers;
guint n_signal;
GTK_EVENT_CONTROLLER_CLASS (gtk_gesture_stylus_parent_class)->handle_event (controller, event, x, y);
if (!gdk_event_get_device_tool (event))
return FALSE;
switch ((guint) gdk_event_get_event_type (event))
{
case GDK_BUTTON_PRESS:
n_signal = DOWN;
break;
case GDK_BUTTON_RELEASE:
n_signal = UP;
break;
case GDK_MOTION_NOTIFY:
modifiers = gdk_event_get_modifier_state (event);
if (modifiers & GDK_BUTTON1_MASK)
n_signal = MOTION;
else
n_signal = PROXIMITY;
break;
default:
return FALSE;
}
g_signal_emit (controller, signals[n_signal], 0, x, y);
return TRUE;
}
static void
gtk_gesture_stylus_class_init (GtkGestureStylusClass *klass)
{
GtkEventControllerClass *event_controller_class;
event_controller_class = GTK_EVENT_CONTROLLER_CLASS (klass);
event_controller_class->handle_event = gtk_gesture_stylus_handle_event;
/**
* GtkGestureStylus::proximity:
* @gesture: the #GtkGestureStylus that emitted the signal
* @x: the X coordinate of the stylus event
* @y: the Y coordinate of the stylus event
*
* A signal emitted when the stylus is in proximity of the device.
*/
signals[PROXIMITY] =
g_signal_new (I_("proximity"),
G_TYPE_FROM_CLASS (klass),
G_SIGNAL_RUN_LAST,
G_STRUCT_OFFSET (GtkGestureStylusClass, proximity),
NULL, NULL,
_gtk_marshal_VOID__DOUBLE_DOUBLE,
G_TYPE_NONE, 2, G_TYPE_DOUBLE, G_TYPE_DOUBLE);
g_signal_set_va_marshaller (signals[PROXIMITY],
G_TYPE_FROM_CLASS (klass),
_gtk_marshal_VOID__DOUBLE_DOUBLEv);
/**
* GtkGestureStylus::down:
* @gesture: the #GtkGestureStylus that emitted the signal
* @x: the X coordinate of the stylus event
* @y: the Y coordinate of the stylus event
*
* A signal emitted when the stylus touches the device.
*/
signals[DOWN] =
g_signal_new (I_("down"),
G_TYPE_FROM_CLASS (klass),
G_SIGNAL_RUN_LAST,
G_STRUCT_OFFSET (GtkGestureStylusClass, down),
NULL, NULL,
_gtk_marshal_VOID__DOUBLE_DOUBLE,
G_TYPE_NONE, 2, G_TYPE_DOUBLE, G_TYPE_DOUBLE);
g_signal_set_va_marshaller (signals[DOWN],
G_TYPE_FROM_CLASS (klass),
_gtk_marshal_VOID__DOUBLE_DOUBLEv);
/**
* GtkGestureStylus::motion:
* @gesture: the #GtkGestureStylus that emitted the signal
* @x: the X coordinate of the stylus event
* @y: the Y coordinate of the stylus event
*
* A signal emitted when the stylus moves while touching the device.
*/
signals[MOTION] =
g_signal_new (I_("motion"),
G_TYPE_FROM_CLASS (klass),
G_SIGNAL_RUN_LAST,
G_STRUCT_OFFSET (GtkGestureStylusClass, motion),
NULL, NULL,
_gtk_marshal_VOID__DOUBLE_DOUBLE,
G_TYPE_NONE, 2, G_TYPE_DOUBLE, G_TYPE_DOUBLE);
g_signal_set_va_marshaller (signals[MOTION],
G_TYPE_FROM_CLASS (klass),
_gtk_marshal_VOID__DOUBLE_DOUBLEv);
/**
* GtkGestureStylus::up:
* @gesture: the #GtkGestureStylus that emitted the signal
* @x: the X coordinate of the stylus event
* @y: the Y coordinate of the stylus event
*
* A signal emitted when the stylus no longer touches the device.
*/
signals[UP] =
g_signal_new (I_("up"),
G_TYPE_FROM_CLASS (klass),
G_SIGNAL_RUN_LAST,
G_STRUCT_OFFSET (GtkGestureStylusClass, up),
NULL, NULL,
_gtk_marshal_VOID__DOUBLE_DOUBLE,
G_TYPE_NONE, 2, G_TYPE_DOUBLE, G_TYPE_DOUBLE);
g_signal_set_va_marshaller (signals[UP],
G_TYPE_FROM_CLASS (klass),
_gtk_marshal_VOID__DOUBLE_DOUBLEv);
}
static void
gtk_gesture_stylus_init (GtkGestureStylus *gesture)
{
}
/**
* gtk_gesture_stylus_new:
*
* Creates a new #GtkGestureStylus.
*
* Returns: a newly created stylus gesture
**/
GtkGesture *
gtk_gesture_stylus_new (void)
{
return g_object_new (GTK_TYPE_GESTURE_STYLUS,
NULL);
}
static GdkEvent *
gesture_get_current_event (GtkGestureStylus *gesture)
{
GdkEventSequence *sequence;
sequence = gtk_gesture_single_get_current_sequence (GTK_GESTURE_SINGLE (gesture));
return gtk_gesture_get_last_event (GTK_GESTURE (gesture), sequence);
}
/**
* gtk_gesture_stylus_get_axis:
* @gesture: a #GtkGestureStylus
* @axis: requested device axis
* @value: (out): return location for the axis value
*
* Returns the current value for the requested @axis.
*
* This function must be called from the handler of one of the
* #GtkGestureStylus::down, #GtkGestureStylus::motion,
* #GtkGestureStylus::up or #GtkGestureStylus::proximity signals.
*
* Returns: %TRUE if there is a current value for the axis
**/
gboolean
gtk_gesture_stylus_get_axis (GtkGestureStylus *gesture,
GdkAxisUse axis,
double *value)
{
GdkEvent *event;
g_return_val_if_fail (GTK_IS_GESTURE_STYLUS (gesture), FALSE);
g_return_val_if_fail (axis < GDK_AXIS_LAST, FALSE);
g_return_val_if_fail (value != NULL, FALSE);
event = gesture_get_current_event (gesture);
if (!event)
return FALSE;
return gdk_event_get_axis (event, axis, value);
}
/**
* gtk_gesture_stylus_get_axes:
* @gesture: a GtkGestureStylus
* @axes: (array): array of requested axes, terminated with #GDK_AXIS_IGNORE
* @values: (out) (array): return location for the axis values
*
* Returns the current values for the requested @axes. This function
* must be called from either the #GtkGestureStylus::down,
* #GtkGestureStylus::motion, #GtkGestureStylus::up or #GtkGestureStylus::proximity
* signals.
*
* Returns: %TRUE if there is a current value for the axes
**/
gboolean
gtk_gesture_stylus_get_axes (GtkGestureStylus *gesture,
GdkAxisUse axes[],
double **values)
{
GdkEvent *event;
GArray *array;
int i = 0;
g_return_val_if_fail (GTK_IS_GESTURE_STYLUS (gesture), FALSE);
g_return_val_if_fail (values != NULL, FALSE);
event = gesture_get_current_event (gesture);
if (!event)
return FALSE;
array = g_array_new (TRUE, FALSE, sizeof (double));
while (axes[i] != GDK_AXIS_IGNORE)
{
double value;
if (axes[i] >= GDK_AXIS_LAST)
{
g_warning ("Requesting unknown axis %d, did you "
"forget to add a last GDK_AXIS_IGNORE axis?",
axes[i]);
g_array_free (array, TRUE);
return FALSE;
}
gdk_event_get_axis (event, axes[i], &value);
g_array_append_val (array, value);
i++;
}
*values = (double *) g_array_free (array, FALSE);
return TRUE;
}
/**
* gtk_gesture_stylus_get_backlog:
* @gesture: a #GtkGestureStylus
* @backlog: (out) (array length=n_elems): coordinates and times for the backlog events
* @n_elems: (out): return location for the number of elements
*
* By default, GTK will limit rate of input events. On stylus input where
* accuracy of strokes is paramount, this function returns the accumulated
* coordinate/timing state before the emission of the current
* #GtkGestureStylus::motion signal.
*
* This function may only be called within a #GtkGestureStylus::motion
* signal handler, the state given in this signal and obtainable through
* gtk_gesture_stylus_get_axis() call express the latest (most up-to-date)
* state in motion history.
*
* The @backlog is provided in chronological order.
*
* Returns: %TRUE if there is a backlog to unfold in the current state.
**/
gboolean
gtk_gesture_stylus_get_backlog (GtkGestureStylus *gesture,
GdkTimeCoord **backlog,
guint *n_elems)
{
GdkEvent *event;
GArray *backlog_array;
GdkTimeCoord *history = NULL;
guint n_coords = 0, i;
double surf_x, surf_y;
GtkNative *native;
g_return_val_if_fail (GTK_IS_GESTURE_STYLUS (gesture), FALSE);
g_return_val_if_fail (backlog != NULL && n_elems != NULL, FALSE);
event = gesture_get_current_event (gesture);
if (event && GDK_IS_EVENT_TYPE (event, GDK_MOTION_NOTIFY))
history = gdk_event_get_history (event, &n_coords);
if (!history)
return FALSE;
native = gtk_widget_get_native (gtk_get_event_widget (event));
gtk_native_get_surface_transform (native, &surf_x, &surf_y);
backlog_array = g_array_new (FALSE, FALSE, sizeof (GdkTimeCoord));
for (i = 0; i < n_coords; i++)
{
GdkTimeCoord *time_coord = &history[i];
graphene_point_t p;
g_array_append_val (backlog_array, *time_coord);
time_coord = &g_array_index (backlog_array, GdkTimeCoord, backlog_array->len - 1);
if (gtk_widget_compute_point (GTK_WIDGET (native),
gtk_event_controller_get_widget (GTK_EVENT_CONTROLLER (gesture)),
&GRAPHENE_POINT_INIT (time_coord->axes[GDK_AXIS_X] - surf_x,
time_coord->axes[GDK_AXIS_Y] - surf_y),
&p))
{
time_coord->axes[GDK_AXIS_X] = p.x;
time_coord->axes[GDK_AXIS_Y] = p.y;
}
else
{
g_array_set_size (backlog_array, backlog_array->len - 1);
}
}
*n_elems = backlog_array->len;
*backlog = (GdkTimeCoord *) g_array_free (backlog_array, FALSE);
g_free (history);
return TRUE;
}
/**
* gtk_gesture_stylus_get_device_tool:
* @gesture: a #GtkGestureStylus
*
* Returns the #GdkDeviceTool currently driving input through this gesture.
* This function must be called from either the #GtkGestureStylus::down,
* #GtkGestureStylus::motion, #GtkGestureStylus::up or #GtkGestureStylus::proximity
* signal handlers.
*
* Returns: (nullable) (transfer none): The current stylus tool
**/
GdkDeviceTool *
gtk_gesture_stylus_get_device_tool (GtkGestureStylus *gesture)
{
GdkEvent *event;
g_return_val_if_fail (GTK_IS_GESTURE_STYLUS (gesture), FALSE);
event = gesture_get_current_event (gesture);
if (!event)
return NULL;
return gdk_event_get_device_tool (event);
}