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 struct NRGC {
  64         NRGC(NRGC const *p) : parent(p) {}
  65         NRGC const *parent;
  66         NRMatrix transform;
  67 };
  68
  69 struct NRArenaItem : public NRObject {
  70
  71         NRArena *arena;
  72         Inkscape::GC::soft_ptr<NRArenaItem> parent;
  73         NRArenaItem *next;
  74         Inkscape::GC::soft_ptr<NRArenaItem> prev;
  75
  76         /* Item state */
  77         unsigned int state : 16;
  78         unsigned int propagate : 1;
  79         unsigned int sensitive : 1;
  80         unsigned int visible : 1;
  81         /* Whether items renders opacity itself */
  82         unsigned int render_opacity : 1;
  83         /* Opacity itself */
  84         unsigned int opacity : 8;
  85
  86         /* Key for secondary rendering */
  87         unsigned int key;
  88
  89         /* BBox in grid coordinates */
  90         NRRectL bbox;
  91         /* Our affine */
  92         NRMatrix *transform;
  93         /* Clip item */
  94         NRArenaItem *clip;
  95         /* Mask item */
  96         NRArenaItem *mask;
  97         /* Filter to be applied after rendering this object, NULL if none */
  98         NR::Filter *filter;
  99         /* Rendered buffer */
 100         unsigned char *px;
 101
 102         /* Single data member */
 103         void *data;
 104
 105         /* Current Transformation Matrix */
 106         NR::Matrix ctm;
 107
 108         /* These hold background buffer state for filter rendering */
 109         NRPixBlock *background_pb;
 110         bool background_new;
 111
 112         void init(NRArena *arena) {
 113                 this->arena = arena;
 114         }
 115 };
 116
 117 struct NRArenaItemClass : public NRObjectClass {
 118         NRArenaItem * (* children) (NRArenaItem *item);
 119         NRArenaItem * (* last_child) (NRArenaItem *item);
 120         void (* add_child) (NRArenaItem *item, NRArenaItem *child, NRArenaItem *ref);
 121         void (* remove_child) (NRArenaItem *item, NRArenaItem *child);
 122         void (* set_child_position) (NRArenaItem *item, NRArenaItem *child, NRArenaItem *ref);
 123
 124         unsigned int (* update) (NRArenaItem *item, NRRectL *area, NRGC *gc, unsigned int state, unsigned int reset);
 125         unsigned int (* render) (NRArenaItem *item, NRRectL *area, NRPixBlock *pb, unsigned int flags);
 126         unsigned int (* clip) (NRArenaItem *item, NRRectL *area, NRPixBlock *pb);
 127         NRArenaItem * (* pick) (NRArenaItem *item, NR::Point p, double delta, unsigned int sticky);
 128 };
 129
 130 #define NR_ARENA_ITEM_ARENA(ai) (((NRArenaItem *) (ai))->arena)
 131
 132 NRType nr_arena_item_get_type (void);
 133
 134 NRArenaItem *nr_arena_item_ref (NRArenaItem *item);
 135 NRArenaItem *nr_arena_item_unref (NRArenaItem *item);
 136
 137 NRArenaItem *nr_arena_item_children (NRArenaItem *item);
 138 NRArenaItem *nr_arena_item_last_child (NRArenaItem *item);
 139 void nr_arena_item_add_child (NRArenaItem *item, NRArenaItem *child, NRArenaItem *ref);
 140 void nr_arena_item_remove_child (NRArenaItem *item, NRArenaItem *child);
 141 void nr_arena_item_set_child_position (NRArenaItem *item, NRArenaItem *child, NRArenaItem *ref);
 142
 143 /*
 144  * Invoke update to given state, if item is inside area
 145  *
 146  * area == NULL is infinite
 147  * gc is PARENT gc for invoke, CHILD gc in corresponding virtual method
 148  * state - requested to state (bitwise or of requested flags)
 149  * reset - reset to state (bitwise or of flags to reset)
 150  */
 151
 152 unsigned int nr_arena_item_invoke_update (NRArenaItem *item, NRRectL *area, NRGC *gc, unsigned int state, unsigned int reset);
 153
 154 unsigned int nr_arena_item_invoke_render(NRArenaItem *item, NRRectL const *area, NRPixBlock *pb, unsigned int flags);
 155
 156 unsigned int nr_arena_item_invoke_clip (NRArenaItem *item, NRRectL *area, NRPixBlock *pb);
 157 NRArenaItem *nr_arena_item_invoke_pick (NRArenaItem *item, NR::Point p, double delta, unsigned int sticky);
 158
 159 void nr_arena_item_request_update (NRArenaItem *item, unsigned int reset, unsigned int propagate);
 160 void nr_arena_item_request_render (NRArenaItem *item);
 161
 162 /* Public */
 163
 164 NRArenaItem *nr_arena_item_unparent (NRArenaItem *item);
 165
 166 void nr_arena_item_append_child (NRArenaItem *parent, NRArenaItem *child);
 167
 168 void nr_arena_item_set_transform(NRArenaItem *item, NR::Matrix const &transform);
 169 void nr_arena_item_set_transform(NRArenaItem *item, NRMatrix const *transform);
 170 void nr_arena_item_set_opacity (NRArenaItem *item, double opacity);
 171 void nr_arena_item_set_sensitive (NRArenaItem *item, unsigned int sensitive);
 172 void nr_arena_item_set_visible (NRArenaItem *item, unsigned int visible);
 173 void nr_arena_item_set_clip (NRArenaItem *item, NRArenaItem *clip);
 174 void nr_arena_item_set_mask (NRArenaItem *item, NRArenaItem *mask);
 175 void nr_arena_item_set_order (NRArenaItem *item, int order);
 176
 177 NRPixBlock *nr_arena_item_get_background (NRArenaItem const *item, int depth = 0);
 178
 179 /* Helpers */
 180
 181 NRArenaItem *nr_arena_item_attach (NRArenaItem *parent, NRArenaItem *child, NRArenaItem *prev, NRArenaItem *next);
 182 NRArenaItem *nr_arena_item_detach (NRArenaItem *parent, NRArenaItem *child);
 183
 184 #define NR_ARENA_ITEM_SET_DATA(i,v) (((NRArenaItem *) (i))->data = (v))
 185 #define NR_ARENA_ITEM_GET_DATA(i) (((NRArenaItem *) (i))->data)
 186
 187 #define NR_ARENA_ITEM_SET_KEY(i,k) (((NRArenaItem *) (i))->key = (k))
 188 #define NR_ARENA_ITEM_GET_KEY(i) (((NRArenaItem *) (i))->key)
 189
 190 #endif