737fed879f916612e67fb4e56d11a47d1db91791
1 #ifndef __NR_ARENA_ITEM_H__
2 #define __NR_ARENA_ITEM_H__
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 */
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))
20 #define NR_ARENA_ITEM_VIRTUAL(i,m) (((NRArenaItemClass *) NR_OBJECT_GET_CLASS (i))->m)
22 /*
23 * NRArenaItem state flags
24 */
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 */
34 #define NR_ARENA_ITEM_STATE_INVALID (1 << 0)
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)
46 #define NR_ARENA_ITEM_STATE_NONE 0x0000
47 #define NR_ARENA_ITEM_STATE_ALL 0x01fe
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))
53 #define NR_ARENA_ITEM_RENDER_NO_CACHE (1 << 0)
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"
62 // My testing shows that disabling cache reduces the amount
63 // of leaked memory when many documents are loaded one from the other,
64 // while there's no noticeable change in speed
65 //#define arena_item_tile_cache
67 struct NRGC {
68 NRGC(NRGC const *p) : parent(p) {}
69 NRGC const *parent;
70 NRMatrix transform;
71 };
73 struct NRArenaItem : public NRObject {
74 Inkscape::GC::soft_ptr<NRArena> arena;
75 Inkscape::GC::soft_ptr<NRArenaItem> parent;
76 NRArenaItem *next;
77 Inkscape::GC::soft_ptr<NRArenaItem> prev;
79 /* Item state */
80 unsigned int state : 16;
81 unsigned int propagate : 1;
82 unsigned int sensitive : 1;
83 unsigned int visible : 1;
84 /* Whether items renders opacity itself */
85 unsigned int render_opacity : 1;
86 /* Opacity itself */
87 unsigned int opacity : 8;
89 /* Key for secondary rendering */
90 unsigned int key;
92 #ifdef arena_item_tile_cache
93 bool skipCaching;
94 double activity;
95 #endif
97 /* BBox in grid coordinates */
98 NRRectL bbox;
99 /* Our affine */
100 NRMatrix *transform;
101 /* Clip item */
102 NRArenaItem *clip;
103 /* Mask item */
104 NRArenaItem *mask;
105 /* Rendered buffer */
106 unsigned char *px;
108 /* Single data member */
109 void *data;
111 void init(NRArena *arena) {
112 this->arena = arena;
113 }
114 };
116 struct NRArenaItemClass : public NRObjectClass {
117 NRArenaItem * (* children) (NRArenaItem *item);
118 NRArenaItem * (* last_child) (NRArenaItem *item);
119 void (* add_child) (NRArenaItem *item, NRArenaItem *child, NRArenaItem *ref);
120 void (* remove_child) (NRArenaItem *item, NRArenaItem *child);
121 void (* set_child_position) (NRArenaItem *item, NRArenaItem *child, NRArenaItem *ref);
123 unsigned int (* update) (NRArenaItem *item, NRRectL *area, NRGC *gc, unsigned int state, unsigned int reset);
124 unsigned int (* render) (NRArenaItem *item, NRRectL *area, NRPixBlock *pb, unsigned int flags);
125 unsigned int (* clip) (NRArenaItem *item, NRRectL *area, NRPixBlock *pb);
126 NRArenaItem * (* pick) (NRArenaItem *item, NR::Point p, double delta, unsigned int sticky);
127 };
129 #define NR_ARENA_ITEM_ARENA(ai) (((NRArenaItem *) (ai))->arena)
131 NRType nr_arena_item_get_type (void);
133 NRArenaItem *nr_arena_item_ref (NRArenaItem *item);
134 NRArenaItem *nr_arena_item_unref (NRArenaItem *item);
136 NRArenaItem *nr_arena_item_children (NRArenaItem *item);
137 NRArenaItem *nr_arena_item_last_child (NRArenaItem *item);
138 void nr_arena_item_add_child (NRArenaItem *item, NRArenaItem *child, NRArenaItem *ref);
139 void nr_arena_item_remove_child (NRArenaItem *item, NRArenaItem *child);
140 void nr_arena_item_set_child_position (NRArenaItem *item, NRArenaItem *child, NRArenaItem *ref);
142 /*
143 * Invoke update to given state, if item is inside area
144 *
145 * area == NULL is infinite
146 * gc is PARENT gc for invoke, CHILD gc in corresponding virtual method
147 * state - requested to state (bitwise or of requested flags)
148 * reset - reset to state (bitwise or of flags to reset)
149 */
151 unsigned int nr_arena_item_invoke_update (NRArenaItem *item, NRRectL *area, NRGC *gc, unsigned int state, unsigned int reset);
153 unsigned int nr_arena_item_invoke_render(NRArenaItem *item, NRRectL const *area, NRPixBlock *pb, unsigned int flags);
155 unsigned int nr_arena_item_invoke_clip (NRArenaItem *item, NRRectL *area, NRPixBlock *pb);
156 NRArenaItem *nr_arena_item_invoke_pick (NRArenaItem *item, NR::Point p, double delta, unsigned int sticky);
158 void nr_arena_item_request_update (NRArenaItem *item, unsigned int reset, unsigned int propagate);
159 void nr_arena_item_request_render (NRArenaItem *item);
161 /* Public */
163 NRArenaItem *nr_arena_item_unparent (NRArenaItem *item);
165 void nr_arena_item_append_child (NRArenaItem *parent, NRArenaItem *child);
167 void nr_arena_item_set_transform(NRArenaItem *item, NR::Matrix const &transform);
168 void nr_arena_item_set_transform(NRArenaItem *item, NRMatrix const *transform);
169 void nr_arena_item_set_opacity (NRArenaItem *item, double opacity);
170 void nr_arena_item_set_sensitive (NRArenaItem *item, unsigned int sensitive);
171 void nr_arena_item_set_visible (NRArenaItem *item, unsigned int visible);
172 void nr_arena_item_set_clip (NRArenaItem *item, NRArenaItem *clip);
173 void nr_arena_item_set_mask (NRArenaItem *item, NRArenaItem *mask);
174 void nr_arena_item_set_order (NRArenaItem *item, int order);
176 /* Helpers */
178 NRArenaItem *nr_arena_item_attach_ref (NRArenaItem *parent, NRArenaItem *child, NRArenaItem *prev, NRArenaItem *next);
179 NRArenaItem *nr_arena_item_detach_unref (NRArenaItem *parent, NRArenaItem *child);
181 #define NR_ARENA_ITEM_SET_DATA(i,v) (((NRArenaItem *) (i))->data = (v))
182 #define NR_ARENA_ITEM_GET_DATA(i) (((NRArenaItem *) (i))->data)
184 #define NR_ARENA_ITEM_SET_KEY(i,k) (((NRArenaItem *) (i))->key = (k))
185 #define NR_ARENA_ITEM_GET_KEY(i) (((NRArenaItem *) (i))->key)
187 #endif