gimp/app/core/gimpgrouplayer.c

/* GIMP - The GNU Image Manipulation Program
 * Copyright (C) 1995 Spencer Kimball and Peter Mattis
 *
 * GimpGroupLayer
 * Copyright (C) 2009  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 <string.h>

#include <gegl.h>

#include "libgimpbase/gimpbase.h"

#include "core-types.h"

#include "base/tile-manager.h"

#include "gimpgrouplayer.h"
#include "gimpimage.h"
#include "gimpdrawablestack.h"
#include "gimppickable.h"
#include "gimpprojectable.h"
#include "gimpprojection.h"

#include "gimp-intl.h"


enum
{
  PROP_0,
  PROP_LOCK_CONTENT
};


static void            gimp_projectable_iface_init   (GimpProjectableInterface  *iface);

static void            gimp_group_layer_set_property (GObject         *object,
                                                      guint            property_id,
                                                      const GValue    *value,
                                                      GParamSpec      *pspec);
static void            gimp_group_layer_get_property (GObject         *object,
                                                      guint            property_id,
                                                      GValue          *value,
                                                      GParamSpec      *pspec);
static void            gimp_group_layer_finalize     (GObject         *object);

static gint64          gimp_group_layer_get_memsize  (GimpObject      *object,
                                                      gint64          *gui_size);

static GimpContainer * gimp_group_layer_get_children (GimpViewable    *viewable);

static GimpItem      * gimp_group_layer_duplicate    (GimpItem        *item,
                                                      GType            new_type);
static void            gimp_group_layer_convert      (GimpItem        *item,
                                                      GimpImage       *dest_image);
static void            gimp_group_layer_translate    (GimpItem        *item,
                                                      gint             offset_x,
                                                      gint             offset_y,
                                                      gboolean         push_undo);
static void            gimp_group_layer_scale        (GimpItem        *item,
                                                      gint             new_width,
                                                      gint             new_height,
                                                      gint             new_offset_x,
                                                      gint             new_offset_y,
                                                      GimpInterpolationType  interp_type,
                                                      GimpProgress    *progress);
static void            gimp_group_layer_resize       (GimpItem        *item,
                                                      GimpContext     *context,
                                                      gint             new_width,
                                                      gint             new_height,
                                                      gint             offset_x,
                                                      gint             offset_y);
static void            gimp_group_layer_flip         (GimpItem        *item,
                                                      GimpContext     *context,
                                                      GimpOrientationType flip_type,
                                                      gdouble          axis,
                                                      gboolean         clip_result);
static void            gimp_group_layer_rotate       (GimpItem        *item,
                                                      GimpContext     *context,
                                                      GimpRotationType rotate_type,
                                                      gdouble          center_x,
                                                      gdouble          center_y,
                                                      gboolean         clip_result);
static void            gimp_group_layer_transform    (GimpItem        *item,
                                                      GimpContext     *context,
                                                      const GimpMatrix3 *matrix,
                                                      GimpTransformDirection direction,
                                                      GimpInterpolationType  interpolation_type,
                                                      gint             recursion_level,
                                                      GimpTransformResize clip_result,
                                                      GimpProgress    *progress);

static GeglNode      * gimp_group_layer_get_graph    (GimpProjectable *projectable);
static GList         * gimp_group_layer_get_layers   (GimpProjectable *projectable);

static void            gimp_group_layer_child_add    (GimpContainer   *container,
                                                      GimpLayer       *child,
                                                      GimpGroupLayer  *group);
static void            gimp_group_layer_child_remove (GimpContainer   *container,
                                                      GimpLayer       *child,
                                                      GimpGroupLayer  *group);
static void            gimp_group_layer_child_move   (GimpLayer       *child,
                                                      GParamSpec      *pspec,
                                                      GimpGroupLayer  *group);
static void            gimp_group_layer_child_resize (GimpLayer       *child,
                                                      GimpGroupLayer  *group);

static void            gimp_group_layer_update_size  (GimpGroupLayer    *group);

static void            gimp_group_layer_stack_update (GimpDrawableStack *stack,
                                                      gint               x,
                                                      gint               y,
                                                      gint               width,
                                                      gint               height,
                                                      GimpGroupLayer    *group);
static void            gimp_group_layer_proj_update  (GimpProjection    *proj,
                                                      gboolean           now,
                                                      gint               x,
                                                      gint               y,
                                                      gint               width,
                                                      gint               height,
                                                      GimpGroupLayer    *group);


G_DEFINE_TYPE_WITH_CODE (GimpGroupLayer, gimp_group_layer, GIMP_TYPE_LAYER,
                         G_IMPLEMENT_INTERFACE (GIMP_TYPE_PROJECTABLE,
                                                gimp_projectable_iface_init))

#define parent_class gimp_group_layer_parent_class


static void
gimp_group_layer_class_init (GimpGroupLayerClass *klass)
{
  GObjectClass      *object_class      = G_OBJECT_CLASS (klass);
  GimpObjectClass   *gimp_object_class = GIMP_OBJECT_CLASS (klass);
  GimpViewableClass *viewable_class    = GIMP_VIEWABLE_CLASS (klass);
  GimpItemClass     *item_class        = GIMP_ITEM_CLASS (klass);

  object_class->set_property       = gimp_group_layer_set_property;
  object_class->get_property       = gimp_group_layer_get_property;
  object_class->finalize           = gimp_group_layer_finalize;

  gimp_object_class->get_memsize   = gimp_group_layer_get_memsize;

  viewable_class->default_stock_id = "gtk-directory";
  viewable_class->get_children     = gimp_group_layer_get_children;

  item_class->duplicate            = gimp_group_layer_duplicate;
  item_class->convert              = gimp_group_layer_convert;
  item_class->translate            = gimp_group_layer_translate;
  item_class->scale                = gimp_group_layer_scale;
  item_class->resize               = gimp_group_layer_resize;
  item_class->flip                 = gimp_group_layer_flip;
  item_class->rotate               = gimp_group_layer_rotate;
  item_class->transform            = gimp_group_layer_transform;

  item_class->default_name         = _("Group Layer");
  item_class->rename_desc          = _("Rename Group Layer");
  item_class->translate_desc       = _("Move Group Layer");
  item_class->scale_desc           = _("Scale Group Layer");
  item_class->resize_desc          = _("Resize Group Layer");
  item_class->flip_desc            = _("Flip Group Layer");
  item_class->rotate_desc          = _("Rotate Group Layer");
  item_class->transform_desc       = _("Transform Group Layer");

  g_object_class_install_property (object_class, PROP_LOCK_CONTENT,
                                   g_param_spec_boolean ("lock-content",
                                                         NULL, NULL,
                                                         TRUE,
                                                         GIMP_PARAM_READABLE));
}

static void
gimp_projectable_iface_init (GimpProjectableInterface *iface)
{
  iface->get_image          = (GimpImage * (*) (GimpProjectable *)) gimp_item_get_image;
  iface->get_offset         = (void (*) (GimpProjectable*, gint*, gint*)) gimp_item_get_offset;
  iface->get_size           = (void (*) (GimpProjectable*, gint*, gint*)) gimp_viewable_get_size;
  iface->get_graph          = gimp_group_layer_get_graph;
  iface->invalidate_preview = (void (*) (GimpProjectable*)) gimp_viewable_invalidate_preview;
  iface->get_layers         = gimp_group_layer_get_layers;
  iface->get_channels       = NULL;
}

static void
gimp_group_layer_init (GimpGroupLayer *group)
{
  GIMP_ITEM (group)->lock_content = TRUE;

  group->children = gimp_drawable_stack_new (GIMP_TYPE_LAYER);

  g_signal_connect (group->children, "add",
                    G_CALLBACK (gimp_group_layer_child_add),
                    group);
  g_signal_connect (group->children, "remove",
                    G_CALLBACK (gimp_group_layer_child_remove),
                    group);

  gimp_container_add_handler (group->children, "notify::offset-x",
                              G_CALLBACK (gimp_group_layer_child_move),
                              group);
  gimp_container_add_handler (group->children, "notify::offset-y",
                              G_CALLBACK (gimp_group_layer_child_move),
                              group);
  gimp_container_add_handler (group->children, "size-changed",
                              G_CALLBACK (gimp_group_layer_child_resize),
                              group);

  g_signal_connect (group->children, "update",
                    G_CALLBACK (gimp_group_layer_stack_update),
                    group);

  group->projection = gimp_projection_new (GIMP_PROJECTABLE (group));

  g_signal_connect (group->projection, "update",
                    G_CALLBACK (gimp_group_layer_proj_update),
                    group);
}

static void
gimp_group_layer_set_property (GObject      *object,
                               guint         property_id,
                               const GValue *value,
                               GParamSpec   *pspec)
{
  switch (property_id)
    {
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
      break;
    }
}

static void
gimp_group_layer_get_property (GObject    *object,
                               guint       property_id,
                               GValue     *value,
                               GParamSpec *pspec)
{
  GimpItem *item = GIMP_ITEM (object);

  switch (property_id)
    {
    case PROP_LOCK_CONTENT:
      g_value_set_boolean (value, gimp_item_get_lock_content (item));
      break;

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

static void
gimp_group_layer_finalize (GObject *object)
{
  GimpGroupLayer *group = GIMP_GROUP_LAYER (object);

  if (group->children)
    {
      g_signal_handlers_disconnect_by_func (group->children,
                                            gimp_group_layer_child_add,
                                            group);
      g_signal_handlers_disconnect_by_func (group->children,
                                            gimp_group_layer_child_remove,
                                            group);
      g_signal_handlers_disconnect_by_func (group->children,
                                            gimp_group_layer_stack_update,
                                            group);

      g_object_unref (group->children);
      group->children = NULL;
    }

  if (group->projection)
    {
      g_object_unref (group->projection);
      group->projection = NULL;
    }

  if (group->graph)
    {
      g_object_unref (group->graph);
      group->graph = NULL;
    }

  G_OBJECT_CLASS (parent_class)->finalize (object);
}

static gint64
gimp_group_layer_get_memsize (GimpObject *object,
                              gint64     *gui_size)
{
  GimpGroupLayer *group   = GIMP_GROUP_LAYER (object);
  gint64          memsize = 0;

  memsize += gimp_object_get_memsize (GIMP_OBJECT (group->children), gui_size);

  return memsize + GIMP_OBJECT_CLASS (parent_class)->get_memsize (object,
                                                                  gui_size);
}

static GimpContainer *
gimp_group_layer_get_children (GimpViewable *viewable)
{
  GimpGroupLayer *group = GIMP_GROUP_LAYER (viewable);

  return group->children;
}

static GimpItem *
gimp_group_layer_duplicate (GimpItem *item,
                            GType     new_type)
{
  GimpItem *new_item;

  g_return_val_if_fail (g_type_is_a (new_type, GIMP_TYPE_GROUP_LAYER), NULL);

  new_item = GIMP_ITEM_CLASS (parent_class)->duplicate (item, new_type);

  if (GIMP_IS_GROUP_LAYER (new_item))
    {
      GimpGroupLayer *group     = GIMP_GROUP_LAYER (item);
      GimpGroupLayer *new_group = GIMP_GROUP_LAYER (new_item);
      GList          *list;
      gint            position;

      for (list = GIMP_LIST (group->children)->list, position = 0;
           list;
           list = g_list_next (list), position++)
        {
          GimpItem *child = list->data;
          GimpItem *new_child;

          new_child = gimp_item_duplicate (child, G_TYPE_FROM_INSTANCE (child));

          gimp_viewable_set_parent (GIMP_VIEWABLE (new_child),
                                    GIMP_VIEWABLE (new_group));

          gimp_container_insert (new_group->children,
                                 GIMP_OBJECT (new_child),
                                 position);
        }
    }

  return new_item;
}

static void
gimp_group_layer_convert (GimpItem  *item,
                          GimpImage *dest_image)
{
  GimpGroupLayer *group = GIMP_GROUP_LAYER (item);
  GList          *list;

  for (list = GIMP_LIST (group->children)->list;
       list;
       list = g_list_next (list))
    {
      GimpItem *child = list->data;

      GIMP_ITEM_GET_CLASS (child)->convert (child, dest_image);
    }

  GIMP_ITEM_CLASS (parent_class)->convert (item, dest_image);
}

static void
gimp_group_layer_translate (GimpItem *item,
                            gint      offset_x,
                            gint      offset_y,
                            gboolean  push_undo)
{
  GimpGroupLayer *group = GIMP_GROUP_LAYER (item);
  GimpLayerMask  *mask;
  GList          *list;

  for (list = gimp_item_stack_get_item_iter (GIMP_ITEM_STACK (group->children));
       list;
       list = g_list_next (list))
    {
      GimpItem *child = list->data;

      gimp_item_translate (child, offset_x, offset_y, push_undo);
    }

  mask = gimp_layer_get_mask (GIMP_LAYER (group));

  if (mask)
    {
      gint off_x, off_y;

      gimp_item_get_offset (item, &off_x, &off_y);
      gimp_item_set_offset (GIMP_ITEM (mask), off_x, off_y);

      gimp_viewable_invalidate_preview (GIMP_VIEWABLE (mask));
    }
}

static void
gimp_group_layer_scale (GimpItem              *item,
                        gint                   new_width,
                        gint                   new_height,
                        gint                   new_offset_x,
                        gint                   new_offset_y,
                        GimpInterpolationType  interpolation_type,
                        GimpProgress          *progress)
{
  GimpGroupLayer *group = GIMP_GROUP_LAYER (item);
  GimpLayerMask  *mask;
  GList          *list;

  for (list = gimp_item_stack_get_item_iter (GIMP_ITEM_STACK (group->children));
       list;
       list = g_list_next (list))
    {
      GimpItem *child = list->data;

      gimp_item_scale (child,
                       new_width, new_height,
                       new_offset_x, new_offset_y,
                       interpolation_type, progress);
    }

  mask = gimp_layer_get_mask (GIMP_LAYER (group));

  if (mask)
    gimp_item_scale (GIMP_ITEM (mask),
                     new_width, new_height,
                     new_offset_x, new_offset_y,
                     interpolation_type, progress);
}

static void
gimp_group_layer_resize (GimpItem    *item,
                         GimpContext *context,
                         gint         new_width,
                         gint         new_height,
                         gint         offset_x,
                         gint         offset_y)
{
  /* FIXME */
}

static void
gimp_group_layer_flip (GimpItem            *item,
                       GimpContext         *context,
                       GimpOrientationType  flip_type,
                       gdouble              axis,
                       gboolean             clip_result)
{
  GimpGroupLayer *group = GIMP_GROUP_LAYER (item);
  GimpLayerMask  *mask;
  GList          *list;

  for (list = gimp_item_stack_get_item_iter (GIMP_ITEM_STACK (group->children));
       list;
       list = g_list_next (list))
    {
      GimpItem *child = list->data;

      gimp_item_flip (child, context,
                      flip_type, axis, clip_result);
    }

  mask = gimp_layer_get_mask (GIMP_LAYER (group));

  if (mask)
    gimp_item_flip (GIMP_ITEM (mask), context,
                    flip_type, axis, clip_result);
}

static void
gimp_group_layer_rotate (GimpItem         *item,
                         GimpContext      *context,
                         GimpRotationType  rotate_type,
                         gdouble           center_x,
                         gdouble           center_y,
                         gboolean          clip_result)
{
  GimpGroupLayer *group = GIMP_GROUP_LAYER (item);
  GimpLayerMask  *mask;
  GList          *list;

  for (list = gimp_item_stack_get_item_iter (GIMP_ITEM_STACK (group->children));
       list;
       list = g_list_next (list))
    {
      GimpItem *child = list->data;

      gimp_item_rotate (child, context,
                        rotate_type, center_x, center_y, clip_result);
    }

  mask = gimp_layer_get_mask (GIMP_LAYER (group));

  if (mask)
    gimp_item_rotate (GIMP_ITEM (mask), context,
                      rotate_type, center_x, center_y, clip_result);
}

static void
gimp_group_layer_transform (GimpItem               *item,
                            GimpContext            *context,
                            const GimpMatrix3      *matrix,
                            GimpTransformDirection  direction,
                            GimpInterpolationType   interpolation_type,
                            gint                    recursion_level,
                            GimpTransformResize     clip_result,
                            GimpProgress           *progress)
{
  GimpGroupLayer *group = GIMP_GROUP_LAYER (item);
  GimpLayerMask  *mask;
  GList          *list;

  for (list = gimp_item_stack_get_item_iter (GIMP_ITEM_STACK (group->children));
       list;
       list = g_list_next (list))
    {
      GimpItem *child = list->data;

      gimp_item_transform (child, context,
                           matrix, direction,
                           interpolation_type, recursion_level,
                           clip_result, progress);
    }

  mask = gimp_layer_get_mask (GIMP_LAYER (group));

  if (mask)
    gimp_item_transform (GIMP_ITEM (mask), context,
                         matrix, direction,
                         interpolation_type, recursion_level,
                         clip_result, progress);
}

static GeglNode *
gimp_group_layer_get_graph (GimpProjectable *projectable)
{
  GimpGroupLayer *group = GIMP_GROUP_LAYER (projectable);
  GeglNode       *layers_node;
  GeglNode       *output;
  gint            off_x;
  gint            off_y;

  if (group->graph)
    return group->graph;

  group->graph = gegl_node_new ();

  layers_node =
    gimp_drawable_stack_get_graph (GIMP_DRAWABLE_STACK (group->children));

  gegl_node_add_child (group->graph, layers_node);

  gimp_item_get_offset (GIMP_ITEM (group), &off_x, &off_y);

  group->offset_node = gegl_node_new_child (group->graph,
                                            "operation", "gegl:translate",
                                            "x",         (gdouble) -off_x,
                                            "y",         (gdouble) -off_y,
                                            NULL);

  gegl_node_connect_to (layers_node,        "output",
                        group->offset_node, "input");

  output = gegl_node_get_output_proxy (group->graph, "output");

  gegl_node_connect_to (group->offset_node, "output",
                        output,             "input");

  return group->graph;
}

static GList *
gimp_group_layer_get_layers (GimpProjectable *projectable)
{
  GimpGroupLayer *group = GIMP_GROUP_LAYER (projectable);

  return gimp_item_stack_get_item_iter (GIMP_ITEM_STACK (group->children));
}


/*  public functions  */

GimpLayer *
gimp_group_layer_new (GimpImage *image)
{
  GimpGroupLayer *group;

  g_return_val_if_fail (GIMP_IS_IMAGE (image), NULL);

  group = g_object_new (GIMP_TYPE_GROUP_LAYER, NULL);

  gimp_drawable_configure (GIMP_DRAWABLE (group),
                           image,
                           0, 0, 1, 1,
                           gimp_image_base_type_with_alpha (image),
                           _("Group Layer"));

  if (gimp_image_get_projection (image)->use_gegl)
    group->projection->use_gegl = TRUE;

  return GIMP_LAYER (group);
}


/*  private functions  */

static void
gimp_group_layer_child_add (GimpContainer  *container,
                            GimpLayer      *child,
                            GimpGroupLayer *group)
{
  gimp_group_layer_update_size (group);
}

static void
gimp_group_layer_child_remove (GimpContainer  *container,
                               GimpLayer      *child,
                               GimpGroupLayer *group)
{
  gimp_group_layer_update_size (group);
}

static void
gimp_group_layer_child_move (GimpLayer      *child,
                             GParamSpec     *pspec,
                             GimpGroupLayer *group)
{
  gimp_group_layer_update_size (group);
}

static void
gimp_group_layer_child_resize (GimpLayer      *child,
                               GimpGroupLayer *group)
{
  gimp_group_layer_update_size (group);
}

static void
gimp_group_layer_update_size (GimpGroupLayer *group)
{
  GList   *list;
  gint     x      = 0;
  gint     y      = 0;
  gint     width  = 1;
  gint     height = 1;
  gboolean first  = TRUE;

  for (list = gimp_item_stack_get_item_iter (GIMP_ITEM_STACK (group->children));
       list;
       list = g_list_next (list))
    {
      GimpItem *child = list->data;

      if (first)
        {
          x      = gimp_item_get_offset_x (child);
          y      = gimp_item_get_offset_y (child);
          width  = gimp_item_get_width    (child);
          height = gimp_item_get_height   (child);

          first = FALSE;
        }
      else
        {
          gimp_rectangle_union (x, y, width, height,
                                gimp_item_get_offset_x (child),
                                gimp_item_get_offset_y (child),
                                gimp_item_get_width    (child),
                                gimp_item_get_height   (child),
                                &x, &y, &width, &height);
        }
    }

  if (x      != gimp_item_get_offset_x (GIMP_ITEM (group)) ||
      y      != gimp_item_get_offset_y (GIMP_ITEM (group)) ||
      width  != gimp_item_get_width    (GIMP_ITEM (group)) ||
      height != gimp_item_get_height   (GIMP_ITEM (group)))
    {
      if (width  != gimp_item_get_width  (GIMP_ITEM (group)) ||
          height != gimp_item_get_height (GIMP_ITEM (group)))
        {
          TileManager *tiles;

          GIMP_ITEM (group)->width  = width;
          GIMP_ITEM (group)->height = height;

          gimp_projectable_structure_changed (GIMP_PROJECTABLE (group));

          tiles = gimp_projection_get_tiles_at_level (group->projection,
                                                      0, NULL);

          gimp_drawable_set_tiles_full (GIMP_DRAWABLE (group),
                                        FALSE, NULL,
                                        tiles,
                                        gimp_drawable_type (GIMP_DRAWABLE (group)),
                                        x, y);
        }
      else
        {
          gimp_item_set_offset (GIMP_ITEM (group), x, y);
        }

      if (group->offset_node)
        gegl_node_set (group->offset_node,
                       "x", (gdouble) -x,
                       "y", (gdouble) -y,
                       NULL);
    }
}

static void
gimp_group_layer_stack_update (GimpDrawableStack *stack,
                               gint               x,
                               gint               y,
                               gint               width,
                               gint               height,
                               GimpGroupLayer    *group)
{
  /*  the layer stack's update signal speaks in image coordinates,
   *  pass to the projection as-is.
   */
  gimp_projectable_update (GIMP_PROJECTABLE (group),
                           x, y, width, height);

  /*  flush the pickable not the projectable because flushing the
   *  pickable will finish all invalidation on the projection so it
   *  can be used as source (note that it will still be constructed
   *  when the actual read happens, so this it not a performance
   *  problem)
   */
  gimp_pickable_flush (GIMP_PICKABLE (group->projection));
}

static void
gimp_group_layer_proj_update (GimpProjection *proj,
                              gboolean        now,
                              gint            x,
                              gint            y,
                              gint            width,
                              gint            height,
                              GimpGroupLayer *group)
{
  /*  the projection speaks in image coordinates, transform to layer
   *  coordinates when emitting our own update signal.
   */
  gimp_drawable_update (GIMP_DRAWABLE (group),
                        x - gimp_item_get_offset_x (GIMP_ITEM (group)),
                        y - gimp_item_get_offset_y (GIMP_ITEM (group)),
                        width, height);
}