src/display/nr-arena-item.cpp

   1 #define __NR_ARENA_ITEM_C__
   2
   3 /*
   4  * RGBA display list system for inkscape
   5  *
   6  * Author:
   7  *   Lauris Kaplinski <lauris@kaplinski.com>
   8  *
   9  * Copyright (C) 2001-2002 Lauris Kaplinski
  10  * Copyright (C) 2001 Ximian, Inc.
  11  *
  12  * Released under GNU GPL, read the file 'COPYING' for more information
  13  */
  14
  15 #define noNR_ARENA_ITEM_VERBOSE
  16 #define noNR_ARENA_ITEM_DEBUG_CASCADE
  17
  18 #include <cstring>
  19 #include <string>
  20
  21 #include <libnr/nr-blit.h>
  22 #include <libnr/nr-pixops.h>
  23 #include "nr-arena.h"
  24 #include "nr-arena-item.h"
  25 #include "gc-core.h"
  26 #include "helper/geom.h"
  27
  28 #include "nr-filter.h"
  29 #include "nr-arena-group.h"
  30 #include "preferences.h"
  31
  32 namespace GC = Inkscape::GC;
  33
  34 static void nr_arena_item_class_init (NRArenaItemClass *klass);
  35 static void nr_arena_item_init (NRArenaItem *item);
  36 static void nr_arena_item_private_finalize (NRObject *object);
  37
  38 static NRObjectClass *parent_class;
  39
  40 NRType
  41 nr_arena_item_get_type (void)
  42 {
  43     static NRType type = 0;
  44     if (!type) {
  45         type = nr_object_register_type (NR_TYPE_OBJECT,
  46                                         "NRArenaItem",
  47                                         sizeof (NRArenaItemClass),
  48                                         sizeof (NRArenaItem),
  49                                         (void (*)(NRObjectClass *))
  50                                         nr_arena_item_class_init,
  51                                         (void (*)(NRObject *))
  52                                         nr_arena_item_init);
  53     }
  54     return type;
  55 }
  56
  57 static void
  58 nr_arena_item_class_init (NRArenaItemClass *klass)
  59 {
  60     NRObjectClass *object_class;
  61
  62     object_class = (NRObjectClass *) klass;
  63
  64     parent_class = ((NRObjectClass *) klass)->parent;
  65
  66     object_class->finalize = nr_arena_item_private_finalize;
  67     object_class->cpp_ctor = NRObject::invoke_ctor < NRArenaItem >;
  68 }
  69
  70 static void
  71 nr_arena_item_init (NRArenaItem *item)
  72 {
  73     item->arena = NULL;
  74     item->parent = NULL;
  75     item->next = item->prev = NULL;
  76
  77     item->key = 0;
  78
  79     item->state = 0;
  80     item->sensitive = TRUE;
  81     item->visible = TRUE;
  82
  83     memset (&item->bbox, 0, sizeof (item->bbox));
  84     memset (&item->drawbox, 0, sizeof (item->drawbox));
  85     item->transform = NULL;
  86     item->opacity = 255;
  87     item->render_opacity = FALSE;
  88
  89     item->transform = NULL;
  90     item->clip = NULL;
  91     item->mask = NULL;
  92     item->px = NULL;
  93     item->data = NULL;
  94     item->filter = NULL;
  95     item->background_pb = NULL;
  96     item->background_new = false;
  97 }
  98
  99 static void
 100 nr_arena_item_private_finalize (NRObject *object)
 101 {
 102     NRArenaItem *item = static_cast < NRArenaItem * >(object);
 103
 104     item->px = NULL;
 105     item->transform = NULL;
 106
 107     ((NRObjectClass *) (parent_class))->finalize (object);
 108 }
 109
 110 NRArenaItem *
 111 nr_arena_item_children (NRArenaItem *item)
 112 {
 113     nr_return_val_if_fail (item != NULL, NULL);
 114     nr_return_val_if_fail (NR_IS_ARENA_ITEM (item), NULL);
 115
 116     if (NR_ARENA_ITEM_VIRTUAL (item, children))
 117         return NR_ARENA_ITEM_VIRTUAL (item, children) (item);
 118
 119     return NULL;
 120 }
 121
 122 NRArenaItem *
 123 nr_arena_item_last_child (NRArenaItem *item)
 124 {
 125     nr_return_val_if_fail (item != NULL, NULL);
 126     nr_return_val_if_fail (NR_IS_ARENA_ITEM (item), NULL);
 127
 128     if (NR_ARENA_ITEM_VIRTUAL (item, last_child)) {
 129         return NR_ARENA_ITEM_VIRTUAL (item, last_child) (item);
 130     } else {
 131         NRArenaItem *ref = nr_arena_item_children (item);
 132         if (ref)
 133             while (ref->next)
 134                 ref = ref->next;
 135         return ref;
 136     }
 137 }
 138
 139 void
 140 nr_arena_item_add_child (NRArenaItem *item, NRArenaItem *child,
 141                          NRArenaItem *ref)
 142 {
 143     nr_return_if_fail (item != NULL);
 144     nr_return_if_fail (NR_IS_ARENA_ITEM (item));
 145     nr_return_if_fail (child != NULL);
 146     nr_return_if_fail (NR_IS_ARENA_ITEM (child));
 147     nr_return_if_fail (child->parent == NULL);
 148     nr_return_if_fail (child->prev == NULL);
 149     nr_return_if_fail (child->next == NULL);
 150     nr_return_if_fail (child->arena == item->arena);
 151     nr_return_if_fail (child != ref);
 152     nr_return_if_fail (!ref || NR_IS_ARENA_ITEM (ref));
 153     nr_return_if_fail (!ref || (ref->parent == item));
 154
 155     if (NR_ARENA_ITEM_VIRTUAL (item, add_child))
 156         NR_ARENA_ITEM_VIRTUAL (item, add_child) (item, child, ref);
 157 }
 158
 159 void
 160 nr_arena_item_remove_child (NRArenaItem *item, NRArenaItem *child)
 161 {
 162     nr_return_if_fail (item != NULL);
 163     nr_return_if_fail (NR_IS_ARENA_ITEM (item));
 164     nr_return_if_fail (child != NULL);
 165     nr_return_if_fail (NR_IS_ARENA_ITEM (child));
 166     nr_return_if_fail (child->parent == item);
 167
 168     if (NR_ARENA_ITEM_VIRTUAL (item, remove_child))
 169         NR_ARENA_ITEM_VIRTUAL (item, remove_child) (item, child);
 170 }
 171
 172 void
 173 nr_arena_item_set_child_position (NRArenaItem *item, NRArenaItem *child,
 174                                   NRArenaItem *ref)
 175 {
 176     nr_return_if_fail (item != NULL);
 177     nr_return_if_fail (NR_IS_ARENA_ITEM (item));
 178     nr_return_if_fail (child != NULL);
 179     nr_return_if_fail (NR_IS_ARENA_ITEM (child));
 180     nr_return_if_fail (child->parent == item);
 181     nr_return_if_fail (!ref || NR_IS_ARENA_ITEM (ref));
 182     nr_return_if_fail (!ref || (ref->parent == item));
 183
 184     if (NR_ARENA_ITEM_VIRTUAL (item, set_child_position))
 185         NR_ARENA_ITEM_VIRTUAL (item, set_child_position) (item, child, ref);
 186 }
 187
 188 NRArenaItem *
 189 nr_arena_item_ref (NRArenaItem *item)
 190 {
 191     nr_object_ref ((NRObject *) item);
 192
 193     return item;
 194 }
 195
 196 NRArenaItem *
 197 nr_arena_item_unref (NRArenaItem *item)
 198 {
 199     nr_object_unref ((NRObject *) item);
 200
 201     return NULL;
 202 }
 203
 204 unsigned int
 205 nr_arena_item_invoke_update (NRArenaItem *item, NRRectL *area, NRGC *gc,
 206                              unsigned int state, unsigned int reset)
 207 {
 208     NRGC childgc (gc);
 209     bool filter = (item->arena->rendermode == Inkscape::RENDERMODE_NORMAL);
 210
 211     nr_return_val_if_fail (item != NULL, NR_ARENA_ITEM_STATE_INVALID);
 212     nr_return_val_if_fail (NR_IS_ARENA_ITEM (item),
 213                            NR_ARENA_ITEM_STATE_INVALID);
 214     nr_return_val_if_fail (!(state & NR_ARENA_ITEM_STATE_INVALID),
 215                            NR_ARENA_ITEM_STATE_INVALID);
 216
 217 #ifdef NR_ARENA_ITEM_DEBUG_CASCADE
 218     printf ("Update %s:%p %x %x %x\n",
 219             nr_type_name_from_instance ((GTypeInstance *) item), item, state,
 220             item->state, reset);
 221 #endif
 222
 223     /* return if in error */
 224     if (item->state & NR_ARENA_ITEM_STATE_INVALID)
 225         return item->state;
 226     /* Set reset flags according to propagation status */
 227     if (item->propagate) {
 228         reset |= ~item->state;
 229         item->propagate = FALSE;
 230     }
 231     /* Reset our state */
 232     item->state &= ~reset;
 233     /* Return if NOP */
 234     if (!(~item->state & state))
 235         return item->state;
 236     /* Test whether to return immediately */
 237     if (area && (item->state & NR_ARENA_ITEM_STATE_BBOX)) {
 238         if (!nr_rect_l_test_intersect_ptr(area, &item->drawbox))
 239             return item->state;
 240     }
 241
 242     /* Reset image cache, if not to be kept */
 243     if (!(item->state & NR_ARENA_ITEM_STATE_IMAGE) && (item->px)) {
 244         item->px = NULL;
 245     }
 246
 247     /* Set up local gc */
 248     childgc = *gc;
 249     if (item->transform) {
 250         childgc.transform = (*item->transform) * childgc.transform;
 251     }
 252     /* Remember the transformation matrix */
 253     item->ctm = childgc.transform;
 254
 255     /* Invoke the real method */
 256     // that will update bbox
 257     item->state = NR_ARENA_ITEM_VIRTUAL (item, update) (item, area, &childgc, state, reset);
 258     if (item->state & NR_ARENA_ITEM_STATE_INVALID)
 259         return item->state;
 260
 261     // get a copy of bbox
 262     memcpy(&item->drawbox, &item->bbox, sizeof(item->bbox));
 263
 264     /* Enlarge the drawbox to contain filter effects */
 265     if (item->filter && filter) {
 266         item->filter->bbox_enlarge (item->drawbox);
 267     }
 268     // fixme: to fix the display glitches, in outline mode bbox must be a combination of
 269     // full item bbox and its clip and mask (after we have the API to get these)
 270
 271     /* Clipping */
 272     if (item->clip) {
 273         // FIXME: since here we only need bbox, consider passing
 274         // ((state & !(NR_ARENA_ITEM_STATE_RENDER)) | NR_ARENA_ITEM_STATE_BBOX)
 275         // instead of state, so it does not have to create rendering structures in nr_arena_shape_update
 276         unsigned int newstate = nr_arena_item_invoke_update (item->clip, area, &childgc, state, reset);
 277         if (newstate & NR_ARENA_ITEM_STATE_INVALID) {
 278             item->state |= NR_ARENA_ITEM_STATE_INVALID;
 279             return item->state;
 280         }
 281         // for clipping, we need geometric bbox
 282         nr_rect_l_intersect (&item->drawbox, &item->drawbox, &item->clip->bbox);
 283     }
 284     /* Masking */
 285     if (item->mask) {
 286         unsigned int newstate = nr_arena_item_invoke_update (item->mask, area, &childgc, state, reset);
 287         if (newstate & NR_ARENA_ITEM_STATE_INVALID) {
 288             item->state |= NR_ARENA_ITEM_STATE_INVALID;
 289             return item->state;
 290         }
 291         // for masking, we need full drawbox of mask
 292         nr_rect_l_intersect (&item->drawbox, &item->drawbox, &item->mask->drawbox);
 293     }
 294
 295     // now that we know drawbox, dirty the corresponding rect on canvas:
 296     if (!NR_IS_ARENA_GROUP(item) || (item->filter && filter)) {
 297         // unless filtered, groups do not need to render by themselves, only their members
 298         nr_arena_item_request_render (item);
 299     }
 300
 301     return item->state;
 302 }
 303
 304 /**
 305  *    Render item to pixblock.
 306  *
 307  *    \return Has NR_ARENA_ITEM_STATE_RENDER set on success.
 308  */
 309
 310 unsigned int
 311 nr_arena_item_invoke_render (cairo_t *ct, NRArenaItem *item, NRRectL const *area,
 312                              NRPixBlock *pb, unsigned int flags)
 313 {
 314    bool outline = (item->arena->rendermode == Inkscape::RENDERMODE_OUTLINE);
 315     bool filter = (item->arena->rendermode != Inkscape::RENDERMODE_OUTLINE &&
 316                    item->arena->rendermode != Inkscape::RENDERMODE_NO_FILTERS);
 317     bool print_colors = (item->arena->rendermode == Inkscape::RENDERMODE_PRINT_COLORS_PREVIEW);
 318
 319     nr_return_val_if_fail (item != NULL, NR_ARENA_ITEM_STATE_INVALID);
 320     nr_return_val_if_fail (NR_IS_ARENA_ITEM (item),
 321                            NR_ARENA_ITEM_STATE_INVALID);
 322     nr_return_val_if_fail (item->state & NR_ARENA_ITEM_STATE_BBOX,
 323                            item->state);
 324
 325 #ifdef NR_ARENA_ITEM_VERBOSE
 326     g_message ("Invoke render %p on %p: %d %d - %d %d, %d %d - %d %d", item, pb,
 327             area->x0, area->y0,
 328             area->x1, area->y1,
 329             item->drawbox.x0, item->drawbox.y0,
 330             item->drawbox.x1, item->drawbox.y1);
 331 #endif
 332
 333     /* If we are invisible, just return successfully */
 334     if (!item->visible)
 335         return item->state | NR_ARENA_ITEM_STATE_RENDER;
 336
 337     NRRectL carea;
 338     nr_rect_l_intersect (&carea, area, &item->drawbox);
 339     if (nr_rect_l_test_empty(carea))
 340         return item->state | NR_ARENA_ITEM_STATE_RENDER;
 341     if (item->filter && filter) {
 342         item->filter->area_enlarge (carea, item);
 343         nr_rect_l_intersect (&carea, &carea, &item->drawbox);
 344     }
 345
 346     if (outline) {
 347     // No caching in outline mode for now; investigate if it really gives any advantage with cairo.
 348     // Also no attempts to clip anything; just render everything: item, clip, mask
 349             // First, render the object itself
 350             unsigned int state = NR_ARENA_ITEM_VIRTUAL (item, render) (ct, item, &carea, pb, flags);
 351             if (state & NR_ARENA_ITEM_STATE_INVALID) {
 352                 /* Clean up and return error */
 353                 item->state |= NR_ARENA_ITEM_STATE_INVALID;
 354                 return item->state;
 355             }
 356
 357             // render clip and mask, if any
 358             guint32 saved_rgba = item->arena->outlinecolor; // save current outline color
 359             // render clippath as an object, using a different color
 360             Inkscape::Preferences *prefs = Inkscape::Preferences::get();
 361             if (item->clip) {
 362                 item->arena->outlinecolor = prefs->getInt("/options/wireframecolors/clips", 0x00ff00ff); // green clips
 363                 NR_ARENA_ITEM_VIRTUAL (item->clip, render) (ct, item->clip, &carea, pb, flags);
 364             }
 365             // render mask as an object, using a different color
 366             if (item->mask) {
 367                 item->arena->outlinecolor = prefs->getInt("/options/wireframecolors/masks", 0x0000ffff); // blue masks
 368                 NR_ARENA_ITEM_VIRTUAL (item->mask, render) (ct, item->mask, &carea, pb, flags);
 369             }
 370             item->arena->outlinecolor = saved_rgba; // restore outline color
 371
 372             return item->state | NR_ARENA_ITEM_STATE_RENDER;
 373     }
 374
 375     NRPixBlock cpb;
 376     if (item->px) {
 377         /* Has cache pixblock, render this and return */
 378         nr_pixblock_setup_extern (&cpb, NR_PIXBLOCK_MODE_R8G8B8A8P,
 379                                   /* fixme: This probably cannot overflow, because we render only if visible */
 380                                   /* fixme: and pixel cache is there only for small items */
 381                                   /* fixme: But this still needs extra check (Lauris) */
 382                                   item->drawbox.x0, item->drawbox.y0,
 383                                   item->drawbox.x1, item->drawbox.y1,
 384                                   item->px,
 385                                   4 * (item->drawbox.x1 - item->drawbox.x0), FALSE,
 386                                   FALSE);
 387         nr_blit_pixblock_pixblock (pb, &cpb);
 388         nr_pixblock_release (&cpb);
 389         pb->empty = FALSE;
 390         return item->state | NR_ARENA_ITEM_STATE_RENDER;
 391     }
 392
 393     NRPixBlock *dpb = pb;
 394
 395     /* Setup cache if we can */
 396     if ((!(flags & NR_ARENA_ITEM_RENDER_NO_CACHE)) &&
 397         (carea.x0 <= item->drawbox.x0) && (carea.y0 <= item->drawbox.y0) &&
 398         (carea.x1 >= item->drawbox.x1) && (carea.y1 >= item->drawbox.y1) &&
 399         (((item->drawbox.x1 - item->drawbox.x0) * (item->drawbox.y1 -
 400                                              item->drawbox.y0)) <= 4096)) {
 401         // Item drawbox is fully in renderable area and size is acceptable
 402         carea.x0 = item->drawbox.x0;
 403         carea.y0 = item->drawbox.y0;
 404         carea.x1 = item->drawbox.x1;
 405         carea.y1 = item->drawbox.y1;
 406         item->px =
 407             new (GC::ATOMIC) unsigned char[4 * (carea.x1 - carea.x0) *
 408                                            (carea.y1 - carea.y0)];
 409         nr_pixblock_setup_extern (&cpb, NR_PIXBLOCK_MODE_R8G8B8A8P, carea.x0,
 410                                   carea.y0, carea.x1, carea.y1, item->px,
 411                                   4 * (carea.x1 - carea.x0), TRUE, TRUE);
 412         cpb.visible_area = pb->visible_area;
 413         dpb = &cpb;
 414         // Set nocache flag for downstream rendering
 415         flags |= NR_ARENA_ITEM_RENDER_NO_CACHE;
 416     }
 417
 418     /* Determine, whether we need temporary buffer */
 419     if (item->clip || item->mask
 420         || ((item->opacity != 255) && !item->render_opacity)
 421         || (item->filter && filter) || item->background_new) {
 422
 423         /* Setup and render item buffer */
 424         NRPixBlock ipb;
 425         nr_pixblock_setup_fast (&ipb, NR_PIXBLOCK_MODE_R8G8B8A8P,
 426                                 carea.x0, carea.y0, carea.x1, carea.y1,
 427                                 TRUE);
 428
 429         //  if memory allocation failed, abort render
 430         if (ipb.size != NR_PIXBLOCK_SIZE_TINY && ipb.data.px == NULL) {
 431             nr_pixblock_release (&ipb);
 432             return (item->state);
 433         }
 434
 435         /* If background access is used, save the pixblock address.
 436          * This address is set to NULL at the end of this block */
 437         if (item->background_new) {
 438             item->background_pb = &ipb;
 439         }
 440
 441         ipb.visible_area = pb->visible_area;
 442         if (item->filter && filter) {
 443               item->filter->area_enlarge (ipb.visible_area, item);
 444         }
 445
 446         unsigned int state = NR_ARENA_ITEM_VIRTUAL (item, render) (ct, item, &carea, &ipb, flags);
 447         if (state & NR_ARENA_ITEM_STATE_INVALID) {
 448             /* Clean up and return error */
 449             nr_pixblock_release (&ipb);
 450             if (dpb != pb)
 451                 nr_pixblock_release (dpb);
 452             item->state |= NR_ARENA_ITEM_STATE_INVALID;
 453             return item->state;
 454         }
 455         ipb.empty = FALSE;
 456
 457         /* Run filtering, if a filter is set for this object */
 458         if (item->filter && filter) {
 459             item->filter->render (item, &ipb);
 460         }
 461
 462         if (item->clip || item->mask) {
 463             /* Setup mask pixblock */
 464             NRPixBlock mpb;
 465             nr_pixblock_setup_fast (&mpb, NR_PIXBLOCK_MODE_A8, carea.x0,
 466                                     carea.y0, carea.x1, carea.y1, TRUE);
 467
 468             if (mpb.data.px != NULL) { // if memory allocation was successful
 469
 470                 mpb.visible_area = pb->visible_area;
 471                 /* Do clip if needed */
 472                 if (item->clip) {
 473                     state = nr_arena_item_invoke_clip (item->clip, &carea, &mpb);
 474                     if (state & NR_ARENA_ITEM_STATE_INVALID) {
 475                         /* Clean up and return error */
 476                         nr_pixblock_release (&mpb);
 477                         nr_pixblock_release (&ipb);
 478                         if (dpb != pb)
 479                             nr_pixblock_release (dpb);
 480                         item->state |= NR_ARENA_ITEM_STATE_INVALID;
 481                         return item->state;
 482                     }
 483                     mpb.empty = FALSE;
 484                 }
 485                 /* Do mask if needed */
 486                 if (item->mask) {
 487                     NRPixBlock tpb;
 488                     /* Set up yet another temporary pixblock */
 489                     nr_pixblock_setup_fast (&tpb, NR_PIXBLOCK_MODE_R8G8B8A8N,
 490                                             carea.x0, carea.y0, carea.x1,
 491                                             carea.y1, TRUE);
 492
 493                     if (tpb.data.px != NULL) { // if memory allocation was successful
 494
 495                         tpb.visible_area = pb->visible_area;
 496                         unsigned int state = NR_ARENA_ITEM_VIRTUAL (item->mask, render) (ct, item->mask, &carea, &tpb, flags);
 497                         if (state & NR_ARENA_ITEM_STATE_INVALID) {
 498                             /* Clean up and return error */
 499                             nr_pixblock_release (&tpb);
 500                             nr_pixblock_release (&mpb);
 501                             nr_pixblock_release (&ipb);
 502                             if (dpb != pb)
 503                                 nr_pixblock_release (dpb);
 504                             item->state |= NR_ARENA_ITEM_STATE_INVALID;
 505                             return item->state;
 506                         }
 507                         /* Composite with clip */
 508                         if (item->clip) {
 509                             int x, y;
 510                             for (y = carea.y0; y < carea.y1; y++) {
 511                                 unsigned char *s, *d;
 512                                 s = NR_PIXBLOCK_PX (&tpb) + (y -
 513                                                              carea.y0) * tpb.rs;
 514                                 d = NR_PIXBLOCK_PX (&mpb) + (y -
 515                                                              carea.y0) * mpb.rs;
 516                                 for (x = carea.x0; x < carea.x1; x++) {
 517                                     unsigned int m;
 518                                     m = NR_PREMUL_112 (s[0] + s[1] + s[2], s[3]);
 519                                     d[0] =
 520                                         FAST_DIV_ROUND < 3 * 255 * 255 >
 521                                         (NR_PREMUL_123 (d[0], m));
 522                                     s += 4;
 523                                     d += 1;
 524                                 }
 525                             }
 526                         } else {
 527                             int x, y;
 528                             for (y = carea.y0; y < carea.y1; y++) {
 529                                 unsigned char *s, *d;
 530                                 s = NR_PIXBLOCK_PX (&tpb) + (y -
 531                                                              carea.y0) * tpb.rs;
 532                                 d = NR_PIXBLOCK_PX (&mpb) + (y -
 533                                                              carea.y0) * mpb.rs;
 534                                 for (x = carea.x0; x < carea.x1; x++) {
 535                                     unsigned int m;
 536                                     m = NR_PREMUL_112 (s[0] + s[1] + s[2], s[3]);
 537                                     d[0] = FAST_DIV_ROUND < 3 * 255 > (m);
 538                                     s += 4;
 539                                     d += 1;
 540                                 }
 541                             }
 542                             mpb.empty = FALSE;
 543                         }
 544                     }
 545                     nr_pixblock_release (&tpb);
 546                 }
 547                 /* Multiply with opacity if needed */
 548                 if ((item->opacity != 255) && !item->render_opacity
 549                     ) {
 550                     int x, y;
 551                     unsigned int a;
 552                     a = item->opacity;
 553                     for (y = carea.y0; y < carea.y1; y++) {
 554                         unsigned char *d;
 555                         d = NR_PIXBLOCK_PX (&mpb) + (y - carea.y0) * mpb.rs;
 556                         for (x = carea.x0; x < carea.x1; x++) {
 557                             d[0] = NR_PREMUL_111 (d[0], a);
 558                             d += 1;
 559                         }
 560                     }
 561                 }
 562                 /* Compose rendering pixblock int destination */
 563                 nr_blit_pixblock_pixblock_mask (dpb, &ipb, &mpb);
 564             }
 565             nr_pixblock_release (&mpb);
 566         } else {
 567             if (item->render_opacity) { // opacity was already rendered in, just copy to dpb here
 568                 nr_blit_pixblock_pixblock(dpb, &ipb);
 569             } else { // copy while multiplying by opacity
 570                 nr_blit_pixblock_pixblock_alpha (dpb, &ipb, item->opacity);
 571             }
 572         }
 573         nr_pixblock_release (&ipb);
 574         dpb->empty = FALSE;
 575         /* This pointer wouldn't be valid outside this block, so clear it */
 576         item->background_pb = NULL;
 577     } else {
 578         /* Just render */
 579         unsigned int state = NR_ARENA_ITEM_VIRTUAL (item, render) (ct, item, &carea, dpb, flags);
 580         if (state & NR_ARENA_ITEM_STATE_INVALID) {
 581             /* Clean up and return error */
 582             if (dpb != pb)
 583                 nr_pixblock_release (dpb);
 584             item->state |= NR_ARENA_ITEM_STATE_INVALID;
 585             return item->state;
 586         }
 587         dpb->empty = FALSE;
 588     }
 589
 590     if (dpb != pb) {
 591         /* Have to blit from cache */
 592         nr_blit_pixblock_pixblock (pb, dpb);
 593         nr_pixblock_release (dpb);
 594         pb->empty = FALSE;
 595         item->state |= NR_ARENA_ITEM_STATE_IMAGE;
 596     }
 597
 598     return item->state | NR_ARENA_ITEM_STATE_RENDER;
 599 }
 600
 601 unsigned int
 602 nr_arena_item_invoke_clip (NRArenaItem *item, NRRectL *area, NRPixBlock *pb)
 603 {
 604     nr_return_val_if_fail (item != NULL, NR_ARENA_ITEM_STATE_INVALID);
 605     nr_return_val_if_fail (NR_IS_ARENA_ITEM (item),
 606                            NR_ARENA_ITEM_STATE_INVALID);
 607     /* we originally short-circuited if the object state included
 608      * NR_ARENA_ITEM_STATE_CLIP (and showed a warning on the console);
 609      * anyone know why we stopped doing so?
 610      */
 611     nr_return_val_if_fail ((pb->area.x1 - pb->area.x0) >=
 612                            (area->x1 - area->x0),
 613                            NR_ARENA_ITEM_STATE_INVALID);
 614     nr_return_val_if_fail ((pb->area.y1 - pb->area.y0) >=
 615                            (area->y1 - area->y0),
 616                            NR_ARENA_ITEM_STATE_INVALID);
 617
 618 #ifdef NR_ARENA_ITEM_VERBOSE
 619     printf ("Invoke clip by %p: %d %d - %d %d, item bbox %d %d - %d %d\n",
 620             item, area->x0, area->y0, area->x1, area->y1, (&item->bbox)->x0,
 621             (&item->bbox)->y0, (&item->bbox)->x1, (&item->bbox)->y1);
 622 #endif
 623
 624     if (item->visible && nr_rect_l_test_intersect_ptr(area, &item->bbox)) {
 625         /* Need render that item */
 626         if (((NRArenaItemClass *) NR_OBJECT_GET_CLASS (item))->clip) {
 627             return ((NRArenaItemClass *) NR_OBJECT_GET_CLASS (item))->
 628                 clip (item, area, pb);
 629         }
 630     }
 631
 632     return item->state;
 633 }
 634
 635 NRArenaItem *
 636 nr_arena_item_invoke_pick (NRArenaItem *item, Geom::Point p, double delta,
 637                            unsigned int sticky)
 638 {
 639     nr_return_val_if_fail (item != NULL, NULL);
 640     nr_return_val_if_fail (NR_IS_ARENA_ITEM (item), NULL);
 641
 642     // Sometimes there's no BBOX in item->state, reason unknown (bug 992817); I made this not an assert to remove the warning
 643     if (!(item->state & NR_ARENA_ITEM_STATE_BBOX)
 644         || !(item->state & NR_ARENA_ITEM_STATE_PICK))
 645         return NULL;
 646
 647     if (!sticky && !(item->visible && item->sensitive))
 648         return NULL;
 649
 650     // TODO: rewrite using Geom::Rect
 651     const double x = p[Geom::X];
 652     const double y = p[Geom::Y];
 653
 654     if (((x + delta) >= item->bbox.x0) &&
 655         ((x - delta) < item->bbox.x1) &&
 656         ((y + delta) >= item->bbox.y0) && ((y - delta) < item->bbox.y1)) {
 657         if (((NRArenaItemClass *) NR_OBJECT_GET_CLASS (item))->pick)
 658             return ((NRArenaItemClass *) NR_OBJECT_GET_CLASS (item))->
 659                 pick (item, p, delta, sticky);
 660     }
 661
 662     return NULL;
 663 }
 664
 665 void
 666 nr_arena_item_request_update (NRArenaItem *item, unsigned int reset,
 667                               unsigned int propagate)
 668 {
 669     nr_return_if_fail (item != NULL);
 670     nr_return_if_fail (NR_IS_ARENA_ITEM (item));
 671     nr_return_if_fail (!(reset & NR_ARENA_ITEM_STATE_INVALID));
 672
 673     if (propagate && !item->propagate)
 674         item->propagate = TRUE;
 675
 676     if (item->state & reset) {
 677         item->state &= ~reset;
 678         if (item->parent) {
 679             nr_arena_item_request_update (item->parent, reset, FALSE);
 680         } else {
 681             nr_arena_request_update (item->arena, item);
 682         }
 683     }
 684 }
 685
 686 void
 687 nr_arena_item_request_render (NRArenaItem *item)
 688 {
 689     nr_return_if_fail (item != NULL);
 690     nr_return_if_fail (NR_IS_ARENA_ITEM (item));
 691
 692     nr_arena_request_render_rect (item->arena, &item->drawbox);
 693 }
 694
 695 /* Public */
 696
 697 NRArenaItem *
 698 nr_arena_item_unparent (NRArenaItem *item)
 699 {
 700     nr_return_val_if_fail (item != NULL, NULL);
 701     nr_return_val_if_fail (NR_IS_ARENA_ITEM (item), NULL);
 702
 703     nr_arena_item_request_render (item);
 704
 705     if (item->parent) {
 706         nr_arena_item_remove_child (item->parent, item);
 707     }
 708
 709     return NULL;
 710 }
 711
 712 void
 713 nr_arena_item_append_child (NRArenaItem *parent, NRArenaItem *child)
 714 {
 715     nr_return_if_fail (parent != NULL);
 716     nr_return_if_fail (NR_IS_ARENA_ITEM (parent));
 717     nr_return_if_fail (child != NULL);
 718     nr_return_if_fail (NR_IS_ARENA_ITEM (child));
 719     nr_return_if_fail (parent->arena == child->arena);
 720     nr_return_if_fail (child->parent == NULL);
 721     nr_return_if_fail (child->prev == NULL);
 722     nr_return_if_fail (child->next == NULL);
 723
 724     nr_arena_item_add_child (parent, child, nr_arena_item_last_child (parent));
 725 }
 726
 727 void
 728 nr_arena_item_set_transform (NRArenaItem *item, Geom::Matrix const &transform)
 729 {
 730     Geom::Matrix const t (transform);
 731     nr_arena_item_set_transform (item, &t);
 732 }
 733
 734 void
 735 nr_arena_item_set_transform (NRArenaItem *item, Geom::Matrix const *transform)
 736 {
 737     nr_return_if_fail (item != NULL);
 738     nr_return_if_fail (NR_IS_ARENA_ITEM (item));
 739
 740     if (!transform && !item->transform)
 741         return;
 742
 743     const Geom::Matrix *md = (item->transform) ? item->transform : &GEOM_MATRIX_IDENTITY;
 744     const Geom::Matrix *ms = (transform) ? transform : &GEOM_MATRIX_IDENTITY;
 745
 746     if (!Geom::matrix_equalp(*md, *ms, NR_EPSILON)) {
 747         nr_arena_item_request_render (item);
 748         if (!transform || transform->isIdentity()) {
 749             /* Set to identity affine */
 750             item->transform = NULL;
 751         } else {
 752             if (!item->transform)
 753                 item->transform = new (GC::ATOMIC) Geom::Matrix ();
 754             *item->transform = *transform;
 755         }
 756         nr_arena_item_request_update (item, NR_ARENA_ITEM_STATE_ALL, TRUE);
 757     }
 758 }
 759
 760 void
 761 nr_arena_item_set_opacity (NRArenaItem *item, double opacity)
 762 {
 763     nr_return_if_fail (item != NULL);
 764     nr_return_if_fail (NR_IS_ARENA_ITEM (item));
 765
 766     nr_arena_item_request_render (item);
 767
 768     item->opacity = (unsigned int) (opacity * 255.9999);
 769 }
 770
 771 void
 772 nr_arena_item_set_sensitive (NRArenaItem *item, unsigned int sensitive)
 773 {
 774     nr_return_if_fail (item != NULL);
 775     nr_return_if_fail (NR_IS_ARENA_ITEM (item));
 776
 777     /* fixme: mess with pick/repick... */
 778
 779     item->sensitive = sensitive;
 780 }
 781
 782 void
 783 nr_arena_item_set_visible (NRArenaItem *item, unsigned int visible)
 784 {
 785     nr_return_if_fail (item != NULL);
 786     nr_return_if_fail (NR_IS_ARENA_ITEM (item));
 787
 788     item->visible = visible;
 789
 790     nr_arena_item_request_render (item);
 791 }
 792
 793 void
 794 nr_arena_item_set_clip (NRArenaItem *item, NRArenaItem *clip)
 795 {
 796     nr_return_if_fail (item != NULL);
 797     nr_return_if_fail (NR_IS_ARENA_ITEM (item));
 798     nr_return_if_fail (!clip || NR_IS_ARENA_ITEM (clip));
 799
 800     if (clip != item->clip) {
 801         nr_arena_item_request_render (item);
 802         if (item->clip)
 803             item->clip = nr_arena_item_detach (item, item->clip);
 804         if (clip)
 805             item->clip = nr_arena_item_attach (item, clip, NULL, NULL);
 806         nr_arena_item_request_update (item, NR_ARENA_ITEM_STATE_ALL, TRUE);
 807     }
 808 }
 809
 810 void
 811 nr_arena_item_set_mask (NRArenaItem *item, NRArenaItem *mask)
 812 {
 813     nr_return_if_fail (item != NULL);
 814     nr_return_if_fail (NR_IS_ARENA_ITEM (item));
 815     nr_return_if_fail (!mask || NR_IS_ARENA_ITEM (mask));
 816
 817     if (mask != item->mask) {
 818         nr_arena_item_request_render (item);
 819         if (item->mask)
 820             item->mask = nr_arena_item_detach (item, item->mask);
 821         if (mask)
 822             item->mask = nr_arena_item_attach (item, mask, NULL, NULL);
 823         nr_arena_item_request_update (item, NR_ARENA_ITEM_STATE_ALL, TRUE);
 824     }
 825 }
 826
 827 void
 828 nr_arena_item_set_order (NRArenaItem *item, int order)
 829 {
 830     nr_return_if_fail (item != NULL);
 831     nr_return_if_fail (NR_IS_ARENA_ITEM (item));
 832
 833     if (!item->parent)
 834         return;
 835
 836     NRArenaItem *children = nr_arena_item_children (item->parent);
 837
 838     NRArenaItem *ref = NULL;
 839     int pos = 0;
 840     for (NRArenaItem *child = children; child != NULL; child = child->next) {
 841         if (pos >= order)
 842             break;
 843         if (child != item) {
 844             ref = child;
 845             pos += 1;
 846         }
 847     }
 848
 849     nr_arena_item_set_child_position (item->parent, item, ref);
 850 }
 851
 852 void
 853 nr_arena_item_set_item_bbox (NRArenaItem *item, Geom::OptRect &bbox)
 854 {
 855     nr_return_if_fail(item != NULL);
 856     nr_return_if_fail(NR_IS_ARENA_ITEM(item));
 857
 858     item->item_bbox = bbox;
 859 }
 860
 861 /** Returns a background image for use with filter effects. */
 862 NRPixBlock *
 863 nr_arena_item_get_background (NRArenaItem const *item)
 864 {
 865     if (item->background_new) {
 866         return item->background_pb;
 867     } else if (item->parent) {
 868         return nr_arena_item_get_background (item->parent);
 869     } else {
 870         return NULL;
 871     }
 872 }
 873
 874 /* Helpers */
 875
 876 NRArenaItem *
 877 nr_arena_item_attach (NRArenaItem *parent, NRArenaItem *child,
 878                       NRArenaItem *prev, NRArenaItem *next)
 879 {
 880     nr_return_val_if_fail (parent != NULL, NULL);
 881     nr_return_val_if_fail (NR_IS_ARENA_ITEM (parent), NULL);
 882     nr_return_val_if_fail (child != NULL, NULL);
 883     nr_return_val_if_fail (NR_IS_ARENA_ITEM (child), NULL);
 884     nr_return_val_if_fail (child->parent == NULL, NULL);
 885     nr_return_val_if_fail (child->prev == NULL, NULL);
 886     nr_return_val_if_fail (child->next == NULL, NULL);
 887     nr_return_val_if_fail (!prev || NR_IS_ARENA_ITEM (prev), NULL);
 888     nr_return_val_if_fail (!prev || (prev->parent == parent), NULL);
 889     nr_return_val_if_fail (!prev || (prev->next == next), NULL);
 890     nr_return_val_if_fail (!next || NR_IS_ARENA_ITEM (next), NULL);
 891     nr_return_val_if_fail (!next || (next->parent == parent), NULL);
 892     nr_return_val_if_fail (!next || (next->prev == prev), NULL);
 893
 894     child->parent = parent;
 895     child->prev = prev;
 896     child->next = next;
 897
 898     if (prev)
 899         prev->next = child;
 900     if (next)
 901         next->prev = child;
 902
 903     return child;
 904 }
 905
 906 NRArenaItem *
 907 nr_arena_item_detach (NRArenaItem *parent, NRArenaItem *child)
 908 {
 909     nr_return_val_if_fail (parent != NULL, NULL);
 910     nr_return_val_if_fail (NR_IS_ARENA_ITEM (parent), NULL);
 911     nr_return_val_if_fail (child != NULL, NULL);
 912     nr_return_val_if_fail (NR_IS_ARENA_ITEM (child), NULL);
 913     nr_return_val_if_fail (child->parent == parent, NULL);
 914
 915     NRArenaItem *prev = child->prev;
 916     NRArenaItem *next = child->next;
 917
 918     child->parent = NULL;
 919     child->prev = NULL;
 920     child->next = NULL;
 921
 922     if (prev)
 923         prev->next = next;
 924     if (next)
 925         next->prev = prev;
 926
 927     return next;
 928 }
 929
 930 /*
 931   Local Variables:
 932   mode:c++
 933   c-file-style:"stroustrup"
 934   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 935   indent-tabs-mode:nil
 936   fill-column:99
 937   End:
 938 */
 939 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:fileencoding=utf-8:textwidth=99 :