src/sp-mask.cpp

   1 /*
   2  * SVG <mask> implementation
   3  *
   4  * Authors:
   5  *   Lauris Kaplinski <lauris@kaplinski.com>
   6  *   Jon A. Cruz <jon@joncruz.org>
   7  *   Abhishek Sharma
   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->addResource("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)->removeResource("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 sp_mask_update(SPObject *object, SPCtx *ctx, guint flags)
 194 {
 195     if (flags & SP_OBJECT_MODIFIED_FLAG) {
 196         flags |= SP_OBJECT_PARENT_MODIFIED_FLAG;
 197     }
 198
 199     flags &= SP_OBJECT_MODIFIED_CASCADE;
 200
 201     SPObjectGroup *og = SP_OBJECTGROUP(object);
 202     GSList *l = NULL;
 203     for (SPObject *child = og->firstChild(); child; child = child->getNext()) {
 204         g_object_ref(G_OBJECT (child));
 205         l = g_slist_prepend (l, child);
 206     }
 207     l = g_slist_reverse (l);
 208     while (l) {
 209         SPObject *child = SP_OBJECT(l->data);
 210         l = g_slist_remove(l, child);
 211         if (flags || (child->uflags & (SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_CHILD_MODIFIED_FLAG))) {
 212             child->updateDisplay(ctx, flags);
 213         }
 214         g_object_unref(G_OBJECT(child));
 215     }
 216
 217     SPMask *mask = SP_MASK(object);
 218     for (SPMaskView *v = mask->display; v != NULL; v = v->next) {
 219         if (mask->maskContentUnits == SP_CONTENT_UNITS_OBJECTBOUNDINGBOX) {
 220             Geom::Matrix t(Geom::Scale(v->bbox.x1 - v->bbox.x0, v->bbox.y1 - v->bbox.y0));
 221             t[4] = v->bbox.x0;
 222             t[5] = v->bbox.y0;
 223             nr_arena_group_set_child_transform(NR_ARENA_GROUP(v->arenaitem), &t);
 224         } else {
 225             nr_arena_group_set_child_transform(NR_ARENA_GROUP(v->arenaitem), NULL);
 226         }
 227     }
 228 }
 229
 230 static void sp_mask_modified(SPObject *object, guint flags)
 231 {
 232     if (flags & SP_OBJECT_MODIFIED_FLAG) {
 233         flags |= SP_OBJECT_PARENT_MODIFIED_FLAG;
 234     }
 235
 236     flags &= SP_OBJECT_MODIFIED_CASCADE;
 237
 238     SPObjectGroup *og = SP_OBJECTGROUP(object);
 239     GSList *l = NULL;
 240     for (SPObject *child = og->firstChild(); child; child = child->getNext()) {
 241         g_object_ref(G_OBJECT(child));
 242         l = g_slist_prepend(l, child);
 243     }
 244     l = g_slist_reverse(l);
 245     while (l) {
 246         SPObject *child = SP_OBJECT(l->data);
 247         l = g_slist_remove(l, child);
 248         if (flags || (child->mflags & (SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_CHILD_MODIFIED_FLAG))) {
 249             child->emitModified(flags);
 250         }
 251         g_object_unref(G_OBJECT(child));
 252     }
 253 }
 254
 255 static Inkscape::XML::Node *
 256 sp_mask_write (SPObject *object, Inkscape::XML::Document *xml_doc, Inkscape::XML::Node *repr, guint flags)
 257 {
 258         if ((flags & SP_OBJECT_WRITE_BUILD) && !repr) {
 259                 repr = xml_doc->createElement("svg:mask");
 260         }
 261
 262         if (((SPObjectClass *) (parent_class))->write)
 263                 ((SPObjectClass *) (parent_class))->write (object, xml_doc, repr, flags);
 264
 265         return repr;
 266 }
 267
 268 // Create a mask element (using passed elements), add it to <defs>
 269 const gchar *
 270 sp_mask_create (GSList *reprs, SPDocument *document, Geom::Matrix const* applyTransform)
 271 {
 272     Inkscape::XML::Node *defsrepr = SP_OBJECT_REPR (SP_DOCUMENT_DEFS (document));
 273
 274     Inkscape::XML::Document *xml_doc = document->getReprDoc();
 275     Inkscape::XML::Node *repr = xml_doc->createElement("svg:mask");
 276     repr->setAttribute("maskUnits", "userSpaceOnUse");
 277
 278     defsrepr->appendChild(repr);
 279     const gchar *mask_id = repr->attribute("id");
 280     SPObject *mask_object = document->getObjectById(mask_id);
 281
 282     for (GSList *it = reprs; it != NULL; it = it->next) {
 283         Inkscape::XML::Node *node = (Inkscape::XML::Node *)(it->data);
 284         SPItem *item = SP_ITEM(mask_object->appendChildRepr(node));
 285
 286         if (NULL != applyTransform) {
 287             Geom::Matrix transform (item->transform);
 288             transform *= (*applyTransform);
 289             item->doWriteTransform(SP_OBJECT_REPR(item), transform);
 290         }
 291     }
 292
 293     if (repr != defsrepr->lastChild())
 294         defsrepr->changeOrder(repr, defsrepr->lastChild()); // workaround for bug 989084
 295
 296     Inkscape::GC::release(repr);
 297     return mask_id;
 298 }
 299
 300 NRArenaItem *sp_mask_show(SPMask *mask, NRArena *arena, unsigned int key)
 301 {
 302         g_return_val_if_fail (mask != NULL, NULL);
 303         g_return_val_if_fail (SP_IS_MASK (mask), NULL);
 304         g_return_val_if_fail (arena != NULL, NULL);
 305         g_return_val_if_fail (NR_IS_ARENA (arena), NULL);
 306
 307         NRArenaItem *ai = NRArenaGroup::create(arena);
 308         mask->display = sp_mask_view_new_prepend (mask->display, key, ai);
 309
 310         for ( SPObject *child = mask->firstChild() ; child; child = child->getNext() ) {
 311                 if (SP_IS_ITEM (child)) {
 312                         NRArenaItem *ac = SP_ITEM (child)->invoke_show (arena, key, SP_ITEM_REFERENCE_FLAGS);
 313                         if (ac) {
 314                                 /* The order is not important in mask */
 315                                 nr_arena_item_add_child (ai, ac, NULL);
 316                         }
 317                 }
 318         }
 319
 320         if (mask->maskContentUnits == SP_CONTENT_UNITS_OBJECTBOUNDINGBOX) {
 321         Geom::Matrix t(Geom::Scale(mask->display->bbox.x1 - mask->display->bbox.x0, mask->display->bbox.y1 - mask->display->bbox.y0));
 322                 t[4] = mask->display->bbox.x0;
 323                 t[5] = mask->display->bbox.y0;
 324                 nr_arena_group_set_child_transform (NR_ARENA_GROUP (ai), &t);
 325         }
 326
 327         return ai;
 328 }
 329
 330 void sp_mask_hide(SPMask *cp, unsigned int key)
 331 {
 332         g_return_if_fail (cp != NULL);
 333         g_return_if_fail (SP_IS_MASK (cp));
 334
 335         for ( SPObject *child = cp->firstChild(); child; child = child->getNext()) {
 336                 if (SP_IS_ITEM (child)) {
 337                         SP_ITEM(child)->invoke_hide (key);
 338                 }
 339         }
 340
 341         for (SPMaskView *v = cp->display; v != NULL; v = v->next) {
 342                 if (v->key == key) {
 343                         /* We simply unref and let item to manage this in handler */
 344                         cp->display = sp_mask_view_list_remove (cp->display, v);
 345                         return;
 346                 }
 347         }
 348
 349         g_assert_not_reached ();
 350 }
 351
 352 void
 353 sp_mask_set_bbox (SPMask *mask, unsigned int key, NRRect *bbox)
 354 {
 355         for (SPMaskView *v = mask->display; v != NULL; v = v->next) {
 356                 if (v->key == key) {
 357                         if (!NR_DF_TEST_CLOSE (v->bbox.x0, bbox->x0, NR_EPSILON) ||
 358                             !NR_DF_TEST_CLOSE (v->bbox.y0, bbox->y0, NR_EPSILON) ||
 359                             !NR_DF_TEST_CLOSE (v->bbox.x1, bbox->x1, NR_EPSILON) ||
 360                             !NR_DF_TEST_CLOSE (v->bbox.y1, bbox->y1, NR_EPSILON)) {
 361                                 v->bbox = *bbox;
 362                         }
 363                         break;
 364                 }
 365         }
 366 }
 367
 368 /* Mask views */
 369
 370 SPMaskView *
 371 sp_mask_view_new_prepend (SPMaskView *list, unsigned int key, NRArenaItem *arenaitem)
 372 {
 373         SPMaskView *new_mask_view = g_new (SPMaskView, 1);
 374
 375         new_mask_view->next = list;
 376         new_mask_view->key = key;
 377         new_mask_view->arenaitem = nr_arena_item_ref(arenaitem);
 378         new_mask_view->bbox.x0 = new_mask_view->bbox.x1 = 0.0;
 379         new_mask_view->bbox.y0 = new_mask_view->bbox.y1 = 0.0;
 380
 381         return new_mask_view;
 382 }
 383
 384 SPMaskView *
 385 sp_mask_view_list_remove (SPMaskView *list, SPMaskView *view)
 386 {
 387         if (view == list) {
 388                 list = list->next;
 389         } else {
 390                 SPMaskView *prev;
 391                 prev = list;
 392                 while (prev->next != view) prev = prev->next;
 393                 prev->next = view->next;
 394         }
 395
 396         nr_arena_item_unref (view->arenaitem);
 397         g_free (view);
 398
 399         return list;
 400 }
 401
 402 /*
 403   Local Variables:
 404   mode:c++
 405   c-file-style:"stroustrup"
 406   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 407   indent-tabs-mode:nil
 408   fill-column:99
 409   End:
 410 */
 411 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:fileencoding=utf-8:textwidth=99 :