wm_gesture_ops.cc

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2007 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

#include "MEM_guardedalloc.h"
 
#include <fmt/format.h>
 
#include <algorithm>
 
#include "DNA_space_types.h"
#include "DNA_windowmanager_types.h"
 
#include "BLI_math_rotation.h"
#include "BLI_math_vector.h"
#include "BLI_math_vector.hh"
#include "BLI_math_vector_types.hh"
#include "BLI_rect.h"
 
#include "BKE_context.hh"
 
#include "WM_api.hh"
#include "WM_types.hh"
 
#include "wm.hh"
#include "wm_event_types.hh"
 
#include "ED_screen.hh"
#include "ED_select_utils.hh"
 
#include "RNA_access.hh"
 
using blender::Array;
using blender::float2;
using blender::int2;
 
/* -------------------------------------------------------------------- */
 
static void gesture_modal_end(bContext *C, wmOperator *op)
{
  wmWindow *win = CTX_wm_window(C);
  wmGesture *gesture = static_cast<wmGesture *>(op->customdata);
 
  WM_gesture_end(win, gesture); /* Frees gesture itself, and unregisters from window. */
  op->customdata = nullptr;
 
  ED_area_tag_redraw(CTX_wm_area(C));
 
  if (RNA_struct_find_property(op->ptr, "cursor")) {
    WM_cursor_modal_restore(win);
  }
}
 
static void gesture_modal_state_to_operator(wmOperator *op, int modal_state)
{
  PropertyRNA *prop;
 
  switch (modal_state) {
    case GESTURE_MODAL_SELECT:
    case GESTURE_MODAL_DESELECT:
      if ((prop = RNA_struct_find_property(op->ptr, "deselect"))) {
        RNA_property_boolean_set(op->ptr, prop, (modal_state == GESTURE_MODAL_DESELECT));
      }
      if ((prop = RNA_struct_find_property(op->ptr, "mode"))) {
        RNA_property_enum_set(
            op->ptr, prop, (modal_state == GESTURE_MODAL_DESELECT) ? SEL_OP_SUB : SEL_OP_ADD);
      }
      break;
    case GESTURE_MODAL_IN:
    case GESTURE_MODAL_OUT:
      if ((prop = RNA_struct_find_property(op->ptr, "zoom_out"))) {
        RNA_property_boolean_set(op->ptr, prop, (modal_state == GESTURE_MODAL_OUT));
      }
      break;
  }
}
 
static int UNUSED_FUNCTION(gesture_modal_state_from_operator)(wmOperator *op)
{
  PropertyRNA *prop;
 
  if ((prop = RNA_struct_find_property(op->ptr, "deselect"))) {
    if (RNA_property_is_set(op->ptr, prop)) {
      return RNA_property_boolean_get(op->ptr, prop) ? GESTURE_MODAL_DESELECT :
                                                       GESTURE_MODAL_SELECT;
    }
  }
  if ((prop = RNA_struct_find_property(op->ptr, "mode"))) {
    if (RNA_property_is_set(op->ptr, prop)) {
      return RNA_property_enum_get(op->ptr, prop) == SEL_OP_SUB ? GESTURE_MODAL_DESELECT :
                                                                  GESTURE_MODAL_SELECT;
    }
  }
  if ((prop = RNA_struct_find_property(op->ptr, "zoom_out"))) {
    if (RNA_property_is_set(op->ptr, prop)) {
      return RNA_property_boolean_get(op->ptr, prop) ? GESTURE_MODAL_OUT : GESTURE_MODAL_IN;
    }
  }
  return GESTURE_MODAL_NOP;
}

 
/* -------------------------------------------------------------------- */
 
static bool gesture_box_apply_rect(wmOperator *op)
{
  wmGesture *gesture = static_cast<wmGesture *>(op->customdata);
  const rcti *rect = static_cast<const rcti *>(gesture->customdata);
 
  if (rect->xmin == rect->xmax || rect->ymin == rect->ymax) {
    return false;
  }
 
  /* Operator arguments and storage. */
  RNA_int_set(op->ptr, "xmin", min_ii(rect->xmin, rect->xmax));
  RNA_int_set(op->ptr, "ymin", min_ii(rect->ymin, rect->ymax));
  RNA_int_set(op->ptr, "xmax", max_ii(rect->xmin, rect->xmax));
  RNA_int_set(op->ptr, "ymax", max_ii(rect->ymin, rect->ymax));
 
  return true;
}
 
static bool gesture_box_apply(bContext *C, wmOperator *op)
{
  wmGesture *gesture = static_cast<wmGesture *>(op->customdata);
 
  if (!gesture_box_apply_rect(op)) {
    return false;
  }
 
  if (gesture->wait_for_input) {
    gesture_modal_state_to_operator(op, gesture->modal_state);
  }
 
  const wmOperatorStatus retval = op->type->exec(C, op);
  OPERATOR_RETVAL_CHECK(retval);
 
  return (retval & OPERATOR_FINISHED) ? true : false;
}
 
wmOperatorStatus WM_gesture_box_invoke(bContext *C, wmOperator *op, const wmEvent *event)
{
  wmWindow *win = CTX_wm_window(C);
  const ARegion *region = CTX_wm_region(C);
  const bool wait_for_input = !WM_event_is_mouse_drag_or_press(event) &&
                              RNA_boolean_get(op->ptr, "wait_for_input");
 
  if (wait_for_input) {
    op->customdata = WM_gesture_new(win, region, event, WM_GESTURE_CROSS_RECT);
  }
  else {
    op->customdata = WM_gesture_new(win, region, event, WM_GESTURE_RECT);
  }
 
  {
    wmGesture *gesture = static_cast<wmGesture *>(op->customdata);
    gesture->wait_for_input = wait_for_input;
  }
 
  /* Add modal handler. */
  WM_event_add_modal_handler(C, op);
 
  wm_gesture_tag_redraw(win);
 
  return OPERATOR_RUNNING_MODAL;
}
 
wmOperatorStatus WM_gesture_box_modal(bContext *C, wmOperator *op, const wmEvent *event)
{
  wmWindow *win = CTX_wm_window(C);
  wmGesture *gesture = static_cast<wmGesture *>(op->customdata);
  rcti *rect = static_cast<rcti *>(gesture->customdata);
 
  if (event->type == EVT_MODAL_MAP) {
    switch (event->val) {
      case GESTURE_MODAL_MOVE: {
        gesture->move = !gesture->move;
        break;
      }
      case GESTURE_MODAL_BEGIN: {
        if (gesture->type == WM_GESTURE_CROSS_RECT && gesture->is_active == false) {
          gesture->is_active = true;
          wm_gesture_tag_redraw(win);
        }
        break;
      }
      case GESTURE_MODAL_SELECT:
      case GESTURE_MODAL_DESELECT:
      case GESTURE_MODAL_IN:
      case GESTURE_MODAL_OUT: {
        if (gesture->wait_for_input) {
          gesture->modal_state = event->val;
        }
        if (gesture_box_apply(C, op)) {
          gesture_modal_end(C, op);
          return OPERATOR_FINISHED;
        }
        gesture_modal_end(C, op);
        return OPERATOR_CANCELLED;
      }
      case GESTURE_MODAL_CANCEL: {
        gesture_modal_end(C, op);
        return OPERATOR_CANCELLED;
      }
    }
  }
  else {
    switch (event->type) {
      case MOUSEMOVE: {
        if (gesture->type == WM_GESTURE_CROSS_RECT && gesture->is_active == false) {
          rect->xmin = rect->xmax = event->xy[0] - gesture->winrct.xmin;
          rect->ymin = rect->ymax = event->xy[1] - gesture->winrct.ymin;
        }
        else if (gesture->move) {
          BLI_rcti_translate(rect,
                             (event->xy[0] - gesture->winrct.xmin) - rect->xmax,
                             (event->xy[1] - gesture->winrct.ymin) - rect->ymax);
        }
        else {
          rect->xmax = event->xy[0] - gesture->winrct.xmin;
          rect->ymax = event->xy[1] - gesture->winrct.ymin;
        }
        gesture_box_apply_rect(op);
 
        wm_gesture_tag_redraw(win);
 
        break;
      }
#ifdef WITH_INPUT_NDOF
      case NDOF_MOTION: {
        return OPERATOR_PASS_THROUGH;
      }
#endif
 
      default:
#if 0 /* This allows view navigation, keep disabled as it's too unpredictable. */
        return OPERATOR_PASS_THROUGH;
#endif
        break;
    }
  }
 
  gesture->is_active_prev = gesture->is_active;
  return OPERATOR_RUNNING_MODAL;
}
 
void WM_gesture_box_cancel(bContext *C, wmOperator *op)
{
  gesture_modal_end(C, op);
}

 
/* -------------------------------------------------------------------- */
 
static void gesture_circle_apply(bContext *C, wmOperator *op);
 
wmOperatorStatus WM_gesture_circle_invoke(bContext *C, wmOperator *op, const wmEvent *event)
{
  wmWindow *win = CTX_wm_window(C);
  const bool wait_for_input = !WM_event_is_mouse_drag_or_press(event) &&
                              RNA_boolean_get(op->ptr, "wait_for_input");
 
  op->customdata = WM_gesture_new(win, CTX_wm_region(C), event, WM_GESTURE_CIRCLE);
  wmGesture *gesture = static_cast<wmGesture *>(op->customdata);
  rcti *rect = static_cast<rcti *>(gesture->customdata);
 
  /* Default or previously stored value. */
  rect->xmax = RNA_int_get(op->ptr, "radius");
 
  gesture->wait_for_input = wait_for_input;
 
  /* Starting with the mode starts immediately,
   * like having 'wait_for_input' disabled (some tools use this). */
  if (gesture->wait_for_input == false) {
    gesture->is_active = true;
    gesture_circle_apply(C, op);
    gesture->is_active_prev = true;
  }
 
  /* Add modal handler. */
  WM_event_add_modal_handler(C, op);
 
  wm_gesture_tag_redraw(win);
 
  return OPERATOR_RUNNING_MODAL;
}
 
static void gesture_circle_apply(bContext *C, wmOperator *op)
{
  wmGesture *gesture = static_cast<wmGesture *>(op->customdata);
  const rcti *rect = static_cast<const rcti *>(gesture->customdata);
 
  if (gesture->wait_for_input && (gesture->modal_state == GESTURE_MODAL_NOP)) {
    return;
  }
 
  /* Operator arguments and storage. */
  RNA_int_set(op->ptr, "x", rect->xmin);
  RNA_int_set(op->ptr, "y", rect->ymin);
  RNA_int_set(op->ptr, "radius", rect->xmax);
 
  /* When 'wait_for_input' is false,
   * use properties to get the selection state (typically tool settings).
   * This is done so executing as a mode can select & de-select, see: #58594. */
  if (gesture->wait_for_input) {
    gesture_modal_state_to_operator(op, gesture->modal_state);
  }
 
  if (op->type->exec) {
    const wmOperatorStatus retval = op->type->exec(C, op);
    OPERATOR_RETVAL_CHECK(retval);
  }
}
 
wmOperatorStatus WM_gesture_circle_modal(bContext *C, wmOperator *op, const wmEvent *event)
{
  wmWindow *win = CTX_wm_window(C);
  wmGesture *gesture = static_cast<wmGesture *>(op->customdata);
  rcti *rect = static_cast<rcti *>(gesture->customdata);
 
  if (event->type == MOUSEMOVE) {
 
    rect->xmin = event->xy[0] - gesture->winrct.xmin;
    rect->ymin = event->xy[1] - gesture->winrct.ymin;
 
    wm_gesture_tag_redraw(win);
 
    if (gesture->is_active) {
      gesture_circle_apply(C, op);
    }
  }
  else if (event->type == EVT_MODAL_MAP) {
    bool is_circle_size = false;
    bool is_finished = false;
    float fac;
 
    switch (event->val) {
      case GESTURE_MODAL_CIRCLE_SIZE:
        fac = 0.3f * (event->xy[1] - event->prev_xy[1]);
        if (fac > 0) {
          rect->xmax += ceil(fac);
        }
        else {
          rect->xmax += floor(fac);
        }
        rect->xmax = std::max(rect->xmax, 1);
        is_circle_size = true;
        break;
      case GESTURE_MODAL_CIRCLE_ADD:
        rect->xmax += 2 + rect->xmax / 10;
        is_circle_size = true;
        break;
      case GESTURE_MODAL_CIRCLE_SUB:
        rect->xmax -= 2 + rect->xmax / 10;
        rect->xmax = std::max(rect->xmax, 1);
        is_circle_size = true;
        break;
      case GESTURE_MODAL_SELECT:
      case GESTURE_MODAL_DESELECT:
      case GESTURE_MODAL_NOP: {
        if (gesture->wait_for_input) {
          gesture->modal_state = event->val;
        }
        if (event->val == GESTURE_MODAL_NOP) {
          /* Single action, click-drag & release to exit. */
          if (gesture->wait_for_input == false) {
            is_finished = true;
          }
        }
        else {
          /* Apply first click. */
          gesture->is_active = true;
          gesture_circle_apply(C, op);
          wm_gesture_tag_redraw(win);
        }
        break;
      }
      case GESTURE_MODAL_CANCEL:
      case GESTURE_MODAL_CONFIRM:
        is_finished = true;
    }
 
    if (is_finished) {
      gesture_modal_end(C, op);
      return OPERATOR_FINISHED; /* Use finish or we don't get an undo. */
    }
 
    if (is_circle_size) {
      wm_gesture_tag_redraw(win);
 
      /* So next use remembers last seen size, even if we didn't apply it. */
      RNA_int_set(op->ptr, "radius", rect->xmax);
    }
  }
#ifdef WITH_INPUT_NDOF
  else if (event->type == NDOF_MOTION) {
    return OPERATOR_PASS_THROUGH;
  }
#endif
 
#if 0
  /* Allow view navigation??? */
  /* NOTE: this gives issues:
   * 1) other modal ops run on top (box select),
   * 2) middle-mouse is used now 3) tablet/trackpad? */
  else {
    return OPERATOR_PASS_THROUGH;
  }
#endif
 
  gesture->is_active_prev = gesture->is_active;
  return OPERATOR_RUNNING_MODAL;
}
 
void WM_gesture_circle_cancel(bContext *C, wmOperator *op)
{
  gesture_modal_end(C, op);
}
 
#if 0
/* Template to copy from. */
void WM_OT_circle_gesture(wmOperatorType *ot)
{
  ot->name = "Circle Gesture";
  ot->idname = "WM_OT_circle_gesture";
  ot->description = "Enter rotate mode with a circular gesture";
 
  ot->invoke = WM_gesture_circle_invoke;
  ot->modal = WM_gesture_circle_modal;
  ot->poll = WM_operator_winactive;
 
  /* Properties. */
  WM_operator_properties_gesture_circle(ot);
}
#endif

 
/* -------------------------------------------------------------------- */
 
wmOperatorStatus WM_gesture_lasso_invoke(bContext *C, wmOperator *op, const wmEvent *event)
{
  wmWindow *win = CTX_wm_window(C);
  PropertyRNA *prop;
 
  op->customdata = WM_gesture_new(win, CTX_wm_region(C), event, WM_GESTURE_LASSO);
  wmGesture *gesture = static_cast<wmGesture *>(op->customdata);
  gesture->use_smooth = RNA_boolean_get(op->ptr, "use_smooth_stroke");
 
  /* Add modal handler. */
  WM_event_add_modal_handler(C, op);
 
  wm_gesture_tag_redraw(win);
 
  if ((prop = RNA_struct_find_property(op->ptr, "cursor"))) {
    WM_cursor_modal_set(win, RNA_property_int_get(op->ptr, prop));
  }
 
  return OPERATOR_RUNNING_MODAL;
}
 
wmOperatorStatus WM_gesture_lines_invoke(bContext *C, wmOperator *op, const wmEvent *event)
{
  wmWindow *win = CTX_wm_window(C);
  PropertyRNA *prop;
 
  op->customdata = WM_gesture_new(win, CTX_wm_region(C), event, WM_GESTURE_LINES);
  wmGesture *gesture = static_cast<wmGesture *>(op->customdata);
  if ((prop = RNA_struct_find_property(op->ptr, "use_smooth_stroke"))) {
    gesture->use_smooth = RNA_property_boolean_get(op->ptr, prop);
  }
 
  /* Add modal handler. */
  WM_event_add_modal_handler(C, op);
 
  wm_gesture_tag_redraw(win);
 
  if ((prop = RNA_struct_find_property(op->ptr, "cursor"))) {
    WM_cursor_modal_set(win, RNA_property_int_get(op->ptr, prop));
  }
 
  return OPERATOR_RUNNING_MODAL;
}
 
static wmOperatorStatus gesture_lasso_apply(bContext *C, wmOperator *op)
{
  wmOperatorStatus retval = OPERATOR_FINISHED;
  wmGesture *gesture = static_cast<wmGesture *>(op->customdata);
  PointerRNA itemptr;
  float loc[2];
  int i;
  const float *lasso = static_cast<const float *>(gesture->customdata);
 
  /* Operator storage as path. */
 
  RNA_collection_clear(op->ptr, "path");
  for (i = 0; i < gesture->points; i++, lasso += 2) {
    loc[0] = lasso[0];
    loc[1] = lasso[1];
    RNA_collection_add(op->ptr, "path", &itemptr);
    RNA_float_set_array(&itemptr, "loc", loc);
  }
 
  gesture_modal_end(C, op);
 
  if (op->type->exec) {
    retval = op->type->exec(C, op);
    OPERATOR_RETVAL_CHECK(retval);
  }
 
  return retval;
}
 
wmOperatorStatus WM_gesture_lasso_modal(bContext *C, wmOperator *op, const wmEvent *event)
{
  wmGesture *gesture = static_cast<wmGesture *>(op->customdata);
  const float factor = gesture->use_smooth ? RNA_float_get(op->ptr, "smooth_stroke_factor") : 0.0f;
  const int radius = gesture->use_smooth ? RNA_int_get(op->ptr, "smooth_stroke_radius") : 0;
 
  if (event->type == EVT_MODAL_MAP) {
    switch (event->val) {
      case GESTURE_MODAL_MOVE: {
        gesture->move = !gesture->move;
        break;
      }
    }
  }
  else {
    switch (event->type) {
      case MOUSEMOVE:
      case INBETWEEN_MOUSEMOVE: {
        wm_gesture_tag_redraw(CTX_wm_window(C));
        gesture->mval = int2((event->xy[0] - gesture->winrct.xmin),
                             (event->xy[1] - gesture->winrct.ymin));
 
        if (gesture->points == gesture->points_alloc) {
          gesture->points_alloc *= 2;
          gesture->customdata = MEM_reallocN(gesture->customdata,
                                             sizeof(float[2]) * gesture->points_alloc);
        }
 
        {
          float (*lasso)[2] = static_cast<float (*)[2]>(gesture->customdata);
          const float2 current_mouse_position = float2(gesture->mval);
          const float2 last_position(lasso[gesture->points - 1][0], lasso[gesture->points - 1][1]);
 
          const float2 delta = current_mouse_position - last_position;
          const float dist_squared = blender::math::length_squared(delta);
 
          /* Move the lasso. */
          if (gesture->move) {
            for (int i = 0; i < gesture->points; i++) {
              lasso[i][0] += delta.x;
              lasso[i][1] += delta.y;
            }
          }
          else if (gesture->use_smooth) {
            if (dist_squared > square_f(radius)) {
              float2 result = blender::math::interpolate(
                  current_mouse_position, last_position, factor);
 
              lasso[gesture->points][0] = result.x;
              lasso[gesture->points][1] = result.y;
              gesture->points++;
            }
          }
          else if (dist_squared > pow2f(2.0f * UI_SCALE_FAC)) {
            /* Make a simple distance check to get a smoother lasso even if smoothing isn't enabled
             * add only when at least 2 pixels between this and previous location. */
            lasso[gesture->points][0] = gesture->mval.x;
            lasso[gesture->points][1] = gesture->mval.y;
            gesture->points++;
          }
        }
        break;
      }
      case LEFTMOUSE:
      case MIDDLEMOUSE:
      case RIGHTMOUSE: {
        if (event->val == KM_RELEASE) { /* Key release. */
          return gesture_lasso_apply(C, op);
        }
        break;
      }
      case EVT_ESCKEY: {
        gesture_modal_end(C, op);
        return OPERATOR_CANCELLED;
      }
      default: {
        break;
      }
    }
  }
 
  gesture->is_active_prev = gesture->is_active;
  return OPERATOR_RUNNING_MODAL;
}
 
wmOperatorStatus WM_gesture_lines_modal(bContext *C, wmOperator *op, const wmEvent *event)
{
  return WM_gesture_lasso_modal(C, op, event);
}
 
void WM_gesture_lasso_cancel(bContext *C, wmOperator *op)
{
  gesture_modal_end(C, op);
}
 
void WM_gesture_lines_cancel(bContext *C, wmOperator *op)
{
  gesture_modal_end(C, op);
}
 
Array<int2> WM_gesture_lasso_path_to_array(bContext * /*C*/, wmOperator *op)
{
  PropertyRNA *prop = RNA_struct_find_property(op->ptr, "path");
  BLI_assert(prop != nullptr);
  if (!prop) {
    return {};
  }
  const int len = RNA_property_collection_length(op->ptr, prop);
  if (len == 0) {
    return {};
  }
 
  int i = 0;
  Array<int2> mcoords(len);
 
  RNA_PROP_BEGIN (op->ptr, itemptr, prop) {
    float loc[2];
    RNA_float_get_array(&itemptr, "loc", loc);
    mcoords[i] = int2(loc[0], loc[1]);
    i++;
  }
  RNA_PROP_END;
 
  return mcoords;
}
 
#if 0
/* Template to copy from. */
 
static wmOperatorStatus gesture_lasso_exec(bContext *C, wmOperator *op)
{
  RNA_BEGIN (op->ptr, itemptr, "path") {
    float loc[2];
 
    RNA_float_get_array(&itemptr, "loc", loc);
    printf("Location: %f %f\n", loc[0], loc[1]);
  }
  RNA_END;
 
  return OPERATOR_FINISHED;
}
 
void WM_OT_lasso_gesture(wmOperatorType *ot)
{
  PropertyRNA *prop;
 
  ot->name = "Lasso Gesture";
  ot->idname = "WM_OT_lasso_gesture";
  ot->description = "Draw a shape defined by the cursor";
 
  ot->invoke = WM_gesture_lasso_invoke;
  ot->modal = WM_gesture_lasso_modal;
  ot->exec = gesture_lasso_exec;
 
  ot->poll = WM_operator_winactive;
 
  ot->flag = OPTYPE_DEPENDS_ON_CURSOR;
 
  prop = RNA_def_property(ot->srna, "path", PROP_COLLECTION, PROP_NONE);
  RNA_def_property_struct_runtime(ot->srna, prop, &RNA_OperatorMousePath);
}
#endif

 
/* -------------------------------------------------------------------- */
wmOperatorStatus WM_gesture_polyline_invoke(bContext *C, wmOperator *op, const wmEvent *event)
{
  wmWindow *win = CTX_wm_window(C);
  PropertyRNA *prop;
 
  op->customdata = WM_gesture_new(win, CTX_wm_region(C), event, WM_GESTURE_POLYLINE);
 
  /* add modal handler */
  WM_event_add_modal_handler(C, op);
 
  wm_gesture_tag_redraw(win);
 
  if ((prop = RNA_struct_find_property(op->ptr, "cursor"))) {
    WM_cursor_modal_set(win, RNA_property_int_get(op->ptr, prop));
  }
 
  return OPERATOR_RUNNING_MODAL;
}
 
/* Calculates the number of valid points in a polyline gesture where
 * a duplicated end point is invalid for submission */
static int gesture_polyline_valid_points(const wmGesture &wmGesture, const bool is_click_submitted)
{
  BLI_assert(wmGesture.points > 2);
 
  const int num_points = wmGesture.points;
  if (is_click_submitted) {
    return num_points;
  }
 
  short (*points)[2] = static_cast<short int (*)[2]>(wmGesture.customdata);
 
  const short prev_x = points[num_points - 1][0];
  const short prev_y = points[num_points - 1][1];
 
  return (wmGesture.mval.x == prev_x && wmGesture.mval.y == prev_y) ? num_points : num_points + 1;
}

static bool gesture_polyline_can_apply(const wmGesture &wmGesture, const bool is_click_submitted)
{
  if (wmGesture.points < 2) {
    return false;
  }
 
  const int valid_points = gesture_polyline_valid_points(wmGesture, is_click_submitted);
  if (valid_points <= 2) {
    return false;
  }
 
  return true;
}
 
static wmOperatorStatus gesture_polyline_apply(bContext *C,
                                               wmOperator *op,
                                               const bool is_click_submitted)
{
  wmGesture *gesture = static_cast<wmGesture *>(op->customdata);
  BLI_assert(gesture_polyline_can_apply(*gesture, is_click_submitted));
 
  const int valid_points = gesture_polyline_valid_points(*gesture, is_click_submitted);
  const short *border = static_cast<const short int *>(gesture->customdata);
 
  PointerRNA itemptr;
  float loc[2];
  RNA_collection_clear(op->ptr, "path");
  for (int i = 0; i < gesture->points; i++, border += 2) {
    loc[0] = border[0];
    loc[1] = border[1];
    RNA_collection_add(op->ptr, "path", &itemptr);
    RNA_float_set_array(&itemptr, "loc", loc);
  }
  if (valid_points > gesture->points) {
    loc[0] = gesture->mval.x;
    loc[1] = gesture->mval.y;
    RNA_collection_add(op->ptr, "path", &itemptr);
    RNA_float_set_array(&itemptr, "loc", loc);
  }
 
  gesture_modal_end(C, op);
 
  wmOperatorStatus retval = OPERATOR_FINISHED;
  if (op->type->exec) {
    retval = op->type->exec(C, op);
    OPERATOR_RETVAL_CHECK(retval);
  }
 
  return retval;
}
 
wmOperatorStatus WM_gesture_polyline_modal(bContext *C, wmOperator *op, const wmEvent *event)
{
  wmGesture *gesture = static_cast<wmGesture *>(op->customdata);
 
  if (event->type == EVT_MODAL_MAP) {
    switch (event->val) {
      case GESTURE_MODAL_MOVE:
        gesture->move = !gesture->move;
        break;
      case GESTURE_MODAL_SELECT: {
        wm_gesture_tag_redraw(CTX_wm_window(C));
        short (*border)[2] = static_cast<short int (*)[2]>(gesture->customdata);
        const short prev_x = border[gesture->points - 1][0];
        const short prev_y = border[gesture->points - 1][1];
 
        if (gesture->mval.x == prev_x && gesture->mval.y == prev_y) {
          break;
        }
 
        const float2 cur(gesture->mval);
        const float2 orig(border[0][0], border[0][1]);
 
        const float dist = len_v2v2(cur, orig);
 
        if (dist < blender::wm::gesture::POLYLINE_CLICK_RADIUS * UI_SCALE_FAC &&
            gesture_polyline_can_apply(*gesture, true))
        {
          return gesture_polyline_apply(C, op, true);
        }
 
        gesture->points++;
        border[gesture->points - 1][0] = gesture->mval.x;
        border[gesture->points - 1][1] = gesture->mval.y;
        break;
      }
      case GESTURE_MODAL_CONFIRM:
        if (gesture_polyline_can_apply(*gesture, false)) {
          return gesture_polyline_apply(C, op, false);
        }
        break;
      case GESTURE_MODAL_CANCEL:
        gesture_modal_end(C, op);
        return OPERATOR_CANCELLED;
    }
  }
  else {
    switch (event->type) {
      case MOUSEMOVE:
      case INBETWEEN_MOUSEMOVE: {
        wm_gesture_tag_redraw(CTX_wm_window(C));
        gesture->mval = int2((event->xy[0] - gesture->winrct.xmin),
                             (event->xy[1] - gesture->winrct.ymin));
        if (gesture->points == gesture->points_alloc) {
          gesture->points_alloc *= 2;
          gesture->customdata = MEM_reallocN(gesture->customdata,
                                             sizeof(short[2]) * gesture->points_alloc);
        }
        short (*border)[2] = static_cast<short int (*)[2]>(gesture->customdata);
 
        /* move the lasso */
        if (gesture->move) {
          const int dx = gesture->mval.x - border[gesture->points - 1][0];
          const int dy = gesture->mval.y - border[gesture->points - 1][1];
 
          for (int i = 0; i < gesture->points; i++) {
            border[i][0] += dx;
            border[i][1] += dy;
          }
        }
        break;
      }
      default: {
        break;
      }
    }
  }
 
  gesture->is_active_prev = gesture->is_active;
  return OPERATOR_RUNNING_MODAL;
}
 
void WM_gesture_polyline_cancel(bContext *C, wmOperator *op)
{
  gesture_modal_end(C, op);
}
 
/* template to copy from */
#if 0
static wmOperatorStatus gesture_polyline_exec(bContext *C, wmOperator *op)
{
  RNA_BEGIN (op->ptr, itemptr, "path") {
    float loc[2];
 
    RNA_float_get_array(&itemptr, "loc", loc);
    printf("Location: %f %f\n", loc[0], loc[1]);
  }
  RNA_END;
 
  return OPERATOR_FINISHED;
}
 
void WM_OT_polyline_gesture(wmOperatorType *ot)
{
  PropertyRNA *prop;
 
  ot->name = "Polyline Gesture";
  ot->idname = "WM_OT_polyline_gesture";
  ot->description = "Outline a selection area with each mouse click";
 
  ot->invoke = WM_gesture_polyline_invoke;
  ot->modal = WM_gesture_polyline_modal;
  ot->exec = gesture_polyline_exec;
 
  ot->poll = WM_operator_winactive;
 
  WM_operator_properties_gesture_polyline(ot);
}
#endif

 
/* -------------------------------------------------------------------- */
 
struct SnapAngle {
  float increment;
  float precise_increment;
};
 
static SnapAngle get_snap_angle(const ScrArea &area, const ToolSettings &tool_settings)
{
  SnapAngle snap_angle;
  if (area.spacetype == SPACE_VIEW3D) {
    snap_angle.increment = tool_settings.snap_angle_increment_3d;
    snap_angle.precise_increment = tool_settings.snap_angle_increment_3d_precision;
  }
  else {
    snap_angle.increment = tool_settings.snap_angle_increment_2d;
    snap_angle.precise_increment = tool_settings.snap_angle_increment_2d_precision;
  }
 
  return snap_angle;
}
 
static bool gesture_straightline_apply(bContext *C, wmOperator *op)
{
  wmGesture *gesture = static_cast<wmGesture *>(op->customdata);
  const rcti *rect = static_cast<const rcti *>(gesture->customdata);
 
  if (rect->xmin == rect->xmax && rect->ymin == rect->ymax) {
    return false;
  }
 
  /* Operator arguments and storage. */
  RNA_int_set(op->ptr, "xstart", rect->xmin);
  RNA_int_set(op->ptr, "ystart", rect->ymin);
  RNA_int_set(op->ptr, "xend", rect->xmax);
  RNA_int_set(op->ptr, "yend", rect->ymax);
  RNA_boolean_set(op->ptr, "flip", gesture->use_flip);
 
  if (op->type->exec) {
    const wmOperatorStatus retval = op->type->exec(C, op);
    OPERATOR_RETVAL_CHECK(retval);
  }
 
  return true;
}
 
wmOperatorStatus WM_gesture_straightline_invoke(bContext *C, wmOperator *op, const wmEvent *event)
{
  wmWindow *win = CTX_wm_window(C);
  PropertyRNA *prop;
 
  op->customdata = WM_gesture_new(win, CTX_wm_region(C), event, WM_GESTURE_STRAIGHTLINE);
 
  if (WM_event_is_mouse_drag_or_press(event)) {
    wmGesture *gesture = static_cast<wmGesture *>(op->customdata);
    gesture->is_active = true;
  }
 
  /* Add modal handler. */
  WM_event_add_modal_handler(C, op);
 
  wm_gesture_tag_redraw(win);
 
  if ((prop = RNA_struct_find_property(op->ptr, "cursor"))) {
    WM_cursor_modal_set(win, RNA_property_int_get(op->ptr, prop));
  }
 
  return OPERATOR_RUNNING_MODAL;
}
wmOperatorStatus WM_gesture_straightline_active_side_invoke(bContext *C,
                                                            wmOperator *op,
                                                            const wmEvent *event)
{
  WM_gesture_straightline_invoke(C, op, event);
  wmGesture *gesture = static_cast<wmGesture *>(op->customdata);
  gesture->draw_active_side = true;
  gesture->use_flip = false;
  return OPERATOR_RUNNING_MODAL;
}
 
static void wm_gesture_straightline_do_angle_snap(rcti *rect, float snap_angle)
{
  const float line_start[2] = {float(rect->xmin), float(rect->ymin)};
  const float line_end[2] = {float(rect->xmax), float(rect->ymax)};
  const float x_axis[2] = {1.0f, 0.0f};
 
  float line_direction[2];
  sub_v2_v2v2(line_direction, line_end, line_start);
  const float line_length = normalize_v2(line_direction);
 
  const float current_angle = angle_signed_v2v2(x_axis, line_direction);
  const float adjusted_angle = current_angle + (snap_angle / 2.0f);
  const float angle_snapped = -floorf(adjusted_angle / snap_angle) * snap_angle;
 
  float line_snapped_end[2];
  rotate_v2_v2fl(line_snapped_end, x_axis, angle_snapped);
  mul_v2_fl(line_snapped_end, line_length);
  add_v2_v2(line_snapped_end, line_start);
 
  rect->xmax = int(line_snapped_end[0]);
  rect->ymax = int(line_snapped_end[1]);
 
  /* Check whether `angle_snapped` is a multiple of 45 degrees, if so ensure X and Y directions
   * are the same length (there could be an off-by-one due to rounding error). */
  const float fract_45 = fractf(angle_snapped / DEG2RADF(45.0f));
  const float fract_90 = fractf(angle_snapped / DEG2RADF(90.0f));
  /* Check if it's a multiple of 45 but not 90 degrees. */
  if ((compare_ff(fract_45, 0.0f, 1e-6) || compare_ff(fabsf(fract_45), 1.0f, 1e-6)) &&
      !(compare_ff(fract_90, 0.0f, 1e-6) || compare_ff(fabsf(fract_90), 1.0f, 1e-6)))
  {
    int xlen = abs(rect->xmax - rect->xmin);
    int ylen = rect->ymax - rect->ymin;
    if (abs(ylen) != xlen) {
      ylen = xlen * (ylen >= 0 ? 1 : -1);
      rect->ymax = rect->ymin + ylen;
    }
  }
}
 
wmOperatorStatus WM_gesture_straightline_modal(bContext *C, wmOperator *op, const wmEvent *event)
{
  const Scene *scene = CTX_data_scene(C);
  const ScrArea *area = CTX_wm_area(C);
  const SnapAngle snap_angle = get_snap_angle(*area, *scene->toolsettings);
 
  wmGesture *gesture = static_cast<wmGesture *>(op->customdata);
  wmWindow *win = CTX_wm_window(C);
  rcti *rect = static_cast<rcti *>(gesture->customdata);
 
  if (event->type == EVT_MODAL_MAP) {
    switch (event->val) {
      case GESTURE_MODAL_MOVE: {
        gesture->move = !gesture->move;
        break;
      }
      case GESTURE_MODAL_BEGIN: {
        if (gesture->is_active == false) {
          gesture->is_active = true;
          wm_gesture_tag_redraw(win);
        }
        break;
      }
      case GESTURE_MODAL_SNAP: {
        /* Toggle snapping on/off. */
        gesture->use_snap = !gesture->use_snap;
        break;
      }
      case GESTURE_MODAL_FLIP: {
        /* Toggle flipping on/off. */
        gesture->use_flip = !gesture->use_flip;
        gesture_straightline_apply(C, op);
        wm_gesture_tag_redraw(win);
        break;
      }
      case GESTURE_MODAL_SELECT: {
        if (gesture_straightline_apply(C, op)) {
          gesture_modal_end(C, op);
          return OPERATOR_FINISHED;
        }
        gesture_modal_end(C, op);
        return OPERATOR_CANCELLED;
      }
      case GESTURE_MODAL_CANCEL: {
        gesture_modal_end(C, op);
        return OPERATOR_CANCELLED;
      }
    }
  }
  else {
    switch (event->type) {
      case MOUSEMOVE: {
        if (gesture->is_active == false) {
          rect->xmin = rect->xmax = event->xy[0] - gesture->winrct.xmin;
          rect->ymin = rect->ymax = event->xy[1] - gesture->winrct.ymin;
        }
        else if (gesture->move) {
          BLI_rcti_translate(rect,
                             (event->xy[0] - gesture->winrct.xmin) - rect->xmax,
                             (event->xy[1] - gesture->winrct.ymin) - rect->ymax);
          gesture_straightline_apply(C, op);
        }
        else {
          rect->xmax = event->xy[0] - gesture->winrct.xmin;
          rect->ymax = event->xy[1] - gesture->winrct.ymin;
          gesture_straightline_apply(C, op);
        }
 
        if (gesture->use_snap) {
          wm_gesture_straightline_do_angle_snap(rect, snap_angle.increment);
          gesture_straightline_apply(C, op);
        }
 
        wm_gesture_tag_redraw(win);
 
        break;
      }
      default: {
        break;
      }
    }
  }
 
  gesture->is_active_prev = gesture->is_active;
  return OPERATOR_RUNNING_MODAL;
}
 
wmOperatorStatus WM_gesture_straightline_oneshot_modal(bContext *C,
                                                       wmOperator *op,
                                                       const wmEvent *event)
{
  const Scene *scene = CTX_data_scene(C);
  const ScrArea *area = CTX_wm_area(C);
  const SnapAngle snap_angle = get_snap_angle(*area, *scene->toolsettings);
 
  wmGesture *gesture = static_cast<wmGesture *>(op->customdata);
  wmWindow *win = CTX_wm_window(C);
  rcti *rect = static_cast<rcti *>(gesture->customdata);
 
  if (event->type == EVT_MODAL_MAP) {
    switch (event->val) {
      case GESTURE_MODAL_MOVE: {
        gesture->move = !gesture->move;
        break;
      }
      case GESTURE_MODAL_BEGIN: {
        if (gesture->is_active == false) {
          gesture->is_active = true;
          wm_gesture_tag_redraw(win);
        }
        break;
      }
      case GESTURE_MODAL_SNAP: {
        /* Toggle snapping on/off. */
        gesture->use_snap = !gesture->use_snap;
        break;
      }
      case GESTURE_MODAL_FLIP: {
        /* Toggle flip on/off. */
        gesture->use_flip = !gesture->use_flip;
        wm_gesture_tag_redraw(win);
        break;
      }
      case GESTURE_MODAL_SELECT:
      case GESTURE_MODAL_DESELECT:
      case GESTURE_MODAL_IN:
      case GESTURE_MODAL_OUT: {
        if (gesture->wait_for_input) {
          gesture->modal_state = event->val;
        }
        if (gesture_straightline_apply(C, op)) {
          gesture_modal_end(C, op);
          return OPERATOR_FINISHED;
        }
        gesture_modal_end(C, op);
        return OPERATOR_CANCELLED;
      }
      case GESTURE_MODAL_CANCEL: {
        gesture_modal_end(C, op);
        return OPERATOR_CANCELLED;
      }
    }
  }
  else {
    switch (event->type) {
      case MOUSEMOVE: {
        if (gesture->is_active == false) {
          rect->xmin = rect->xmax = event->xy[0] - gesture->winrct.xmin;
          rect->ymin = rect->ymax = event->xy[1] - gesture->winrct.ymin;
        }
        else if (gesture->move) {
          BLI_rcti_translate(rect,
                             (event->xy[0] - gesture->winrct.xmin) - rect->xmax,
                             (event->xy[1] - gesture->winrct.ymin) - rect->ymax);
        }
        else {
          rect->xmax = event->xy[0] - gesture->winrct.xmin;
          rect->ymax = event->xy[1] - gesture->winrct.ymin;
        }
 
        if (gesture->use_snap) {
          wm_gesture_straightline_do_angle_snap(rect, snap_angle.increment);
        }
 
        wm_gesture_tag_redraw(win);
 
        break;
      }
      default: {
        break;
      }
    }
  }
 
  gesture->is_active_prev = gesture->is_active;
  return OPERATOR_RUNNING_MODAL;
}
 
void WM_gesture_straightline_cancel(bContext *C, wmOperator *op)
{
  gesture_modal_end(C, op);
}
 
#if 0
/* Template to copy from. */
void WM_OT_straightline_gesture(wmOperatorType *ot)
{
  PropertyRNA *prop;
 
  ot->name = "Straight Line Gesture";
  ot->idname = "WM_OT_straightline_gesture";
  ot->description = "Draw a straight line defined by the cursor";
 
  ot->invoke = WM_gesture_straightline_invoke;
  ot->modal = WM_gesture_straightline_modal;
  ot->exec = gesture_straightline_exec;
 
  ot->poll = WM_operator_winactive;
 
  WM_operator_properties_gesture_straightline(ot, 0);
}
#endif