PIKApp/app/core/pikaimage-arrange.c

478 lines
16 KiB
C
Raw Permalink Normal View History

2023-09-26 00:35:21 +02:00
/* PIKA - Photo and Image Kooker Application
* a rebranding of The GNU Image Manipulation Program (created with heckimp)
* A derived work which may be trivial. However, any changes may be (C)2023 by Aldercone Studio
*
* Original copyright, applying to most contents (license remains unchanged):
* Copyright (C) 1995 Spencer Kimball and Peter Mattis
*
* 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 <gdk-pixbuf/gdk-pixbuf.h>
#include <gegl.h>
#include "libpikamath/pikamath.h"
#include "core-types.h"
#include "pikaimage.h"
#include "pikaimage-arrange.h"
#include "pikaimage-guides.h"
#include "pikaimage-undo.h"
#include "pikaitem.h"
#include "pikaguide.h"
#include "pikapickable.h"
#include "pikapickable-auto-shrink.h"
#include "pika-intl.h"
static void compute_offsets (GList *list,
gboolean use_x_offset,
gdouble align_x,
gdouble align_y,
gboolean align_contents);
static void compute_offset (GObject *object,
gboolean use_x_offset,
gdouble align_x,
gdouble align_y,
gboolean align_contents);
static gint offset_compare (gconstpointer a,
gconstpointer b);
/**
* pika_image_arrange_objects:
* @image: The #PikaImage to which the objects belong.
* @list: A #GList of objects to be aligned.
* @align_x: Relative X coordinate of point on each target object to bring into alignment.
* @align_y: Relative Y coordinate of point on each target object to bring into alignment.
* @reference: The #GObject to align the targets with, or %NULL.
* @reference_alignment: The point on the reference object to align the target item with..
* @align_contents: Take into account non-empty contents rather than item borders.
*
* This function shifts the positions of a set of target objects,
* which can be "items" or guides, to bring them into a specified type
* of alignment with a reference object, which can be an item, guide,
* or image. If the requested alignment does not make sense (i.e.,
* trying to align a vertical guide vertically), nothing happens and
* no error message is generated.
*
* The objects in the list are sorted into increasing order before
* being arranged, where the order is defined by the type of alignment
* being requested. If the @reference argument is %NULL, then the
* first object in the sorted list is used as reference.
*/
void
pika_image_arrange_objects (PikaImage *image,
GList *list,
gdouble align_x,
gdouble align_y,
GObject *reference,
PikaAlignmentType reference_alignment,
gboolean align_contents)
{
gdouble reference_x = 0.0;
gdouble reference_y = 0.0;
gboolean use_ref_x_offset = FALSE;
gboolean use_obj_x_offset = FALSE;
gboolean do_x = FALSE;
gboolean do_y = FALSE;
gint z0 = 0;
GList *object_list = NULL;
g_return_if_fail (PIKA_IS_IMAGE (image));
g_return_if_fail (G_IS_OBJECT (reference) || reference == NULL);
/* Create the base list, removing any item which has one of its ancestor also
* in the list (in such case, we only rearrange the ancestor item.
*/
for (GList *iter = list; iter; iter = iter->next)
{
GList *iter2 = NULL;
if (PIKA_IS_ITEM (iter->data))
{
for (iter2 = list; iter2; iter2 = iter2->next)
{
if (PIKA_IS_ITEM (iter2->data) &&
pika_viewable_is_ancestor (iter2->data, iter->data))
break;
}
}
if (iter2 == NULL)
object_list = g_list_prepend (object_list, iter->data);
}
/* get offsets used for sorting */
switch (reference_alignment)
{
/* order vertically for horizontal alignment */
case PIKA_ALIGN_LEFT:
case PIKA_ALIGN_HCENTER:
case PIKA_ALIGN_RIGHT:
if (PIKA_IS_GUIDE (reference) &&
pika_guide_get_orientation (PIKA_GUIDE (reference)) == PIKA_ORIENTATION_HORIZONTAL)
return;
use_obj_x_offset = TRUE;
use_ref_x_offset = TRUE;
if (reference_alignment == PIKA_ALIGN_HCENTER)
reference_x = 0.5;
else if (reference_alignment == PIKA_ALIGN_RIGHT)
reference_x = 1.0;
do_x = TRUE;
break;
/* order horizontally for horizontal arrangement */
case PIKA_ARRANGE_HFILL:
if (g_list_length (object_list) <= 2)
return;
use_obj_x_offset = TRUE;
use_ref_x_offset = TRUE;
do_x = TRUE;
break;
/* order horizontally for vertical alignment */
case PIKA_ALIGN_TOP:
case PIKA_ALIGN_VCENTER:
case PIKA_ALIGN_BOTTOM:
if (PIKA_IS_GUIDE (reference) &&
pika_guide_get_orientation (PIKA_GUIDE (reference)) == PIKA_ORIENTATION_VERTICAL)
return;
if (reference_alignment == PIKA_ALIGN_VCENTER)
reference_y = 0.5;
else if (reference_alignment == PIKA_ALIGN_BOTTOM)
reference_y = 1.0;
do_y = TRUE;
break;
/* order vertically for vertical arrangement */
case PIKA_ARRANGE_VFILL:
if (g_list_length (object_list) <= 2)
return;
do_y = TRUE;
break;
case PIKA_DISTRIBUTE_EVEN_HORIZONTAL_GAP:
use_obj_x_offset = TRUE;
do_x = TRUE;
case PIKA_DISTRIBUTE_EVEN_VERTICAL_GAP:
if (g_list_length (object_list) <= 2)
return;
if (! do_x)
do_y = TRUE;
/* Gap distribution does not use the anchor point. */
align_x = align_y = 0.0;
break;
default:
g_return_if_reached ();
}
/* get offsets used for sorting */
compute_offsets (object_list, use_obj_x_offset, align_x, align_y, align_contents);
/* Sort by offset. */
object_list = g_list_sort (object_list, offset_compare);
/* now get offsets used for aligning */
compute_offsets (object_list, use_obj_x_offset, align_x, align_y, align_contents);
if (object_list)
{
GList *list;
gint n;
gdouble fill_offset = 0;
if (reference_alignment == PIKA_ARRANGE_HFILL ||
reference_alignment == PIKA_ARRANGE_VFILL ||
reference_alignment == PIKA_DISTRIBUTE_EVEN_HORIZONTAL_GAP ||
reference_alignment == PIKA_DISTRIBUTE_EVEN_VERTICAL_GAP)
{
/* Distribution does not use the reference. Extreme coordinate items
* are used instead.
*/
GList *last_object = g_list_last (object_list);
gint distr_length;
z0 = GPOINTER_TO_INT (g_object_get_data (object_list->data, "align-offset"));
distr_length = GPOINTER_TO_INT (g_object_get_data (last_object->data, "align-offset")) - z0;
if (reference_alignment == PIKA_DISTRIBUTE_EVEN_HORIZONTAL_GAP ||
reference_alignment == PIKA_DISTRIBUTE_EVEN_VERTICAL_GAP)
{
for (list = object_list; list && list->next; list = g_list_next (list))
{
gint obj_len;
if (reference_alignment == PIKA_DISTRIBUTE_EVEN_HORIZONTAL_GAP)
obj_len = GPOINTER_TO_INT (g_object_get_data (list->data, "align-width"));
else
obj_len = GPOINTER_TO_INT (g_object_get_data (list->data, "align-height"));
distr_length -= obj_len;
/* Initial offset is at end of first object. */
if (list == object_list)
z0 += obj_len;
}
fill_offset = distr_length / (gdouble) (g_list_length (object_list) - 1);
}
else
{
fill_offset = distr_length / (gdouble) (g_list_length (object_list) - 1);
}
/* Removing first and last objects. These stay unmoved. */
object_list = g_list_delete_link (object_list, last_object);
object_list = g_list_delete_link (object_list, object_list);
}
else
{
if (reference == NULL)
{
reference = G_OBJECT (object_list->data);
object_list = g_list_delete_link (object_list, object_list);
}
/* Compute the offset for the reference (for alignment). */
compute_offset (reference, use_ref_x_offset, reference_x, reference_y, align_contents);
z0 = GPOINTER_TO_INT (g_object_get_data (reference, "align-offset"));
}
/* FIXME: undo group type is wrong */
pika_image_undo_group_start (image, PIKA_UNDO_GROUP_ITEM_DISPLACE,
C_("undo-type", "Arrange Objects"));
for (list = object_list, n = 1;
list;
list = g_list_next (list), n++)
{
GObject *target = list->data;
gint xtranslate = 0;
gint ytranslate = 0;
gint z1;
z1 = GPOINTER_TO_INT (g_object_get_data (target, "align-offset"));
if (reference_alignment == PIKA_ARRANGE_HFILL)
{
xtranslate = ROUND (z0 - z1 + n * fill_offset);
}
else if (reference_alignment == PIKA_ARRANGE_VFILL)
{
ytranslate = ROUND (z0 - z1 + n * fill_offset);
}
else if (reference_alignment == PIKA_DISTRIBUTE_EVEN_HORIZONTAL_GAP)
{
gint obj_len;
xtranslate = ROUND (z0 + fill_offset - z1);
obj_len = GPOINTER_TO_INT (g_object_get_data (target, "align-width"));
z0 = z0 + fill_offset + obj_len;
}
else if (reference_alignment == PIKA_DISTRIBUTE_EVEN_VERTICAL_GAP)
{
gint obj_len;
ytranslate = ROUND (z0 + fill_offset - z1);
obj_len = GPOINTER_TO_INT (g_object_get_data (target, "align-height"));
z0 = z0 + fill_offset + obj_len;
}
else /* the normal computing, when we don't depend on the
* width or height of the reference object
*/
{
if (do_x)
xtranslate = z0 - z1;
if (do_y)
ytranslate = z0 - z1;
}
/* now actually align the target object */
if (PIKA_IS_ITEM (target))
{
pika_item_translate (PIKA_ITEM (target),
xtranslate, ytranslate, TRUE);
}
else if (PIKA_IS_GUIDE (target))
{
PikaGuide *guide = PIKA_GUIDE (target);
switch (pika_guide_get_orientation (guide))
{
case PIKA_ORIENTATION_VERTICAL:
pika_image_move_guide (image, guide, z1 + xtranslate, TRUE);
break;
case PIKA_ORIENTATION_HORIZONTAL:
pika_image_move_guide (image, guide, z1 + ytranslate, TRUE);
break;
default:
break;
}
}
}
pika_image_undo_group_end (image);
}
g_list_free (object_list);
}
static gint
offset_compare (gconstpointer a,
gconstpointer b)
{
gint offset1 = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (a),
"align-offset"));
gint offset2 = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (b),
"align-offset"));
return offset1 - offset2;
}
/* this function computes the position of the alignment point
* for each object in the list, and attaches it to the
* object as object data.
*/
static void
compute_offsets (GList *list,
gboolean use_x_offset,
gdouble align_x,
gdouble align_y,
gboolean align_contents)
{
GList *l;
for (l = list; l; l = g_list_next (l))
compute_offset (l->data, use_x_offset, align_x, align_y, align_contents);
}
static void
compute_offset (GObject *object,
gboolean use_x_offset,
gdouble align_x,
gdouble align_y,
gboolean align_contents)
{
gint object_offset_x = 0;
gint object_offset_y = 0;
gint object_height = 0;
gint object_width = 0;
gint offset = 0;
if (PIKA_IS_IMAGE (object))
{
PikaImage *image = PIKA_IMAGE (object);
object_offset_x = 0;
object_offset_y = 0;
object_height = pika_image_get_height (image);
object_width = pika_image_get_width (image);
}
else if (PIKA_IS_ITEM (object))
{
PikaItem *item = PIKA_ITEM (object);
gint off_x, off_y;
pika_item_bounds (item,
&object_offset_x,
&object_offset_y,
&object_width,
&object_height);
if (align_contents && PIKA_IS_PICKABLE (object))
{
gint x;
gint y;
gint width;
gint height;
if (pika_pickable_auto_shrink (PIKA_PICKABLE (object),
0, 0,
pika_item_get_width (PIKA_ITEM (object)),
pika_item_get_height (PIKA_ITEM (object)),
&x, &y, &width, &height) == PIKA_AUTO_SHRINK_SHRINK)
{
object_offset_x += x;
object_offset_y += y;
object_width = width;
object_height = height;
}
}
pika_item_get_offset (item, &off_x, &off_y);
object_offset_x += off_x;
object_offset_y += off_y;
}
else if (PIKA_IS_GUIDE (object))
{
PikaGuide *guide = PIKA_GUIDE (object);
switch (pika_guide_get_orientation (guide))
{
case PIKA_ORIENTATION_VERTICAL:
object_offset_x = pika_guide_get_position (guide);
object_width = 0;
break;
case PIKA_ORIENTATION_HORIZONTAL:
object_offset_y = pika_guide_get_position (guide);
object_height = 0;
break;
default:
break;
}
}
else
{
g_printerr ("Alignment object is not an image, item or guide.\n");
}
if (use_x_offset)
offset = object_offset_x + object_width * align_x;
else
offset = object_offset_y + object_height * align_y;
g_object_set_data (object, "align-offset",
GINT_TO_POINTER (offset));
/* These are only used for HFILL and VFILL, but since the call to
* pika_image_arrange_objects allows for two different alignments
* (object and reference_alignment) we better be on the safe side in
* case they differ. (the current implementation of the align tool
* always pass the same value to both parameters)
*/
g_object_set_data (object, "align-width",
GINT_TO_POINTER (object_width));
g_object_set_data (object, "align-height",
GINT_TO_POINTER (object_height));
}