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