src/display/nr-arena-item.h

   1 #ifndef __NR_ARENA_ITEM_H__
   2 #define __NR_ARENA_ITEM_H__
   3
   4 /*
   5  * RGBA display list system for inkscape
   6  *
   7  * Author:
   8  *   Lauris Kaplinski <lauris@kaplinski.com>
   9  *
  10  * Copyright (C) 2001-2002 Lauris Kaplinski
  11  * Copyright (C) 2001 Ximian, Inc.
  12  *
  13  * Released under GNU GPL, read the file 'COPYING' for more information
  14  */
  15
  16 #define NR_TYPE_ARENA_ITEM (nr_arena_item_get_type ())
  17 #define NR_ARENA_ITEM(o) (NR_CHECK_INSTANCE_CAST ((o), NR_TYPE_ARENA_ITEM, NRArenaItem))
  18 #define NR_IS_ARENA_ITEM(o) (NR_CHECK_INSTANCE_TYPE ((o), NR_TYPE_ARENA_ITEM))
  19
  20 #define NR_ARENA_ITEM_VIRTUAL(i,m) (((NRArenaItemClass *) NR_OBJECT_GET_CLASS (i))->m)
  21
  22 /*
  23  * NRArenaItem state flags
  24  */
  25
  26 /*
  27  * NR_ARENA_ITEM_STATE_INVALID
  28  *
  29  * If set or retuned indicates, that given object is in error.
  30  * Calling method has to return immediately, with appropriate
  31  * error flag.
  32  */
  33
  34 #define NR_ARENA_ITEM_STATE_INVALID  (1 << 0)
  35
  36
  37 #define NR_ARENA_ITEM_STATE_BBOX     (1 << 1)
  38 #define NR_ARENA_ITEM_STATE_COVERAGE (1 << 2)
  39 #define NR_ARENA_ITEM_STATE_DRAFT    (1 << 3)
  40 #define NR_ARENA_ITEM_STATE_RENDER   (1 << 4)
  41 #define NR_ARENA_ITEM_STATE_CLIP     (1 << 5)
  42 #define NR_ARENA_ITEM_STATE_MASK     (1 << 6)
  43 #define NR_ARENA_ITEM_STATE_PICK     (1 << 7)
  44 #define NR_ARENA_ITEM_STATE_IMAGE    (1 << 8)
  45
  46 #define NR_ARENA_ITEM_STATE_NONE  0x0000
  47 #define NR_ARENA_ITEM_STATE_ALL   0x01fe
  48
  49 #define NR_ARENA_ITEM_STATE(i,s) (NR_ARENA_ITEM (i)->state & (s))
  50 #define NR_ARENA_ITEM_SET_STATE(i,s) (NR_ARENA_ITEM (i)->state |= (s))
  51 #define NR_ARENA_ITEM_UNSET_STATE(i,s) (NR_ARENA_ITEM (i)->state &= ~(s))
  52
  53 #define NR_ARENA_ITEM_RENDER_NO_CACHE (1 << 0)
  54
  55 #include <libnr/nr-matrix.h>
  56 #include <libnr/nr-rect-l.h>
  57 #include <libnr/nr-pixblock.h>
  58 #include <libnr/nr-object.h>
  59 #include "gc-soft-ptr.h"
  60 #include "nr-arena-forward.h"
  61 #include "display/nr-filter.h"
  62
  63 // My testing shows that disabling cache reduces the amount
  64 // of leaked memory when many documents are loaded one from the other,
  65 // while there's no noticeable change in speed
  66 //#define arena_item_tile_cache
  67
  68 struct NRGC {
  69         NRGC(NRGC const *p) : parent(p) {}
  70         NRGC const *parent;
  71         NRMatrix transform;
  72 };
  73
  74 struct NRArenaItem : public NRObject {
  75
  76         NRArena *arena;
  77         Inkscape::GC::soft_ptr<NRArenaItem> parent;
  78         NRArenaItem *next;
  79         Inkscape::GC::soft_ptr<NRArenaItem> prev;
  80
  81         /* Item state */
  82         unsigned int state : 16;
  83         unsigned int propagate : 1;
  84         unsigned int sensitive : 1;
  85         unsigned int visible : 1;
  86         /* Whether items renders opacity itself */
  87         unsigned int render_opacity : 1;
  88         /* Opacity itself */
  89         unsigned int opacity : 8;
  90
  91         /* Key for secondary rendering */
  92         unsigned int key;
  93
  94 #ifdef arena_item_tile_cache
  95   bool     skipCaching;
  96   double   activity;
  97 #endif
  98
  99         /* BBox in grid coordinates */
 100         NRRectL bbox;
 101         /* Our affine */
 102         NRMatrix *transform;
 103         /* Clip item */
 104         NRArenaItem *clip;
 105         /* Mask item */
 106         NRArenaItem *mask;
 107         /* Filter to be applied after rendering this object, NULL if none */
 108         NR::Filter *filter;
 109         /* Rendered buffer */
 110         unsigned char *px;
 111
 112         /* Single data member */
 113         void *data;
 114
 115         /* Current Transformation Matrix */
 116         NR::Matrix ctm;
 117
 118         /* These hold background buffer state for filter rendering */
 119         NRPixBlock *background_pb;
 120         bool background_new;
 121
 122         void init(NRArena *arena) {
 123                 this->arena = arena;
 124         }
 125 };
 126
 127 struct NRArenaItemClass : public NRObjectClass {
 128         NRArenaItem * (* children) (NRArenaItem *item);
 129         NRArenaItem * (* last_child) (NRArenaItem *item);
 130         void (* add_child) (NRArenaItem *item, NRArenaItem *child, NRArenaItem *ref);
 131         void (* remove_child) (NRArenaItem *item, NRArenaItem *child);
 132         void (* set_child_position) (NRArenaItem *item, NRArenaItem *child, NRArenaItem *ref);
 133
 134         unsigned int (* update) (NRArenaItem *item, NRRectL *area, NRGC *gc, unsigned int state, unsigned int reset);
 135         unsigned int (* render) (NRArenaItem *item, NRRectL *area, NRPixBlock *pb, unsigned int flags);
 136         unsigned int (* clip) (NRArenaItem *item, NRRectL *area, NRPixBlock *pb);
 137         NRArenaItem * (* pick) (NRArenaItem *item, NR::Point p, double delta, unsigned int sticky);
 138 };
 139
 140 #define NR_ARENA_ITEM_ARENA(ai) (((NRArenaItem *) (ai))->arena)
 141
 142 NRType nr_arena_item_get_type (void);
 143
 144 NRArenaItem *nr_arena_item_ref (NRArenaItem *item);
 145 NRArenaItem *nr_arena_item_unref (NRArenaItem *item);
 146
 147 NRArenaItem *nr_arena_item_children (NRArenaItem *item);
 148 NRArenaItem *nr_arena_item_last_child (NRArenaItem *item);
 149 void nr_arena_item_add_child (NRArenaItem *item, NRArenaItem *child, NRArenaItem *ref);
 150 void nr_arena_item_remove_child (NRArenaItem *item, NRArenaItem *child);
 151 void nr_arena_item_set_child_position (NRArenaItem *item, NRArenaItem *child, NRArenaItem *ref);
 152
 153 /*
 154  * Invoke update to given state, if item is inside area
 155  *
 156  * area == NULL is infinite
 157  * gc is PARENT gc for invoke, CHILD gc in corresponding virtual method
 158  * state - requested to state (bitwise or of requested flags)
 159  * reset - reset to state (bitwise or of flags to reset)
 160  */
 161
 162 unsigned int nr_arena_item_invoke_update (NRArenaItem *item, NRRectL *area, NRGC *gc, unsigned int state, unsigned int reset);
 163
 164 unsigned int nr_arena_item_invoke_render(NRArenaItem *item, NRRectL const *area, NRPixBlock *pb, unsigned int flags);
 165
 166 unsigned int nr_arena_item_invoke_clip (NRArenaItem *item, NRRectL *area, NRPixBlock *pb);
 167 NRArenaItem *nr_arena_item_invoke_pick (NRArenaItem *item, NR::Point p, double delta, unsigned int sticky);
 168
 169 void nr_arena_item_request_update (NRArenaItem *item, unsigned int reset, unsigned int propagate);
 170 void nr_arena_item_request_render (NRArenaItem *item);
 171
 172 /* Public */
 173
 174 NRArenaItem *nr_arena_item_unparent (NRArenaItem *item);
 175
 176 void nr_arena_item_append_child (NRArenaItem *parent, NRArenaItem *child);
 177
 178 void nr_arena_item_set_transform(NRArenaItem *item, NR::Matrix const &transform);
 179 void nr_arena_item_set_transform(NRArenaItem *item, NRMatrix const *transform);
 180 void nr_arena_item_set_opacity (NRArenaItem *item, double opacity);
 181 void nr_arena_item_set_sensitive (NRArenaItem *item, unsigned int sensitive);
 182 void nr_arena_item_set_visible (NRArenaItem *item, unsigned int visible);
 183 void nr_arena_item_set_clip (NRArenaItem *item, NRArenaItem *clip);
 184 void nr_arena_item_set_mask (NRArenaItem *item, NRArenaItem *mask);
 185 void nr_arena_item_set_order (NRArenaItem *item, int order);
 186
 187 NRPixBlock *nr_arena_item_get_background (NRArenaItem const *item, int depth = 0);
 188
 189 /* Helpers */
 190
 191 NRArenaItem *nr_arena_item_attach (NRArenaItem *parent, NRArenaItem *child, NRArenaItem *prev, NRArenaItem *next);
 192 NRArenaItem *nr_arena_item_detach (NRArenaItem *parent, NRArenaItem *child);
 193
 194 #define NR_ARENA_ITEM_SET_DATA(i,v) (((NRArenaItem *) (i))->data = (v))
 195 #define NR_ARENA_ITEM_GET_DATA(i) (((NRArenaItem *) (i))->data)
 196
 197 #define NR_ARENA_ITEM_SET_KEY(i,k) (((NRArenaItem *) (i))->key = (k))
 198 #define NR_ARENA_ITEM_GET_KEY(i) (((NRArenaItem *) (i))->key)
 199
 200 #endif