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