PIKApp/plug-ins/common/align-layers.c

790 lines
24 KiB
C
Raw Normal View History

2023-09-26 00:35:21 +02:00
/* align_layers.c
* Author: Shuji Narazaki <narazaki@InetQ.or.jp>
* Version: 0.26
*
* Copyright (C) 1997-1998 Shuji Narazaki <narazaki@InetQ.or.jp>
*
* 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 <libpika/pika.h>
#include <libpika/pikaui.h>
#include "libpika/stdplugins-intl.h"
#define PLUG_IN_PROC "plug-in-align-layers"
#define PLUG_IN_BINARY "align-layers"
#define PLUG_IN_ROLE "pika-align-layers"
enum
{
H_NONE,
H_COLLECT,
LEFT2RIGHT,
RIGHT2LEFT,
SNAP2HGRID
};
enum
{
H_BASE_LEFT,
H_BASE_CENTER,
H_BASE_RIGHT
};
enum
{
V_NONE,
V_COLLECT,
TOP2BOTTOM,
BOTTOM2TOP,
SNAP2VGRID
};
enum
{
V_BASE_TOP,
V_BASE_CENTER,
V_BASE_BOTTOM
};
typedef struct
{
gint step_x;
gint step_y;
gint base_x;
gint base_y;
} AlignData;
typedef struct _AlignLayers AlignLayers;
typedef struct _AlignLayersClass AlignLayersClass;
struct _AlignLayers
{
PikaPlugIn parent_instance;
};
struct _AlignLayersClass
{
PikaPlugInClass parent_class;
};
#define ALIGN_LAYERS_TYPE (align_layers_get_type ())
2023-10-30 23:55:30 +01:00
#define ALIGN_LAYERS(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), ALIGN_LAYERS_TYPE, AlignLayers))
2023-09-26 00:35:21 +02:00
GType align_layers_get_type (void) G_GNUC_CONST;
static GList * align_layers_query_procedures (PikaPlugIn *plug_in);
static PikaProcedure * align_layers_create_procedure (PikaPlugIn *plug_in,
const gchar *name);
static PikaValueArray * align_layers_run (PikaProcedure *procedure,
PikaRunMode run_mode,
PikaImage *image,
gint n_drawables,
PikaDrawable **drawables,
2023-10-30 23:55:30 +01:00
PikaProcedureConfig *config,
2023-09-26 00:35:21 +02:00
gpointer run_data);
/* Main function */
static PikaPDBStatusType align_layers (PikaImage *image,
GObject *config);
/* Helpers and internal functions */
static gint align_layers_count_visibles_layers (GList *layers);
static PikaLayer * align_layers_find_last_layer (GList *layers,
gboolean *found);
static gint align_layers_spread_visibles_layers (GList *layers,
PikaLayer **layers_array);
static PikaLayer ** align_layers_spread_image (PikaImage *image,
gint *layer_num);
static PikaLayer * align_layers_find_background (PikaImage *image);
static AlignData align_layers_gather_data (PikaLayer **layers,
gint layer_num,
PikaLayer *background,
GObject *config);
static void align_layers_perform_alignment (PikaLayer **layers,
gint layer_num,
AlignData data,
GObject *config);
static void align_layers_get_align_offsets (PikaDrawable *drawable,
gint *x,
gint *y,
GObject *config);
static gint align_layers_dialog (PikaProcedure *procedure,
GObject *config);
G_DEFINE_TYPE (AlignLayers, align_layers, PIKA_TYPE_PLUG_IN)
PIKA_MAIN (ALIGN_LAYERS_TYPE)
DEFINE_STD_SET_I18N
static void
align_layers_class_init (AlignLayersClass *klass)
{
PikaPlugInClass *plug_in_class = PIKA_PLUG_IN_CLASS (klass);
plug_in_class->query_procedures = align_layers_query_procedures;
plug_in_class->create_procedure = align_layers_create_procedure;
plug_in_class->set_i18n = STD_SET_I18N;
}
static void
align_layers_init (AlignLayers *film)
{
}
static GList *
align_layers_query_procedures (PikaPlugIn *plug_in)
{
return g_list_append (NULL, g_strdup (PLUG_IN_PROC));
}
static PikaProcedure *
align_layers_create_procedure (PikaPlugIn *plug_in,
const gchar *name)
{
PikaProcedure *procedure = NULL;
if (! strcmp (name, PLUG_IN_PROC))
{
procedure = pika_image_procedure_new (plug_in, name,
PIKA_PDB_PROC_TYPE_PLUGIN,
align_layers_run, NULL, NULL);
pika_procedure_set_image_types (procedure, "*");
pika_procedure_set_sensitivity_mask (procedure,
PIKA_PROCEDURE_SENSITIVE_DRAWABLE |
PIKA_PROCEDURE_SENSITIVE_DRAWABLES |
PIKA_PROCEDURE_SENSITIVE_NO_DRAWABLES);
pika_procedure_set_menu_label (procedure, _("Align Visi_ble Layers..."));
pika_procedure_add_menu_path (procedure, "<Image>/Image/[Arrange]");
pika_procedure_set_documentation (procedure,
_("Align all visible layers of the image"),
"Align visible layers",
name);
pika_procedure_set_attribution (procedure,
"Shuji Narazaki <narazaki@InetQ.or.jp>",
"Shuji Narazaki",
"1997");
PIKA_PROC_ARG_INT (procedure, "horizontal-style",
_("_Horizontal style"),
_("(None = 0, Collect = 1, "
"Fill left to right = 2, Fill right to left = 3, "
"Snap to grid = 4)"),
H_NONE, SNAP2HGRID, H_NONE,
PIKA_PARAM_READWRITE);
PIKA_PROC_ARG_INT (procedure, "horizontal-base",
_("Hori_zontal base"),
_("(Left edge = 0, Center = 1, "
"Right edge = 2)"),
H_BASE_LEFT, H_BASE_RIGHT, H_BASE_LEFT,
PIKA_PARAM_READWRITE);
PIKA_PROC_ARG_INT (procedure, "vertical-style",
_("_Vertical style"),
_("(None = 0, Collect = 1, "
"Fill left to right = 2, Fill right to left = 3, "
"Snap to grid = 4)"),
V_NONE, SNAP2VGRID, V_NONE,
PIKA_PARAM_READWRITE);
PIKA_PROC_ARG_INT (procedure, "vertical-base",
_("Ver_tical base"),
_("(Left edge = 0, Center = 1, "
"Right edge = 2)"),
V_BASE_TOP, V_BASE_BOTTOM, V_BASE_TOP,
PIKA_PARAM_READWRITE);
PIKA_PROC_ARG_INT (procedure, "grid-size",
_("_Grid"),
_("Grid"),
1, 200, 10,
PIKA_PARAM_READWRITE);
PIKA_PROC_ARG_BOOLEAN (procedure,
"ignore-bottom-layer",
_("Ignore the _bottom layer even if visible"),
_("Ignore the bottom layer even if visible"),
TRUE,
G_PARAM_READWRITE);
PIKA_PROC_ARG_BOOLEAN (procedure,
"use-bottom-layer",
_("_Use the (invisible) bottom layer as the base"),
_("Use the (invisible) bottom layer as the base"),
FALSE,
G_PARAM_READWRITE);
/* TODO: these 2 arguments existed in the original procedure but
* were actually unused. If we want to keep them, let's at least
* implement the documented behavior, or else let's just drop
* them.
*/
/*
PIKA_PROC_ARG_BOOLEAN (procedure,
"link-after-alignment",
"Link the visible layers after alignment",
FALSE,
G_PARAM_READWRITE);
PIKA_PROC_ARG_BOOLEAN (procedure,
"use-bottom",
"use the bottom layer as the base of alignment",
TRUE,
G_PARAM_READWRITE);
*/
}
return procedure;
}
static PikaValueArray *
align_layers_run (PikaProcedure *procedure,
PikaRunMode run_mode,
PikaImage *image,
gint n_drawables,
PikaDrawable **drawables,
2023-10-30 23:55:30 +01:00
PikaProcedureConfig *config,
2023-09-26 00:35:21 +02:00
gpointer run_data)
{
2023-10-30 23:55:30 +01:00
PikaValueArray *return_vals = NULL;
PikaPDBStatusType status = PIKA_PDB_EXECUTION_ERROR;
GError *error = NULL;
GList *layers;
gint layer_num;
2023-09-26 00:35:21 +02:00
switch ( run_mode )
{
case PIKA_RUN_INTERACTIVE:
layers = pika_image_list_layers (image);
layer_num = align_layers_count_visibles_layers (layers);
g_list_free (layers);
if (layer_num < 2)
{
g_set_error (&error, PIKA_PLUG_IN_ERROR, 0,
_("There are not enough layers to align."));
return pika_procedure_new_return_values (procedure,
PIKA_PDB_CALLING_ERROR,
error);
}
if (! align_layers_dialog (procedure, G_OBJECT (config)))
status = PIKA_PDB_CANCEL;
break;
case PIKA_RUN_NONINTERACTIVE:
case PIKA_RUN_WITH_LAST_VALS:
break;
}
if (status != PIKA_PDB_CANCEL)
{
status = align_layers (image, G_OBJECT (config));
if (run_mode != PIKA_RUN_NONINTERACTIVE)
pika_displays_flush ();
}
2023-10-30 23:55:30 +01:00
return_vals = pika_procedure_new_return_values (procedure, status, error);
2023-09-26 00:35:21 +02:00
return return_vals;
}
/*
* Main function
*/
static PikaPDBStatusType
align_layers (PikaImage *image,
GObject *config)
{
gint layer_num = 0;
PikaLayer **layers = NULL;
PikaLayer *background = 0;
AlignData data;
gboolean ignore_bottom_layer;
g_object_get (config,
"ignore-bottom-layer", &ignore_bottom_layer,
NULL);
layers = align_layers_spread_image (image, &layer_num);
if (layer_num < 2)
{
g_free (layers);
return PIKA_PDB_EXECUTION_ERROR;
}
background = align_layers_find_background (image);
/* If we want to ignore the bottom layer and if it's visible */
if (ignore_bottom_layer && background == layers[layer_num - 1])
{
layer_num--;
}
data = align_layers_gather_data (layers,
layer_num,
background,
config);
pika_image_undo_group_start (image);
align_layers_perform_alignment (layers,
layer_num,
data,
config);
pika_image_undo_group_end (image);
g_free (layers);
return PIKA_PDB_SUCCESS;
}
/*
* Find the bottommost layer, visible or not
* The image must contain at least one layer.
*/
static PikaLayer *
align_layers_find_last_layer (GList *layers,
gboolean *found)
{
GList *last = g_list_last (layers);
for (; last; last = last->prev)
{
PikaItem *item = last->data;
if (pika_item_is_group (item))
{
GList *children;
PikaLayer *last_layer;
children = pika_item_list_children (item);
last_layer = align_layers_find_last_layer (children,
found);
g_list_free (children);
if (*found)
return last_layer;
}
else if (pika_item_is_layer (item))
{
*found = TRUE;
return PIKA_LAYER (item);
}
}
/* should never happen */
return NULL;
}
/*
* Return the bottom layer.
*/
static PikaLayer *
align_layers_find_background (PikaImage *image)
{
GList *layers;
PikaLayer *background;
gboolean found = FALSE;
layers = pika_image_list_layers (image);
background = align_layers_find_last_layer (layers, &found);
g_list_free (layers);
return background;
}
/*
* Fill layers_array with all visible layers.
* layers_array needs to be allocated before the call
*/
static gint
align_layers_spread_visibles_layers (GList *layers,
PikaLayer **layers_array)
{
GList *iter;
gint index = 0;
for (iter = layers; iter; iter = iter->next)
{
PikaItem *item = iter->data;
if (pika_item_get_visible (item))
{
if (pika_item_is_group (item))
{
GList *children;
children = pika_item_list_children (item);
index += align_layers_spread_visibles_layers (children,
&(layers_array[index]));
g_list_free (children);
}
else if (pika_item_is_layer (item))
{
layers_array[index] = PIKA_LAYER (item);
index++;
}
}
}
return index;
}
/*
* Return a contiguous array of all visible layers
*/
static PikaLayer **
align_layers_spread_image (PikaImage *image,
gint *layer_num)
{
GList *layers;
PikaLayer **layers_array;
layers = pika_image_list_layers (image);
*layer_num = align_layers_count_visibles_layers (layers);
layers_array = g_malloc (sizeof (PikaLayer *) * *layer_num);
align_layers_spread_visibles_layers (layers,
layers_array);
g_list_free (layers);
return layers_array;
}
static gint
align_layers_count_visibles_layers (GList *layers)
{
GList *iter;
gint count = 0;
for (iter = layers; iter; iter = iter->next)
{
PikaItem *item = iter->data;
if (pika_item_get_visible (item))
{
if (pika_item_is_group (item))
{
GList *children;
children = pika_item_list_children (item);
count += align_layers_count_visibles_layers (children);
g_list_free (children);
}
else if (pika_item_is_layer (item))
{
count += 1;
}
}
}
return count;
}
static AlignData
align_layers_gather_data (PikaLayer **layers,
gint layer_num,
PikaLayer *background,
GObject *config)
{
AlignData data;
gint min_x = G_MAXINT;
gint min_y = G_MAXINT;
gint max_x = G_MININT;
gint max_y = G_MININT;
gint index;
gint orig_x = 0;
gint orig_y = 0;
gint offset_x = 0;
gint offset_y = 0;
gint horizontal_style;
gint vertical_style;
gboolean use_bottom_layer;
g_object_get (config,
"horizontal-style", &horizontal_style,
"vertical-style", &vertical_style,
"use-bottom-layer", &use_bottom_layer,
NULL);
data.step_x = 0;
data.step_y = 0;
data.base_x = 0;
data.base_y = 0;
/* 0 is the top layer */
for (index = 0; index < layer_num; index++)
{
pika_drawable_get_offsets (PIKA_DRAWABLE (layers[index]), &orig_x, &orig_y);
align_layers_get_align_offsets (PIKA_DRAWABLE (layers[index]),
&offset_x,
&offset_y,
config);
orig_x += offset_x;
orig_y += offset_y;
min_x = MIN (min_x, orig_x);
max_x = MAX (max_x, orig_x);
min_y = MIN (min_y, orig_y);
max_y = MAX (max_y, orig_y);
}
if (use_bottom_layer)
{
pika_drawable_get_offsets (PIKA_DRAWABLE (background), &orig_x, &orig_y);
align_layers_get_align_offsets (PIKA_DRAWABLE (background),
&offset_x,
&offset_y,
config);
orig_x += offset_x;
orig_y += offset_y;
data.base_x = min_x = orig_x;
data.base_y = min_y = orig_y;
}
if (layer_num > 1)
{
data.step_x = (max_x - min_x) / (layer_num - 1);
data.step_y = (max_y - min_y) / (layer_num - 1);
}
if ((horizontal_style == LEFT2RIGHT) || (horizontal_style == RIGHT2LEFT))
data.base_x = min_x;
if ((vertical_style == TOP2BOTTOM) || (vertical_style == BOTTOM2TOP))
data.base_y = min_y;
return data;
}
/*
* Modifies position of each visible layers
* according to data.
*/
static void
align_layers_perform_alignment (PikaLayer **layers,
gint layer_num,
AlignData data,
GObject *config)
{
gint index;
gint horizontal_style;
gint vertical_style;
gint grid_size;
g_object_get (config,
"horizontal-style", &horizontal_style,
"vertical-style", &vertical_style,
"grid-size", &grid_size,
NULL);
for (index = 0; index < layer_num; index++)
{
gint x = 0;
gint y = 0;
gint orig_x;
gint orig_y;
gint offset_x;
gint offset_y;
pika_drawable_get_offsets (PIKA_DRAWABLE (layers[index]), &orig_x, &orig_y);
align_layers_get_align_offsets (PIKA_DRAWABLE (layers[index]),
&offset_x,
&offset_y,
config);
switch (horizontal_style)
{
case H_NONE:
x = orig_x;
break;
case H_COLLECT:
x = data.base_x - offset_x;
break;
case LEFT2RIGHT:
x = (data.base_x + index * data.step_x) - offset_x;
break;
case RIGHT2LEFT:
x = (data.base_x + (layer_num - index - 1) * data.step_x) - offset_x;
break;
case SNAP2HGRID:
x = grid_size
* (int) ((orig_x + offset_x + grid_size /2) / grid_size)
- offset_x;
break;
}
switch (vertical_style)
{
case V_NONE:
y = orig_y;
break;
case V_COLLECT:
y = data.base_y - offset_y;
break;
case TOP2BOTTOM:
y = (data.base_y + index * data.step_y) - offset_y;
break;
case BOTTOM2TOP:
y = (data.base_y + (layer_num - index - 1) * data.step_y) - offset_y;
break;
case SNAP2VGRID:
y = grid_size
* (int) ((orig_y + offset_y + grid_size / 2) / grid_size)
- offset_y;
break;
}
pika_layer_set_offsets (layers[index], x, y);
}
}
static void
align_layers_get_align_offsets (PikaDrawable *drawable,
gint *x,
gint *y,
GObject *config)
{
gint width = pika_drawable_get_width (drawable);
gint height = pika_drawable_get_height (drawable);
gint horizontal_base;
gint vertical_base;
g_object_get (config,
"horizontal-base", &horizontal_base,
"vertical-base", &vertical_base,
NULL);
switch (horizontal_base)
{
case H_BASE_LEFT:
*x = 0;
break;
case H_BASE_CENTER:
*x = width / 2;
break;
case H_BASE_RIGHT:
*x = width;
break;
default:
*x = 0;
break;
}
switch (vertical_base)
{
case V_BASE_TOP:
*y = 0;
break;
case V_BASE_CENTER:
*y = height / 2;
break;
case V_BASE_BOTTOM:
*y = height;
break;
default:
*y = 0;
break;
}
}
static int
align_layers_dialog (PikaProcedure *procedure,
GObject *config)
{
GtkWidget *dialog;
GtkListStore *store;
gboolean run;
pika_ui_init (PLUG_IN_BINARY);
dialog = pika_procedure_dialog_new (procedure,
PIKA_PROCEDURE_CONFIG (config),
_("Align Visible Layers"));
pika_dialog_set_alternative_button_order (GTK_DIALOG (dialog),
GTK_RESPONSE_OK,
GTK_RESPONSE_CANCEL,
-1);
pika_window_set_transient (GTK_WINDOW (dialog));
store = pika_int_store_new (_("None"), H_NONE,
_("Collect"), H_COLLECT,
_("Fill (left to right)"), LEFT2RIGHT,
_("Fill (right to left)"), RIGHT2LEFT,
_("Snap to grid"), SNAP2HGRID,
NULL);
pika_procedure_dialog_get_int_combo (PIKA_PROCEDURE_DIALOG (dialog),
"horizontal-style",
PIKA_INT_STORE (store));
store = pika_int_store_new (_("Left edge"), H_BASE_LEFT,
_("Center"), H_BASE_CENTER,
_("Right edge"), H_BASE_RIGHT,
NULL);
pika_procedure_dialog_get_int_combo (PIKA_PROCEDURE_DIALOG (dialog),
"horizontal-base",
PIKA_INT_STORE (store));
store = pika_int_store_new (_("None"), V_NONE,
_("Collect"), V_COLLECT,
_("Fill (top to bottom)"), TOP2BOTTOM,
_("Fill (bottom to top)"), BOTTOM2TOP,
_("Snap to grid"), SNAP2VGRID,
NULL);
pika_procedure_dialog_get_int_combo (PIKA_PROCEDURE_DIALOG (dialog),
"vertical-style",
PIKA_INT_STORE (store));
store = pika_int_store_new (_("Top edge"), V_BASE_TOP,
_("Center"), V_BASE_CENTER,
_("Bottom edge"), V_BASE_BOTTOM,
NULL);
pika_procedure_dialog_get_int_combo (PIKA_PROCEDURE_DIALOG (dialog),
"vertical-base",
PIKA_INT_STORE (store));
pika_procedure_dialog_get_scale_entry (PIKA_PROCEDURE_DIALOG (dialog),
"grid-size", 1.0);
pika_procedure_dialog_fill (PIKA_PROCEDURE_DIALOG (dialog),
NULL);
gtk_widget_show (dialog);
run = pika_procedure_dialog_run (PIKA_PROCEDURE_DIALOG (dialog));
gtk_widget_destroy (dialog);
return run;
}