Files
gimp/app/display/gimpcanvasgrid.c
Ell 1572bccc9f app: add support for subpixel image grids
In particular, this enables grids whose points of intersection
are at the middle of the image's pixels, which is useful for
undistorted painting with odd-sized brushes using tools other than
the pencil.

This commit also changes the grid visibility behavior, so that the
the visibiltiy of horizontal and vertical grid lines (depending on
the zoom level) is independent.
2017-02-19 18:13:41 -05:00

421 lines
12 KiB
C

/* GIMP - The GNU Image Manipulation Program
* Copyright (C) 1995 Spencer Kimball and Peter Mattis
*
* gimpcanvasgrid.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 <http://www.gnu.org/licenses/>.
*/
#include "config.h"
#include <math.h>
#include <gegl.h>
#include <gtk/gtk.h>
#include "libgimpbase/gimpbase.h"
#include "libgimpmath/gimpmath.h"
#include "libgimpconfig/gimpconfig.h"
#include "display-types.h"
#include "core/gimpgrid.h"
#include "core/gimpimage.h"
#include "gimpcanvas-style.h"
#include "gimpcanvasgrid.h"
#include "gimpdisplayshell.h"
enum
{
PROP_0,
PROP_GRID,
PROP_GRID_STYLE
};
typedef struct _GimpCanvasGridPrivate GimpCanvasGridPrivate;
struct _GimpCanvasGridPrivate
{
GimpGrid *grid;
gboolean grid_style;
};
#define GET_PRIVATE(grid) \
G_TYPE_INSTANCE_GET_PRIVATE (grid, \
GIMP_TYPE_CANVAS_GRID, \
GimpCanvasGridPrivate)
/* local function prototypes */
static void gimp_canvas_grid_finalize (GObject *object);
static void gimp_canvas_grid_set_property (GObject *object,
guint property_id,
const GValue *value,
GParamSpec *pspec);
static void gimp_canvas_grid_get_property (GObject *object,
guint property_id,
GValue *value,
GParamSpec *pspec);
static void gimp_canvas_grid_draw (GimpCanvasItem *item,
cairo_t *cr);
static cairo_region_t * gimp_canvas_grid_get_extents (GimpCanvasItem *item);
static void gimp_canvas_grid_stroke (GimpCanvasItem *item,
cairo_t *cr);
G_DEFINE_TYPE (GimpCanvasGrid, gimp_canvas_grid, GIMP_TYPE_CANVAS_ITEM)
#define parent_class gimp_canvas_grid_parent_class
static void
gimp_canvas_grid_class_init (GimpCanvasGridClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
GimpCanvasItemClass *item_class = GIMP_CANVAS_ITEM_CLASS (klass);
object_class->finalize = gimp_canvas_grid_finalize;
object_class->set_property = gimp_canvas_grid_set_property;
object_class->get_property = gimp_canvas_grid_get_property;
item_class->draw = gimp_canvas_grid_draw;
item_class->get_extents = gimp_canvas_grid_get_extents;
item_class->stroke = gimp_canvas_grid_stroke;
g_object_class_install_property (object_class, PROP_GRID,
g_param_spec_object ("grid", NULL, NULL,
GIMP_TYPE_GRID,
GIMP_PARAM_READWRITE));
g_object_class_install_property (object_class, PROP_GRID_STYLE,
g_param_spec_boolean ("grid-style",
NULL, NULL,
FALSE,
GIMP_PARAM_READWRITE));
g_type_class_add_private (klass, sizeof (GimpCanvasGridPrivate));
}
static void
gimp_canvas_grid_init (GimpCanvasGrid *grid)
{
GimpCanvasGridPrivate *private = GET_PRIVATE (grid);
private->grid = g_object_new (GIMP_TYPE_GRID, NULL);
}
static void
gimp_canvas_grid_finalize (GObject *object)
{
GimpCanvasGridPrivate *private = GET_PRIVATE (object);
if (private->grid)
{
g_object_unref (private->grid);
private->grid = NULL;
}
G_OBJECT_CLASS (parent_class)->finalize (object);
}
static void
gimp_canvas_grid_set_property (GObject *object,
guint property_id,
const GValue *value,
GParamSpec *pspec)
{
GimpCanvasGridPrivate *private = GET_PRIVATE (object);
switch (property_id)
{
case PROP_GRID:
{
GimpGrid *grid = g_value_get_object (value);
if (grid)
gimp_config_sync (G_OBJECT (grid), G_OBJECT (private->grid), 0);
}
break;
case PROP_GRID_STYLE:
private->grid_style = g_value_get_boolean (value);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
break;
}
}
static void
gimp_canvas_grid_get_property (GObject *object,
guint property_id,
GValue *value,
GParamSpec *pspec)
{
GimpCanvasGridPrivate *private = GET_PRIVATE (object);
switch (property_id)
{
case PROP_GRID:
g_value_set_object (value, private->grid);
break;
case PROP_GRID_STYLE:
g_value_set_boolean (value, private->grid_style);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
break;
}
}
static void
gimp_canvas_grid_draw (GimpCanvasItem *item,
cairo_t *cr)
{
GimpCanvasGridPrivate *private = GET_PRIVATE (item);
GimpDisplayShell *shell = gimp_canvas_item_get_shell (item);
GimpImage *image = gimp_canvas_item_get_image (item);
gdouble xspacing, yspacing;
gdouble xoffset, yoffset;
gboolean vert, horz;
gdouble x, y;
gdouble dx1, dy1, dx2, dy2;
gint x0, x1, x2, x3;
gint y0, y1, y2, y3;
gint x_real, y_real;
gint width, height;
#define CROSSHAIR 2
gimp_grid_get_spacing (private->grid, &xspacing, &yspacing);
gimp_grid_get_offset (private->grid, &xoffset, &yoffset);
g_return_if_fail (xspacing >= 0.0 &&
yspacing >= 0.0);
/* skip grid drawing when the space between grid lines starts
* disappearing, see bug #599267.
*/
vert = (xspacing * shell->scale_x >= 2.0);
horz = (yspacing * shell->scale_y >= 2.0);
if (! vert && ! horz)
return;
cairo_clip_extents (cr, &dx1, &dy1, &dx2, &dy2);
x1 = floor (dx1);
y1 = floor (dy1);
x2 = ceil (dx2);
y2 = ceil (dy2);
width = gimp_image_get_width (image);
height = gimp_image_get_height (image);
xoffset = fmod (xoffset, xspacing);
yoffset = fmod (yoffset, yspacing);
switch (gimp_grid_get_style (private->grid))
{
case GIMP_GRID_DOTS:
if (vert && horz)
{
for (x = xoffset; x <= width; x += xspacing)
{
if (x < 0)
continue;
gimp_canvas_item_transform_xy (item, x, 0, &x_real, &y_real);
if (x_real < x1 || x_real >= x2)
continue;
for (y = yoffset; y <= height; y += yspacing)
{
if (y < 0)
continue;
gimp_canvas_item_transform_xy (item, x, y, &x_real, &y_real);
if (y_real >= y1 && y_real < y2)
{
cairo_move_to (cr, x_real, y_real + 0.5);
cairo_line_to (cr, x_real + 1, y_real + 0.5);
}
}
}
}
break;
case GIMP_GRID_INTERSECTIONS:
if (vert && horz)
{
for (x = xoffset; x <= width; x += xspacing)
{
if (x < 0)
continue;
gimp_canvas_item_transform_xy (item, x, 0, &x_real, &y_real);
if (x_real + CROSSHAIR < x1 || x_real - CROSSHAIR >= x2)
continue;
for (y = yoffset; y <= height; y += yspacing)
{
if (y < 0)
continue;
gimp_canvas_item_transform_xy (item, x, y, &x_real, &y_real);
if (y_real + CROSSHAIR < y1 || y_real - CROSSHAIR >= y2)
continue;
if (x_real >= x1 && x_real < x2)
{
cairo_move_to (cr,
x_real + 0.5,
CLAMP (y_real - CROSSHAIR,
y1, y2 - 1));
cairo_line_to (cr,
x_real + 0.5,
CLAMP (y_real + CROSSHAIR,
y1, y2 - 1) + 1);
}
if (y_real >= y1 && y_real < y2)
{
cairo_move_to (cr,
CLAMP (x_real - CROSSHAIR,
x1, x2 - 1),
y_real + 0.5);
cairo_line_to (cr,
CLAMP (x_real + CROSSHAIR,
x1, x2 - 1) + 1,
y_real + 0.5);
}
}
}
}
break;
case GIMP_GRID_ON_OFF_DASH:
case GIMP_GRID_DOUBLE_DASH:
case GIMP_GRID_SOLID:
gimp_canvas_item_transform_xy (item, 0, 0, &x0, &y0);
gimp_canvas_item_transform_xy (item, width, height, &x3, &y3);
if (vert)
{
for (x = xoffset; x < width; x += xspacing)
{
if (x < 0)
continue;
gimp_canvas_item_transform_xy (item, x, 0, &x_real, &y_real);
if (x_real >= x1 && x_real < x2)
{
cairo_move_to (cr, x_real + 0.5, y0);
cairo_line_to (cr, x_real + 0.5, y3 + 1);
}
}
}
if (horz)
{
for (y = yoffset; y < height; y += yspacing)
{
if (y < 0)
continue;
gimp_canvas_item_transform_xy (item, 0, y, &x_real, &y_real);
if (y_real >= y1 && y_real < y2)
{
cairo_move_to (cr, x0, y_real + 0.5);
cairo_line_to (cr, x3 + 1, y_real + 0.5);
}
}
}
break;
}
_gimp_canvas_item_stroke (item, cr);
}
static cairo_region_t *
gimp_canvas_grid_get_extents (GimpCanvasItem *item)
{
GimpImage *image = gimp_canvas_item_get_image (item);
cairo_rectangle_int_t rectangle;
gdouble x1, y1;
gdouble x2, y2;
gint w, h;
if (! image)
return NULL;
w = gimp_image_get_width (image);
h = gimp_image_get_height (image);
gimp_canvas_item_transform_xy_f (item, 0, 0, &x1, &y1);
gimp_canvas_item_transform_xy_f (item, w, h, &x2, &y2);
rectangle.x = floor (x1);
rectangle.y = floor (y1);
rectangle.width = ceil (x2) - rectangle.x;
rectangle.height = ceil (y2) - rectangle.y;
return cairo_region_create_rectangle (&rectangle);
}
static void
gimp_canvas_grid_stroke (GimpCanvasItem *item,
cairo_t *cr)
{
GimpCanvasGridPrivate *private = GET_PRIVATE (item);
if (private->grid_style)
{
GimpDisplayShell *shell = gimp_canvas_item_get_shell (item);
gimp_canvas_set_grid_style (gimp_canvas_item_get_canvas (item), cr,
private->grid,
shell->offset_x, shell->offset_y);
cairo_stroke (cr);
}
else
{
GIMP_CANVAS_ITEM_CLASS (parent_class)->stroke (item, cr);
}
}
GimpCanvasItem *
gimp_canvas_grid_new (GimpDisplayShell *shell,
GimpGrid *grid)
{
g_return_val_if_fail (GIMP_IS_DISPLAY_SHELL (shell), NULL);
g_return_val_if_fail (grid == NULL || GIMP_IS_GRID (grid), NULL);
return g_object_new (GIMP_TYPE_CANVAS_GRID,
"shell", shell,
"grid", grid,
NULL);
}