fl_scrolling_manager.h File Reference

#include <gdk/gdk.h>
#include "flutter/shell/platform/embedder/embedder.h"
#include "flutter/shell/platform/linux/public/flutter_linux/fl_engine.h"

Go to the source code of this file.

Functions
G_BEGIN_DECLS	G_DECLARE_FINAL_TYPE (FlScrollingManager, fl_scrolling_manager, FL, SCROLLING_MANAGER, GObject)
FlScrollingManager *	fl_scrolling_manager_new (FlEngine *engine, FlutterViewId view_id)
void	fl_scrolling_manager_set_last_mouse_position (FlScrollingManager *manager, gdouble x, gdouble y)
void	fl_scrolling_manager_handle_scroll_event (FlScrollingManager *manager, GdkEventScroll *event, gint scale_factor)
void	fl_scrolling_manager_handle_rotation_begin (FlScrollingManager *manager)
void	fl_scrolling_manager_handle_rotation_update (FlScrollingManager *manager, gdouble rotation)
void	fl_scrolling_manager_handle_rotation_end (FlScrollingManager *manager)
void	fl_scrolling_manager_handle_zoom_begin (FlScrollingManager *manager)
void	fl_scrolling_manager_handle_zoom_update (FlScrollingManager *manager, gdouble scale)
void	fl_scrolling_manager_handle_zoom_end (FlScrollingManager *manager)

Function Documentation

fl_scrolling_manager_handle_rotation_begin()

void fl_scrolling_manager_handle_rotation_begin

(

FlScrollingManager *

manager

)

fl_scrolling_manager_handle_rotation_begin: @manager: an #FlScrollingManager.

Inform the scrolling manager that a rotation gesture has begun.

Definition at line 153 of file fl_scrolling_manager.cc.

                                                                          {
  g_return_if_fail(FL_IS_SCROLLING_MANAGER(self));
 
  g_autoptr(FlEngine) engine = FL_ENGINE(g_weak_ref_get(&self->engine));
  if (engine == nullptr) {
    return;
  }
 
  self->rotate_started = TRUE;
  if (!self->zoom_started) {
    self->scale = 1;
    self->rotation = 0;
    fl_engine_send_pointer_pan_zoom_event(
        engine, self->view_id, g_get_real_time(), self->last_x, self->last_y,
        kPanZoomStart, 0, 0, 0, 0);
  }
}

References fl_engine_send_pointer_pan_zoom_event(), and TRUE.

Referenced by gesture_rotation_begin_cb(), and TEST().

fl_scrolling_manager_handle_rotation_end()

void fl_scrolling_manager_handle_rotation_end

(

FlScrollingManager *

manager

)

fl_scrolling_manager_handle_rotation_end: @manager: an #FlScrollingManager.

Inform the scrolling manager that a rotation gesture has ended.

Definition at line 186 of file fl_scrolling_manager.cc.

                                                                        {
  g_return_if_fail(FL_IS_SCROLLING_MANAGER(self));
 
  g_autoptr(FlEngine) engine = FL_ENGINE(g_weak_ref_get(&self->engine));
  if (engine == nullptr) {
    return;
  }
 
  self->rotate_started = FALSE;
  if (!self->zoom_started) {
    fl_engine_send_pointer_pan_zoom_event(
        engine, self->view_id, g_get_real_time(), self->last_x, self->last_y,
        kPanZoomEnd, 0, 0, 0, 0);
  }
}

References fl_engine_send_pointer_pan_zoom_event().

Referenced by gesture_rotation_end_cb(), and TEST().

fl_scrolling_manager_handle_rotation_update()

void fl_scrolling_manager_handle_rotation_update	(	FlScrollingManager *	manager,
		gdouble	rotation
	)

fl_scrolling_manager_handle_rotation_update: @manager: an #FlScrollingManager. @rotation: the rotation angle, in radians.

Inform the scrolling manager that a rotation gesture has updated.

Definition at line 171 of file fl_scrolling_manager.cc.

                                                                   {
  g_return_if_fail(FL_IS_SCROLLING_MANAGER(self));
 
  g_autoptr(FlEngine) engine = FL_ENGINE(g_weak_ref_get(&self->engine));
  if (engine == nullptr) {
    return;
  }
 
  self->rotation = rotation;
  fl_engine_send_pointer_pan_zoom_event(
      engine, self->view_id, g_get_real_time(), self->last_x, self->last_y,
      kPanZoomUpdate, 0, 0, self->scale, self->rotation);
}

References fl_engine_send_pointer_pan_zoom_event().

Referenced by gesture_rotation_update_cb(), and TEST().

fl_scrolling_manager_handle_scroll_event()

void fl_scrolling_manager_handle_scroll_event	(	FlScrollingManager *	manager,
		GdkEventScroll *	event,
		gint	scale_factor
	)

fl_scrolling_manager_handle_scroll_event: @manager: an #FlScrollingManager. @event: the scroll event. @scale_factor: the GTK scaling factor of the window.

Inform the scrolling manager of a scroll event.

Definition at line 71 of file fl_scrolling_manager.cc.

                                                                 {
  g_return_if_fail(FL_IS_SCROLLING_MANAGER(self));
 
  g_autoptr(FlEngine) engine = FL_ENGINE(g_weak_ref_get(&self->engine));
  if (engine == nullptr) {
    return;
  }
 
  GdkEvent* event = reinterpret_cast<GdkEvent*>(scroll_event);
 
  guint event_time = gdk_event_get_time(event);
  gdouble event_x = 0.0, event_y = 0.0;
  gdk_event_get_coords(event, &event_x, &event_y);
  gdouble scroll_delta_x = 0.0, scroll_delta_y = 0.0;
  GdkScrollDirection event_direction = GDK_SCROLL_SMOOTH;
  if (gdk_event_get_scroll_direction(event, &event_direction)) {
    if (event_direction == GDK_SCROLL_UP) {
      scroll_delta_x = 0;
      scroll_delta_y = -1;
    } else if (event_direction == GDK_SCROLL_DOWN) {
      scroll_delta_x = 0;
      scroll_delta_y = 1;
    } else if (event_direction == GDK_SCROLL_LEFT) {
      scroll_delta_x = -1;
      scroll_delta_y = 0;
    } else if (event_direction == GDK_SCROLL_RIGHT) {
      scroll_delta_x = 1;
      scroll_delta_y = 0;
    }
  } else {
    gdk_event_get_scroll_deltas(event, &scroll_delta_x, &scroll_delta_y);
  }
 
  // The multiplier is taken from the Chromium source
  // (ui/events/x/events_x_utils.cc).
  const int kScrollOffsetMultiplier = 53;
  scroll_delta_x *= kScrollOffsetMultiplier * scale_factor;
  scroll_delta_y *= kScrollOffsetMultiplier * scale_factor;
 
  if (gdk_device_get_source(gdk_event_get_source_device(event)) ==
      GDK_SOURCE_TOUCHPAD) {
    scroll_delta_x *= -1;
    scroll_delta_y *= -1;
    if (gdk_event_is_scroll_stop_event(event)) {
      fl_engine_send_pointer_pan_zoom_event(
          engine, self->view_id, event_time * kMicrosecondsPerMillisecond,
          event_x * scale_factor, event_y * scale_factor, kPanZoomEnd,
          self->pan_x, self->pan_y, 0, 0);
      self->pan_started = FALSE;
    } else {
      if (!self->pan_started) {
        self->pan_x = 0;
        self->pan_y = 0;
        fl_engine_send_pointer_pan_zoom_event(
            engine, self->view_id, event_time * kMicrosecondsPerMillisecond,
            event_x * scale_factor, event_y * scale_factor, kPanZoomStart, 0, 0,
            0, 0);
        self->pan_started = TRUE;
      }
      self->pan_x += scroll_delta_x;
      self->pan_y += scroll_delta_y;
      fl_engine_send_pointer_pan_zoom_event(
          engine, self->view_id, event_time * kMicrosecondsPerMillisecond,
          event_x * scale_factor, event_y * scale_factor, kPanZoomUpdate,
          self->pan_x, self->pan_y, 1, 0);
    }
  } else {
    self->last_x = event_x * scale_factor;
    self->last_y = event_y * scale_factor;
    fl_engine_send_mouse_pointer_event(
        engine, self->view_id,
        FlutterPointerPhase::kMove /* arbitrary value, phase will be ignored as
                                      this is a discrete scroll event */
        ,
        event_time * kMicrosecondsPerMillisecond, event_x * scale_factor,
        event_y * scale_factor, kFlutterPointerDeviceKindMouse, scroll_delta_x,
        scroll_delta_y, 0);
  }
}

References fl_engine_send_mouse_pointer_event(), fl_engine_send_pointer_pan_zoom_event(), kMicrosecondsPerMillisecond, and TRUE.

Referenced by scroll_event_cb(), and TEST().

fl_scrolling_manager_handle_zoom_begin()

void fl_scrolling_manager_handle_zoom_begin

(

FlScrollingManager *

manager

)

fl_scrolling_manager_handle_zoom_begin: @manager: an #FlScrollingManager.

Inform the scrolling manager that a zoom gesture has begun.

Definition at line 202 of file fl_scrolling_manager.cc.

                                                                      {
  g_return_if_fail(FL_IS_SCROLLING_MANAGER(self));
 
  g_autoptr(FlEngine) engine = FL_ENGINE(g_weak_ref_get(&self->engine));
  if (engine == nullptr) {
    return;
  }
 
  self->zoom_started = TRUE;
  if (!self->rotate_started) {
    self->scale = 1;
    self->rotation = 0;
    fl_engine_send_pointer_pan_zoom_event(
        engine, self->view_id, g_get_real_time(), self->last_x, self->last_y,
        kPanZoomStart, 0, 0, 0, 0);
  }
}

References fl_engine_send_pointer_pan_zoom_event(), and TRUE.

Referenced by gesture_zoom_begin_cb(), and TEST().

fl_scrolling_manager_handle_zoom_end()

void fl_scrolling_manager_handle_zoom_end

(

FlScrollingManager *

manager

)

fl_scrolling_manager_handle_zoom_end: @manager: an #FlScrollingManager.

Inform the scrolling manager that a zoom gesture has ended.

Definition at line 235 of file fl_scrolling_manager.cc.

                                                                    {
  g_return_if_fail(FL_IS_SCROLLING_MANAGER(self));
 
  g_autoptr(FlEngine) engine = FL_ENGINE(g_weak_ref_get(&self->engine));
  if (engine == nullptr) {
    return;
  }
 
  self->zoom_started = FALSE;
  if (!self->rotate_started) {
    fl_engine_send_pointer_pan_zoom_event(
        engine, self->view_id, g_get_real_time(), self->last_x, self->last_y,
        kPanZoomEnd, 0, 0, 0, 0);
  }
}

References fl_engine_send_pointer_pan_zoom_event().

Referenced by gesture_zoom_end_cb(), and TEST().

fl_scrolling_manager_handle_zoom_update()

void fl_scrolling_manager_handle_zoom_update	(	FlScrollingManager *	manager,
		gdouble	scale
	)

fl_scrolling_manager_handle_zoom_update: @manager: an #FlScrollingManager. @scale: the zoom scale.

Inform the scrolling manager that a zoom gesture has updated.

Definition at line 220 of file fl_scrolling_manager.cc.

                                                            {
  g_return_if_fail(FL_IS_SCROLLING_MANAGER(self));
 
  g_autoptr(FlEngine) engine = FL_ENGINE(g_weak_ref_get(&self->engine));
  if (engine == nullptr) {
    return;
  }
 
  self->scale = scale;
  fl_engine_send_pointer_pan_zoom_event(
      engine, self->view_id, g_get_real_time(), self->last_x, self->last_y,
      kPanZoomUpdate, 0, 0, self->scale, self->rotation);
}

References fl_engine_send_pointer_pan_zoom_event().

Referenced by gesture_zoom_update_cb(), and TEST().

fl_scrolling_manager_new()

FlScrollingManager* fl_scrolling_manager_new	(	FlEngine *	engine,
		FlutterViewId	view_id
	)

fl_scrolling_manager_new: @engine: an #FlEngine. @view_id: the view being managed.

Create a new #FlScrollingManager.

Returns: a new #FlScrollingManager.

Definition at line 47 of file fl_scrolling_manager.cc.

                                                                    {
  g_return_val_if_fail(FL_IS_ENGINE(engine), nullptr);
 
  FlScrollingManager* self = FL_SCROLLING_MANAGER(
      g_object_new(fl_scrolling_manager_get_type(), nullptr));
 
  g_weak_ref_init(&self->engine, engine);
  self->view_id = view_id;
  self->pan_started = FALSE;
  self->zoom_started = FALSE;
  self->rotate_started = FALSE;
 
  return self;
}

Referenced by init_scrolling(), and TEST().

fl_scrolling_manager_set_last_mouse_position()

void fl_scrolling_manager_set_last_mouse_position	(	FlScrollingManager *	manager,
		gdouble	x,
		gdouble	y
	)

fl_scrolling_manager_set_last_mouse_position: @manager: an #FlScrollingManager. @x: the mouse x-position, in window coordinates. @y: the mouse y-position, in window coordinates.

Inform the scrolling manager of the mouse position. This position will be used when sending scroll pointer events.

Definition at line 63 of file fl_scrolling_manager.cc.

                                                             {
  g_return_if_fail(FL_IS_SCROLLING_MANAGER(self));
  self->last_x = x;
  self->last_y = y;
}

Referenced by set_scrolling_position().

G_DECLARE_FINAL_TYPE()

G_BEGIN_DECLS G_DECLARE_FINAL_TYPE	(	FlScrollingManager	,
		fl_scrolling_manager	,
		FL	,
		SCROLLING_MANAGER	,
		GObject
	)