gimp/app/display/gimpcanvashandle.c

/* GIMP - The GNU Image Manipulation Program
 * Copyright (C) 1995 Spencer Kimball and Peter Mattis
 *
 * gimpcanvashandle.c
 * Copyright (C) 2010 Michael Natterer <mitch@gimp.org>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

#include "config.h"

#include <gegl.h>
#include <gtk/gtk.h>

#include "libgimpbase/gimpbase.h"
#include "libgimpmath/gimpmath.h"

#include "display-types.h"

#include "core/gimp-cairo.h"

#include "gimpcanvashandle.h"
#include "gimpcanvasitem-utils.h"
#include "gimpdisplayshell.h"


#define N_DASHES       8
#define DASH_ON_RATIO  0.3
#define DASH_OFF_RATIO 0.7


enum
{
  PROP_0,
  PROP_TYPE,
  PROP_ANCHOR,
  PROP_X,
  PROP_Y,
  PROP_WIDTH,
  PROP_HEIGHT,
  PROP_START_ANGLE,
  PROP_SLICE_ANGLE
};


typedef struct _GimpCanvasHandlePrivate GimpCanvasHandlePrivate;

struct _GimpCanvasHandlePrivate
{
  GimpHandleType   type;
  GimpHandleAnchor anchor;
  gdouble          x;
  gdouble          y;
  gint             width;
  gint             height;
  gdouble          start_angle;
  gdouble          slice_angle;
};

#define GET_PRIVATE(handle) \
        ((GimpCanvasHandlePrivate *) gimp_canvas_handle_get_instance_private ((GimpCanvasHandle *) (handle)))


/*  local function prototypes  */

static void             gimp_canvas_handle_set_property (GObject        *object,
                                                         guint           property_id,
                                                         const GValue   *value,
                                                         GParamSpec     *pspec);
static void             gimp_canvas_handle_get_property (GObject        *object,
                                                         guint           property_id,
                                                         GValue         *value,
                                                         GParamSpec     *pspec);
static void             gimp_canvas_handle_draw         (GimpCanvasItem *item,
                                                         cairo_t        *cr);
static cairo_region_t * gimp_canvas_handle_get_extents  (GimpCanvasItem *item);
static gboolean         gimp_canvas_handle_hit          (GimpCanvasItem *item,
                                                         gdouble         x,
                                                         gdouble         y);


G_DEFINE_TYPE_WITH_PRIVATE (GimpCanvasHandle, gimp_canvas_handle,
                            GIMP_TYPE_CANVAS_ITEM)

#define parent_class gimp_canvas_handle_parent_class


static void
gimp_canvas_handle_class_init (GimpCanvasHandleClass *klass)
{
  GObjectClass        *object_class = G_OBJECT_CLASS (klass);
  GimpCanvasItemClass *item_class   = GIMP_CANVAS_ITEM_CLASS (klass);

  object_class->set_property = gimp_canvas_handle_set_property;
  object_class->get_property = gimp_canvas_handle_get_property;

  item_class->draw           = gimp_canvas_handle_draw;
  item_class->get_extents    = gimp_canvas_handle_get_extents;
  item_class->hit            = gimp_canvas_handle_hit;

  g_object_class_install_property (object_class, PROP_TYPE,
                                   g_param_spec_enum ("type", NULL, NULL,
                                                      GIMP_TYPE_HANDLE_TYPE,
                                                      GIMP_HANDLE_CROSS,
                                                      GIMP_PARAM_READWRITE));

  g_object_class_install_property (object_class, PROP_ANCHOR,
                                   g_param_spec_enum ("anchor", NULL, NULL,
                                                      GIMP_TYPE_HANDLE_ANCHOR,
                                                      GIMP_HANDLE_ANCHOR_CENTER,
                                                      GIMP_PARAM_READWRITE));

  g_object_class_install_property (object_class, PROP_X,
                                   g_param_spec_double ("x", NULL, NULL,
                                                        -GIMP_MAX_IMAGE_SIZE,
                                                        GIMP_MAX_IMAGE_SIZE, 0,
                                                        GIMP_PARAM_READWRITE));

  g_object_class_install_property (object_class, PROP_Y,
                                   g_param_spec_double ("y", NULL, NULL,
                                                        -GIMP_MAX_IMAGE_SIZE,
                                                        GIMP_MAX_IMAGE_SIZE, 0,
                                                        GIMP_PARAM_READWRITE));

  g_object_class_install_property (object_class, PROP_WIDTH,
                                   g_param_spec_int ("width", NULL, NULL,
                                                     3, 1001, 7,
                                                     GIMP_PARAM_READWRITE));

  g_object_class_install_property (object_class, PROP_HEIGHT,
                                   g_param_spec_int ("height", NULL, NULL,
                                                     3, 1001, 7,
                                                     GIMP_PARAM_READWRITE));

  g_object_class_install_property (object_class, PROP_START_ANGLE,
                                   g_param_spec_double ("start-angle", NULL, NULL,
                                                        -1000, 1000, 0,
                                                        GIMP_PARAM_READWRITE));

  g_object_class_install_property (object_class, PROP_SLICE_ANGLE,
                                   g_param_spec_double ("slice-angle", NULL, NULL,
                                                        -1000, 1000, 2 * G_PI,
                                                        GIMP_PARAM_READWRITE));
}

static void
gimp_canvas_handle_init (GimpCanvasHandle *handle)
{
  GimpCanvasHandlePrivate *private = GET_PRIVATE (handle);

  gimp_canvas_item_set_line_cap (GIMP_CANVAS_ITEM (handle),
                                 CAIRO_LINE_CAP_SQUARE);

  private->start_angle = 0.0;
  private->slice_angle = 2.0 * G_PI;
}

static void
gimp_canvas_handle_set_property (GObject      *object,
                                 guint         property_id,
                                 const GValue *value,
                                 GParamSpec   *pspec)
{
  GimpCanvasHandlePrivate *private = GET_PRIVATE (object);

  switch (property_id)
    {
    case PROP_TYPE:
      private->type = g_value_get_enum (value);
      break;
    case PROP_ANCHOR:
      private->anchor = g_value_get_enum (value);
      break;
    case PROP_X:
      private->x = g_value_get_double (value);
      break;
    case PROP_Y:
      private->y = g_value_get_double (value);
      break;
    case PROP_WIDTH:
      private->width = g_value_get_int (value);
      break;
    case PROP_HEIGHT:
      private->height = g_value_get_int (value);
      break;
    case PROP_START_ANGLE:
      private->start_angle = g_value_get_double (value);
      break;
    case PROP_SLICE_ANGLE:
      private->slice_angle = g_value_get_double (value);
      break;

    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
      break;
    }
}

static void
gimp_canvas_handle_get_property (GObject    *object,
                                 guint       property_id,
                                 GValue     *value,
                                 GParamSpec *pspec)
{
  GimpCanvasHandlePrivate *private = GET_PRIVATE (object);

  switch (property_id)
    {
    case PROP_TYPE:
      g_value_set_enum (value, private->type);
      break;
    case PROP_ANCHOR:
      g_value_set_enum (value, private->anchor);
      break;
    case PROP_X:
      g_value_set_double (value, private->x);
      break;
    case PROP_Y:
      g_value_set_double (value, private->y);
      break;
    case PROP_WIDTH:
      g_value_set_int (value, private->width);
      break;
    case PROP_HEIGHT:
      g_value_set_int (value, private->height);
      break;
    case PROP_START_ANGLE:
      g_value_set_double (value, private->start_angle);
      break;
    case PROP_SLICE_ANGLE:
      g_value_set_double (value, private->slice_angle);
      break;

    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
      break;
    }
}

static void
gimp_canvas_handle_transform (GimpCanvasItem *item,
                              gdouble        *x,
                              gdouble        *y)
{
  GimpCanvasHandlePrivate *private = GET_PRIVATE (item);

  gimp_canvas_item_transform_xy_f (item,
                                   private->x, private->y,
                                   x, y);

  switch (private->type)
    {
    case GIMP_HANDLE_SQUARE:
    case GIMP_HANDLE_DASHED_SQUARE:
    case GIMP_HANDLE_FILLED_SQUARE:
      gimp_canvas_item_shift_to_north_west (private->anchor,
                                            *x, *y,
                                            private->width,
                                            private->height,
                                            x, y);
      break;

    case GIMP_HANDLE_CIRCLE:
    case GIMP_HANDLE_DASHED_CIRCLE:
    case GIMP_HANDLE_FILLED_CIRCLE:
    case GIMP_HANDLE_CROSS:
    case GIMP_HANDLE_CROSSHAIR:
    case GIMP_HANDLE_DIAMOND:
    case GIMP_HANDLE_DASHED_DIAMOND:
    case GIMP_HANDLE_FILLED_DIAMOND:
      gimp_canvas_item_shift_to_center (private->anchor,
                                        *x, *y,
                                        private->width,
                                        private->height,
                                        x, y);
      break;

    default:
      break;
    }

  *x = floor (*x) + 0.5;
  *y = floor (*y) + 0.5;
}

static void
gimp_canvas_handle_draw (GimpCanvasItem *item,
                         cairo_t        *cr)
{
  GimpCanvasHandlePrivate *private = GET_PRIVATE (item);
  gdouble                  x, y, tx, ty;

  gimp_canvas_handle_transform (item, &x, &y);

  gimp_canvas_item_transform_xy_f (item,
                                   private->x, private->y,
                                   &tx, &ty);

  tx = floor (tx) + 0.5;
  ty = floor (ty) + 0.5;

  switch (private->type)
    {
    case GIMP_HANDLE_SQUARE:
    case GIMP_HANDLE_DASHED_SQUARE:
    case GIMP_HANDLE_FILLED_SQUARE:
    case GIMP_HANDLE_DIAMOND:
    case GIMP_HANDLE_DASHED_DIAMOND:
    case GIMP_HANDLE_FILLED_DIAMOND:
    case GIMP_HANDLE_CROSS:
      cairo_save (cr);
      cairo_translate (cr, tx, ty);
      cairo_rotate (cr, private->start_angle);
      cairo_translate (cr, -tx, -ty);

      switch (private->type)
        {
        case GIMP_HANDLE_SQUARE:
        case GIMP_HANDLE_DASHED_SQUARE:
          if (private->type == GIMP_HANDLE_DASHED_SQUARE)
            {
              gdouble circ;
              gdouble dashes[2];

              cairo_save (cr);

              circ = 2.0 * ((private->width - 1.0) + (private->height - 1.0));

              dashes[0] = (circ / N_DASHES) * DASH_ON_RATIO;
              dashes[1] = (circ / N_DASHES) * DASH_OFF_RATIO;

              cairo_set_dash (cr, dashes, 2, dashes[0] / 2.0);
            }

          cairo_rectangle (cr, x, y, private->width - 1.0, private->height - 1.0);
          _gimp_canvas_item_stroke (item, cr);

          if (private->type == GIMP_HANDLE_DASHED_SQUARE)
            cairo_restore (cr);
          break;

        case GIMP_HANDLE_FILLED_SQUARE:
          cairo_rectangle (cr, x - 0.5, y - 0.5, private->width, private->height);
          _gimp_canvas_item_fill (item, cr);
          break;

        case GIMP_HANDLE_DIAMOND:
        case GIMP_HANDLE_DASHED_DIAMOND:
        case GIMP_HANDLE_FILLED_DIAMOND:
          if (private->type == GIMP_HANDLE_DASHED_DIAMOND)
            {
              gdouble circ;
              gdouble dashes[2];

              cairo_save (cr);

              circ = 4.0 * hypot ((gdouble) private->width  / 2.0,
                                  (gdouble) private->height / 2.0);

              dashes[0] = (circ / N_DASHES) * DASH_ON_RATIO;
              dashes[1] = (circ / N_DASHES) * DASH_OFF_RATIO;

              cairo_set_dash (cr, dashes, 2, dashes[0] / 2.0);
            }

          cairo_move_to (cr, x, y - (gdouble) private->height / 2.0);
          cairo_line_to (cr, x + (gdouble) private->width / 2.0, y);
          cairo_line_to (cr, x, y + (gdouble) private->height / 2.0);
          cairo_line_to (cr, x - (gdouble) private->width / 2.0, y);
          cairo_line_to (cr, x, y - (gdouble) private->height / 2.0);
          if (private->type == GIMP_HANDLE_DIAMOND ||
              private->type == GIMP_HANDLE_DASHED_DIAMOND)
            _gimp_canvas_item_stroke (item, cr);
          else
            _gimp_canvas_item_fill (item, cr);

          if (private->type == GIMP_HANDLE_DASHED_SQUARE)
            cairo_restore (cr);
          break;

        case GIMP_HANDLE_CROSS:
          cairo_move_to (cr, x - private->width / 2.0, y);
          cairo_line_to (cr, x + private->width / 2.0 - 0.5, y);
          cairo_move_to (cr, x, y - private->height / 2.0);
          cairo_line_to (cr, x, y + private->height / 2.0 - 0.5);
          _gimp_canvas_item_stroke (item, cr);
          break;

        default:
          gimp_assert_not_reached ();
        }

      cairo_restore (cr);
      break;

    case GIMP_HANDLE_CIRCLE:
    case GIMP_HANDLE_DASHED_CIRCLE:
      if (private->type == GIMP_HANDLE_DASHED_CIRCLE)
        {
          gdouble circ;
          gdouble dashes[2];

          cairo_save (cr);

          circ = 2.0 * G_PI * (private->width / 2.0);

          dashes[0] = (circ / N_DASHES) * DASH_ON_RATIO;
          dashes[1] = (circ / N_DASHES) * DASH_OFF_RATIO;

          cairo_set_dash (cr, dashes, 2, dashes[0] / 2.0);
        }

      gimp_cairo_arc (cr, x, y, private->width / 2.0,
                      private->start_angle,
                      private->slice_angle);

      _gimp_canvas_item_stroke (item, cr);

      if (private->type == GIMP_HANDLE_DASHED_CIRCLE)
        cairo_restore (cr);
      break;

    case GIMP_HANDLE_FILLED_CIRCLE:
      cairo_move_to (cr, x, y);

      gimp_cairo_arc (cr, x, y, (gdouble) private->width / 2.0,
                      private->start_angle,
                      private->slice_angle);

      _gimp_canvas_item_fill (item, cr);
      break;

    case GIMP_HANDLE_CROSSHAIR:
      cairo_move_to (cr, x - private->width / 2.0, y);
      cairo_line_to (cr, x - private->width * 0.4, y);

      cairo_move_to (cr, x + private->width / 2.0 - 0.5, y);
      cairo_line_to (cr, x + private->width * 0.4, y);

      cairo_move_to (cr, x, y - private->height / 2.0);
      cairo_line_to (cr, x, y - private->height * 0.4 - 0.5);

      cairo_move_to (cr, x, y + private->height / 2.0 - 0.5);
      cairo_line_to (cr, x, y + private->height * 0.4 - 0.5);

       _gimp_canvas_item_stroke (item, cr);
      break;

    default:
      break;
    }
}

static cairo_region_t *
gimp_canvas_handle_get_extents (GimpCanvasItem *item)
{
  GimpCanvasHandlePrivate *private = GET_PRIVATE (item);
  cairo_rectangle_int_t    rectangle;
  gdouble                  x, y;
  gdouble                  w, h;

  gimp_canvas_handle_transform (item, &x, &y);

  switch (private->type)
    {
    case GIMP_HANDLE_SQUARE:
    case GIMP_HANDLE_DASHED_SQUARE:
    case GIMP_HANDLE_FILLED_SQUARE:
      w = private->width * (sqrt(2) - 1) / 2;
      h = private->height * (sqrt(2) - 1) / 2;
      rectangle.x      = x - 1.5 - w;
      rectangle.y      = y - 1.5 - h;
      rectangle.width  = private->width  + 3.0 + w * 2;
      rectangle.height = private->height + 3.0 + h * 2;
      break;

    case GIMP_HANDLE_CIRCLE:
    case GIMP_HANDLE_DASHED_CIRCLE:
    case GIMP_HANDLE_FILLED_CIRCLE:
    case GIMP_HANDLE_CROSS:
    case GIMP_HANDLE_CROSSHAIR:
    case GIMP_HANDLE_DIAMOND:
    case GIMP_HANDLE_DASHED_DIAMOND:
    case GIMP_HANDLE_FILLED_DIAMOND:
      rectangle.x      = x - private->width  / 2.0 - 2.0;
      rectangle.y      = y - private->height / 2.0 - 2.0;
      rectangle.width  = private->width  + 4.0;
      rectangle.height = private->height + 4.0;
      break;

    default:
      break;
    }

  return cairo_region_create_rectangle (&rectangle);
}

static gboolean
gimp_canvas_handle_hit (GimpCanvasItem *item,
                        gdouble         x,
                        gdouble         y)
{
  GimpCanvasHandlePrivate *private = GET_PRIVATE (item);
  gdouble                  handle_tx, handle_ty;
  gdouble                  mx, my, tx, ty, mmx, mmy;
  gdouble                  diamond_offset_x = 0.0;
  gdouble                  diamond_offset_y = 0.0;
  gdouble                  angle            = -private->start_angle;

  gimp_canvas_handle_transform (item, &handle_tx, &handle_ty);

  gimp_canvas_item_transform_xy_f (item,
                                   x, y,
                                   &mx, &my);

  switch (private->type)
    {
    case GIMP_HANDLE_DIAMOND:
    case GIMP_HANDLE_DASHED_DIAMOND:
    case GIMP_HANDLE_FILLED_DIAMOND:
      angle -= G_PI / 4.0;
      diamond_offset_x = private->width / 2.0;
      diamond_offset_y = private->height / 2.0;
    case GIMP_HANDLE_SQUARE:
    case GIMP_HANDLE_DASHED_SQUARE:
    case GIMP_HANDLE_FILLED_SQUARE:
      gimp_canvas_item_transform_xy_f (item,
                                       private->x, private->y,
                                       &tx, &ty);
      mmx = mx - tx; mmy = my - ty;
      mx = cos (angle) * mmx - sin (angle) * mmy + tx + diamond_offset_x;
      my = sin (angle) * mmx + cos (angle) * mmy + ty + diamond_offset_y;
      return mx > handle_tx && mx < handle_tx + private->width &&
             my > handle_ty && my < handle_ty + private->height;

    case GIMP_HANDLE_CIRCLE:
    case GIMP_HANDLE_DASHED_CIRCLE:
    case GIMP_HANDLE_FILLED_CIRCLE:
    case GIMP_HANDLE_CROSS:
    case GIMP_HANDLE_CROSSHAIR:
      {
        gint width = private->width;

        if (width != private->height)
          width = (width + private->height) / 2;

        width /= 2;

        return ((SQR (handle_tx - mx) + SQR (handle_ty - my)) < SQR (width));
      }

    default:
      break;
    }

  return FALSE;
}

GimpCanvasItem *
gimp_canvas_handle_new (GimpDisplayShell *shell,
                        GimpHandleType    type,
                        GimpHandleAnchor  anchor,
                        gdouble           x,
                        gdouble           y,
                        gint              width,
                        gint              height)
{
  g_return_val_if_fail (GIMP_IS_DISPLAY_SHELL (shell), NULL);

  return g_object_new (GIMP_TYPE_CANVAS_HANDLE,
                       "shell",  shell,
                       "type",   type,
                       "anchor", anchor,
                       "x",      x,
                       "y",      y,
                       "width",  width,
                       "height", height,
                       NULL);
}

void
gimp_canvas_handle_get_position (GimpCanvasItem *handle,
                                 gdouble        *x,
                                 gdouble        *y)
{
  g_return_if_fail (GIMP_IS_CANVAS_HANDLE (handle));
  g_return_if_fail (x != NULL);
  g_return_if_fail (y != NULL);

  g_object_get (handle,
                "x", x,
                "y", y,
                NULL);
}

void
gimp_canvas_handle_set_position (GimpCanvasItem *handle,
                                 gdouble         x,
                                 gdouble         y)
{
  g_return_if_fail (GIMP_IS_CANVAS_HANDLE (handle));

  gimp_canvas_item_begin_change (handle);

  g_object_set (handle,
                "x", x,
                "y", y,
                NULL);

  gimp_canvas_item_end_change (handle);
}

gint
gimp_canvas_handle_calc_size (GimpCanvasItem *item,
                              gdouble         mouse_x,
                              gdouble         mouse_y,
                              gint            normal_size,
                              gint            hover_size)
{
  gdouble x, y;
  gdouble distance;
  gdouble size;
  gint    full_threshold_sq    = SQR (hover_size / 2) * 9;
  gint    partial_threshold_sq = full_threshold_sq * 5;

  g_return_val_if_fail (GIMP_IS_CANVAS_HANDLE (item), normal_size);

  gimp_canvas_handle_get_position (item, &x, &y);
  distance = gimp_canvas_item_transform_distance_square (item,
                                                         mouse_x,
                                                         mouse_y,
                                                         x, y);

  /*  calculate the handle size based on distance from the cursor  */
  size = (1.0 - (distance - full_threshold_sq) /
          (partial_threshold_sq - full_threshold_sq));

  size = CLAMP (size, 0.0, 1.0);

  return (gint) CLAMP ((size * hover_size),
                       normal_size,
                       hover_size);
}

void
gimp_canvas_handle_get_size (GimpCanvasItem *handle,
                             gint           *width,
                             gint           *height)
{
  g_return_if_fail (GIMP_IS_CANVAS_HANDLE (handle));
  g_return_if_fail (width != NULL);
  g_return_if_fail (height != NULL);

  g_object_get (handle,
                "width",  width,
                "height", height,
                NULL);
}

void
gimp_canvas_handle_set_size (GimpCanvasItem *handle,
                             gint            width,
                             gint            height)
{
  g_return_if_fail (GIMP_IS_CANVAS_HANDLE (handle));

  gimp_canvas_item_begin_change (handle);

  g_object_set (handle,
                "width",  width,
                "height", height,
                NULL);

  gimp_canvas_item_end_change (handle);
}

void
gimp_canvas_handle_set_angles (GimpCanvasItem *handle,
                               gdouble         start_angle,
                               gdouble         slice_angle)
{
  g_return_if_fail (GIMP_IS_CANVAS_HANDLE (handle));

  gimp_canvas_item_begin_change (handle);

  g_object_set (handle,
                "start-angle", start_angle,
                "slice-angle", slice_angle,
                NULL);

  gimp_canvas_item_end_change (handle);
}