src/sp-mask.cpp

   1 #define __SP_MASK_C__
   2
   3 /*
   4  * SVG <mask> implementation
   5  *
   6  * Authors:
   7  *   Lauris Kaplinski <lauris@kaplinski.com>
   8  *
   9  * Copyright (C) 2003 authors
  10  *
  11  * Released under GNU GPL, read the file 'COPYING' for more information
  12  */
  13
  14 #include <cstring>
  15 #include <string>
  16
  17 #include "display/nr-arena.h"
  18 #include "display/nr-arena-group.h"
  19 #include <xml/repr.h>
  20
  21 #include "enums.h"
  22 #include "attributes.h"
  23 #include "document.h"
  24 #include "document-private.h"
  25 #include "sp-item.h"
  26
  27 #include "sp-mask.h"
  28
  29 struct SPMaskView {
  30         SPMaskView *next;
  31         unsigned int key;
  32         NRArenaItem *arenaitem;
  33         NRRect bbox;
  34 };
  35
  36 static void sp_mask_class_init (SPMaskClass *klass);
  37 static void sp_mask_init (SPMask *mask);
  38
  39 static void sp_mask_build (SPObject *object, SPDocument *document, Inkscape::XML::Node *repr);
  40 static void sp_mask_release (SPObject * object);
  41 static void sp_mask_set (SPObject *object, unsigned int key, const gchar *value);
  42 static void sp_mask_child_added (SPObject *object, Inkscape::XML::Node *child, Inkscape::XML::Node *ref);
  43 static void sp_mask_update (SPObject *object, SPCtx *ctx, guint flags);
  44 static void sp_mask_modified (SPObject *object, guint flags);
  45 static Inkscape::XML::Node *sp_mask_write (SPObject *object, Inkscape::XML::Node *repr, guint flags);
  46
  47 SPMaskView *sp_mask_view_new_prepend (SPMaskView *list, unsigned int key, NRArenaItem *arenaitem);
  48 SPMaskView *sp_mask_view_list_remove (SPMaskView *list, SPMaskView *view);
  49
  50 static SPObjectGroupClass *parent_class;
  51
  52 GType
  53 sp_mask_get_type (void)
  54 {
  55         static GType type = 0;
  56         if (!type) {
  57                 GTypeInfo info = {
  58                         sizeof (SPMaskClass),
  59                         NULL, NULL,
  60                         (GClassInitFunc) sp_mask_class_init,
  61                         NULL, NULL,
  62                         sizeof (SPMask),
  63                         16,
  64                         (GInstanceInitFunc) sp_mask_init,
  65                         NULL,   /* value_table */
  66                 };
  67                 type = g_type_register_static (SP_TYPE_OBJECTGROUP, "SPMask", &info, (GTypeFlags)0);
  68         }
  69         return type;
  70 }
  71
  72 static void
  73 sp_mask_class_init (SPMaskClass *klass)
  74 {
  75         parent_class = (SPObjectGroupClass*) g_type_class_ref (SP_TYPE_OBJECTGROUP);
  76
  77         SPObjectClass *sp_object_class = (SPObjectClass *) klass;
  78         sp_object_class->build = sp_mask_build;
  79         sp_object_class->release = sp_mask_release;
  80         sp_object_class->set = sp_mask_set;
  81         sp_object_class->child_added = sp_mask_child_added;
  82         sp_object_class->update = sp_mask_update;
  83         sp_object_class->modified = sp_mask_modified;
  84         sp_object_class->write = sp_mask_write;
  85 }
  86
  87 static void
  88 sp_mask_init (SPMask *mask)
  89 {
  90         mask->maskUnits_set = FALSE;
  91         mask->maskUnits = SP_CONTENT_UNITS_OBJECTBOUNDINGBOX;
  92
  93         mask->maskContentUnits_set = FALSE;
  94         mask->maskContentUnits = SP_CONTENT_UNITS_USERSPACEONUSE;
  95
  96         mask->display = NULL;
  97 }
  98
  99 static void
 100 sp_mask_build (SPObject *object, SPDocument *document, Inkscape::XML::Node *repr)
 101 {
 102         if (((SPObjectClass *) parent_class)->build) {
 103                 ((SPObjectClass *) parent_class)->build (object, document, repr);
 104         }
 105
 106         sp_object_read_attr (object, "maskUnits");
 107         sp_object_read_attr (object, "maskContentUnits");
 108
 109         /* Register ourselves */
 110         sp_document_add_resource (document, "mask", object);
 111 }
 112
 113 static void
 114 sp_mask_release (SPObject * object)
 115 {
 116         if (SP_OBJECT_DOCUMENT (object)) {
 117                 /* Unregister ourselves */
 118                 sp_document_remove_resource (SP_OBJECT_DOCUMENT (object), "mask", object);
 119         }
 120
 121         SPMask *cp = SP_MASK (object);
 122         while (cp->display) {
 123                 /* We simply unref and let item manage this in handler */
 124                 cp->display = sp_mask_view_list_remove (cp->display, cp->display);
 125         }
 126
 127         if (((SPObjectClass *) (parent_class))->release) {
 128                 ((SPObjectClass *) parent_class)->release (object);
 129         }
 130 }
 131
 132 static void
 133 sp_mask_set (SPObject *object, unsigned int key, const gchar *value)
 134 {
 135         SPMask *mask = SP_MASK (object);
 136
 137         switch (key) {
 138         case SP_ATTR_MASKUNITS:
 139                 mask->maskUnits = SP_CONTENT_UNITS_OBJECTBOUNDINGBOX;
 140                 mask->maskUnits_set = FALSE;
 141                 if (value) {
 142                         if (!strcmp (value, "userSpaceOnUse")) {
 143                                 mask->maskUnits = SP_CONTENT_UNITS_USERSPACEONUSE;
 144                                 mask->maskUnits_set = TRUE;
 145                         } else if (!strcmp (value, "objectBoundingBox")) {
 146                                 mask->maskUnits_set = TRUE;
 147                         }
 148                 }
 149                 object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
 150                 break;
 151         case SP_ATTR_MASKCONTENTUNITS:
 152                 mask->maskContentUnits = SP_CONTENT_UNITS_USERSPACEONUSE;
 153                 mask->maskContentUnits_set = FALSE;
 154                 if (value) {
 155                         if (!strcmp (value, "userSpaceOnUse")) {
 156                                 mask->maskContentUnits_set = TRUE;
 157                         } else if (!strcmp (value, "objectBoundingBox")) {
 158                                 mask->maskContentUnits = SP_CONTENT_UNITS_OBJECTBOUNDINGBOX;
 159                                 mask->maskContentUnits_set = TRUE;
 160                         }
 161                 }
 162                 object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
 163                 break;
 164         default:
 165                 if (((SPObjectClass *) parent_class)->set)
 166                         ((SPObjectClass *) parent_class)->set (object, key, value);
 167                 break;
 168         }
 169 }
 170
 171 static void
 172 sp_mask_child_added (SPObject *object, Inkscape::XML::Node *child, Inkscape::XML::Node *ref)
 173 {
 174         /* Invoke SPObjectGroup implementation */
 175         ((SPObjectClass *) (parent_class))->child_added (object, child, ref);
 176
 177         /* Show new object */
 178         SPObject *ochild = SP_OBJECT_DOCUMENT (object)->getObjectByRepr(child);
 179         if (SP_IS_ITEM (ochild)) {
 180                 SPMask *cp = SP_MASK (object);
 181                 for (SPMaskView *v = cp->display; v != NULL; v = v->next) {
 182                         NRArenaItem *ac = sp_item_invoke_show (SP_ITEM (ochild),
 183                                                                NR_ARENA_ITEM_ARENA (v->arenaitem),
 184                                                                v->key,
 185                                                                SP_ITEM_REFERENCE_FLAGS);
 186                         if (ac) {
 187                                 nr_arena_item_add_child (v->arenaitem, ac, NULL);
 188                                 nr_arena_item_unref (ac);
 189                         }
 190                 }
 191         }
 192 }
 193
 194 static void
 195 sp_mask_update (SPObject *object, SPCtx *ctx, guint flags)
 196 {
 197         if (flags & SP_OBJECT_MODIFIED_FLAG) {
 198                 flags |= SP_OBJECT_PARENT_MODIFIED_FLAG;
 199         }
 200
 201         flags &= SP_OBJECT_MODIFIED_CASCADE;
 202
 203         SPObjectGroup *og = SP_OBJECTGROUP (object);
 204         GSList *l = NULL;
 205         for (SPObject *child = sp_object_first_child(SP_OBJECT(og)); child != NULL; child = SP_OBJECT_NEXT(child)) {
 206                 g_object_ref (G_OBJECT (child));
 207                 l = g_slist_prepend (l, child);
 208         }
 209         l = g_slist_reverse (l);
 210         while (l) {
 211                 SPObject *child = SP_OBJECT (l->data);
 212                 l = g_slist_remove (l, child);
 213                 if (flags || (child->uflags & (SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_CHILD_MODIFIED_FLAG))) {
 214                         child->updateDisplay(ctx, flags);
 215                 }
 216                 g_object_unref (G_OBJECT (child));
 217         }
 218
 219         SPMask *mask = SP_MASK (object);
 220         for (SPMaskView *v = mask->display; v != NULL; v = v->next) {
 221                 if (mask->maskContentUnits == SP_CONTENT_UNITS_OBJECTBOUNDINGBOX) {
 222                         NRMatrix t;
 223                         nr_matrix_set_scale (&t, v->bbox.x1 - v->bbox.x0, v->bbox.y1 - v->bbox.y0);
 224                         t.c[4] = v->bbox.x0;
 225                         t.c[5] = v->bbox.y0;
 226                         nr_arena_group_set_child_transform (NR_ARENA_GROUP (v->arenaitem), &t);
 227                 } else {
 228                         nr_arena_group_set_child_transform (NR_ARENA_GROUP (v->arenaitem), NULL);
 229                 }
 230         }
 231 }
 232
 233 static void
 234 sp_mask_modified (SPObject *object, guint flags)
 235 {
 236         if (flags & SP_OBJECT_MODIFIED_FLAG) {
 237                 flags |= SP_OBJECT_PARENT_MODIFIED_FLAG;
 238         }
 239
 240         flags &= SP_OBJECT_MODIFIED_CASCADE;
 241
 242         SPObjectGroup *og = SP_OBJECTGROUP (object);
 243         GSList *l = NULL;
 244         for (SPObject *child = sp_object_first_child(SP_OBJECT(og)); child != NULL; child = SP_OBJECT_NEXT(child)) {
 245                 g_object_ref (G_OBJECT (child));
 246                 l = g_slist_prepend (l, child);
 247         }
 248         l = g_slist_reverse (l);
 249         while (l) {
 250                 SPObject *child = SP_OBJECT (l->data);
 251                 l = g_slist_remove (l, child);
 252                 if (flags || (child->mflags & (SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_CHILD_MODIFIED_FLAG))) {
 253                         child->emitModified(flags);
 254                 }
 255                 g_object_unref (G_OBJECT (child));
 256         }
 257 }
 258
 259 static Inkscape::XML::Node *
 260 sp_mask_write (SPObject *object, Inkscape::XML::Node *repr, guint flags)
 261 {
 262         if ((flags & SP_OBJECT_WRITE_BUILD) && !repr) {
 263                 Inkscape::XML::Document *xml_doc = sp_document_repr_doc(SP_OBJECT_DOCUMENT(object));
 264                 repr = xml_doc->createElement("svg:mask");
 265         }
 266
 267         if (((SPObjectClass *) (parent_class))->write)
 268                 ((SPObjectClass *) (parent_class))->write (object, repr, flags);
 269
 270         return repr;
 271 }
 272
 273 // Create a mask element (using passed elements), add it to <defs>
 274 const gchar *
 275 sp_mask_create (GSList *reprs, SPDocument *document, NR::Matrix const* applyTransform)
 276 {
 277     Inkscape::XML::Node *defsrepr = SP_OBJECT_REPR (SP_DOCUMENT_DEFS (document));
 278
 279     Inkscape::XML::Document *xml_doc = sp_document_repr_doc(document);
 280     Inkscape::XML::Node *repr = xml_doc->createElement("svg:mask");
 281     repr->setAttribute("maskUnits", "userSpaceOnUse");
 282
 283     defsrepr->appendChild(repr);
 284     const gchar *mask_id = repr->attribute("id");
 285     SPObject *mask_object = document->getObjectById(mask_id);
 286
 287     for (GSList *it = reprs; it != NULL; it = it->next) {
 288         Inkscape::XML::Node *node = (Inkscape::XML::Node *)(it->data);
 289         SPItem *item = SP_ITEM(mask_object->appendChildRepr(node));
 290
 291         if (NULL != applyTransform) {
 292             NR::Matrix transform (item->transform);
 293             transform *= (*applyTransform);
 294             sp_item_write_transform(item, SP_OBJECT_REPR(item), transform);
 295         }
 296     }
 297
 298     if (repr != defsrepr->lastChild())
 299         defsrepr->changeOrder(repr, defsrepr->lastChild()); // workaround for bug 989084
 300
 301     Inkscape::GC::release(repr);
 302     return mask_id;
 303 }
 304
 305 NRArenaItem *
 306 sp_mask_show (SPMask *mask, NRArena *arena, unsigned int key)
 307 {
 308         g_return_val_if_fail (mask != NULL, NULL);
 309         g_return_val_if_fail (SP_IS_MASK (mask), NULL);
 310         g_return_val_if_fail (arena != NULL, NULL);
 311         g_return_val_if_fail (NR_IS_ARENA (arena), NULL);
 312
 313         NRArenaItem *ai = NRArenaGroup::create(arena);
 314         mask->display = sp_mask_view_new_prepend (mask->display, key, ai);
 315
 316         for (SPObject *child = sp_object_first_child(SP_OBJECT(mask)) ; child != NULL; child = SP_OBJECT_NEXT(child)) {
 317                 if (SP_IS_ITEM (child)) {
 318                         NRArenaItem *ac = sp_item_invoke_show (SP_ITEM (child), arena, key, SP_ITEM_REFERENCE_FLAGS);
 319                         if (ac) {
 320                                 /* The order is not important in mask */
 321                                 nr_arena_item_add_child (ai, ac, NULL);
 322                                 nr_arena_item_unref (ac);
 323                         }
 324                 }
 325         }
 326
 327         if (mask->maskContentUnits == SP_CONTENT_UNITS_OBJECTBOUNDINGBOX) {
 328                 NRMatrix t;
 329                 nr_matrix_set_scale (&t, mask->display->bbox.x1 - mask->display->bbox.x0, mask->display->bbox.y1 - mask->display->bbox.y0);
 330                 t.c[4] = mask->display->bbox.x0;
 331                 t.c[5] = mask->display->bbox.y0;
 332                 nr_arena_group_set_child_transform (NR_ARENA_GROUP (ai), &t);
 333         }
 334
 335         return ai;
 336 }
 337
 338 void
 339 sp_mask_hide (SPMask *cp, unsigned int key)
 340 {
 341         g_return_if_fail (cp != NULL);
 342         g_return_if_fail (SP_IS_MASK (cp));
 343
 344         for (SPObject *child = sp_object_first_child(SP_OBJECT(cp)); child != NULL; child = SP_OBJECT_NEXT(child)) {
 345                 if (SP_IS_ITEM (child)) {
 346                         sp_item_invoke_hide (SP_ITEM (child), key);
 347                 }
 348         }
 349
 350         for (SPMaskView *v = cp->display; v != NULL; v = v->next) {
 351                 if (v->key == key) {
 352                         /* We simply unref and let item to manage this in handler */
 353                         cp->display = sp_mask_view_list_remove (cp->display, v);
 354                         return;
 355                 }
 356         }
 357
 358         g_assert_not_reached ();
 359 }
 360
 361 void
 362 sp_mask_set_bbox (SPMask *mask, unsigned int key, NRRect *bbox)
 363 {
 364         for (SPMaskView *v = mask->display; v != NULL; v = v->next) {
 365                 if (v->key == key) {
 366                         if (!NR_DF_TEST_CLOSE (v->bbox.x0, bbox->x0, NR_EPSILON) ||
 367                             !NR_DF_TEST_CLOSE (v->bbox.y0, bbox->y0, NR_EPSILON) ||
 368                             !NR_DF_TEST_CLOSE (v->bbox.x1, bbox->x1, NR_EPSILON) ||
 369                             !NR_DF_TEST_CLOSE (v->bbox.y1, bbox->y1, NR_EPSILON)) {
 370                                 v->bbox = *bbox;
 371                         }
 372                         break;
 373                 }
 374         }
 375 }
 376
 377 /* Mask views */
 378
 379 SPMaskView *
 380 sp_mask_view_new_prepend (SPMaskView *list, unsigned int key, NRArenaItem *arenaitem)
 381 {
 382         SPMaskView *new_mask_view = g_new (SPMaskView, 1);
 383
 384         new_mask_view->next = list;
 385         new_mask_view->key = key;
 386         new_mask_view->arenaitem = nr_arena_item_ref(arenaitem);
 387         new_mask_view->bbox.x0 = new_mask_view->bbox.x1 = 0.0;
 388         new_mask_view->bbox.y0 = new_mask_view->bbox.y1 = 0.0;
 389
 390         return new_mask_view;
 391 }
 392
 393 SPMaskView *
 394 sp_mask_view_list_remove (SPMaskView *list, SPMaskView *view)
 395 {
 396         if (view == list) {
 397                 list = list->next;
 398         } else {
 399                 SPMaskView *prev;
 400                 prev = list;
 401                 while (prev->next != view) prev = prev->next;
 402                 prev->next = view->next;
 403         }
 404
 405         nr_arena_item_unref (view->arenaitem);
 406         g_free (view);
 407
 408         return list;
 409 }
 410
 411 /*
 412   Local Variables:
 413   mode:c++
 414   c-file-style:"stroustrup"
 415   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 416   indent-tabs-mode:nil
 417   fill-column:99
 418   End:
 419 */
 420 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :