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"
61 #include "display/nr-filter.h"
62 #include <cairo.h>
64 struct NRGC {
65 NRGC(NRGC const *p) : parent(p) {}
66 NRGC const *parent;
67 NR::Matrix transform;
68 };
70 struct NRArenaItem : public NRObject {
72 NRArena *arena;
73 Inkscape::GC::soft_ptr<NRArenaItem> parent;
74 NRArenaItem *next;
75 Inkscape::GC::soft_ptr<NRArenaItem> prev;
77 /* Item state */
78 unsigned int state : 16;
79 unsigned int propagate : 1;
80 unsigned int sensitive : 1;
81 unsigned int visible : 1;
82 /* Whether items renders opacity itself */
83 unsigned int render_opacity : 1;
84 /* Opacity itself */
85 unsigned int opacity : 8;
87 /* Key for secondary rendering */
88 unsigned int key;
90 /* BBox in grid coordinates */
91 NRRectL bbox;
92 /* BBox in item coordinates - this should be a bounding box as
93 * specified in SVG standard. Required by filters. */
94 NR::Maybe<NR::Rect> item_bbox;
95 /* Our affine */
96 NR::Matrix *transform;
97 /* Clip item */
98 NRArenaItem *clip;
99 /* Mask item */
100 NRArenaItem *mask;
101 /* Filter to be applied after rendering this object, NULL if none */
102 NR::Filter *filter;
103 /* Rendered buffer */
104 unsigned char *px;
106 /* Single data member */
107 void *data;
109 /* Current Transformation Matrix */
110 NR::Matrix ctm;
112 /* These hold background buffer state for filter rendering */
113 NRPixBlock *background_pb;
114 bool background_new;
116 void init(NRArena *arena) {
117 this->arena = arena;
118 }
119 };
121 struct NRArenaItemClass : public NRObjectClass {
122 NRArenaItem * (* children) (NRArenaItem *item);
123 NRArenaItem * (* last_child) (NRArenaItem *item);
124 void (* add_child) (NRArenaItem *item, NRArenaItem *child, NRArenaItem *ref);
125 void (* remove_child) (NRArenaItem *item, NRArenaItem *child);
126 void (* set_child_position) (NRArenaItem *item, NRArenaItem *child, NRArenaItem *ref);
128 unsigned int (* update) (NRArenaItem *item, NRRectL *area, NRGC *gc, unsigned int state, unsigned int reset);
129 unsigned int (* render) (cairo_t *ct, NRArenaItem *item, NRRectL *area, NRPixBlock *pb, unsigned int flags);
130 unsigned int (* clip) (NRArenaItem *item, NRRectL *area, NRPixBlock *pb);
131 NRArenaItem * (* pick) (NRArenaItem *item, NR::Point p, double delta, unsigned int sticky);
132 };
134 #define NR_ARENA_ITEM_ARENA(ai) (((NRArenaItem *) (ai))->arena)
136 NRType nr_arena_item_get_type (void);
138 NRArenaItem *nr_arena_item_ref (NRArenaItem *item);
139 NRArenaItem *nr_arena_item_unref (NRArenaItem *item);
141 NRArenaItem *nr_arena_item_children (NRArenaItem *item);
142 NRArenaItem *nr_arena_item_last_child (NRArenaItem *item);
143 void nr_arena_item_add_child (NRArenaItem *item, NRArenaItem *child, NRArenaItem *ref);
144 void nr_arena_item_remove_child (NRArenaItem *item, NRArenaItem *child);
145 void nr_arena_item_set_child_position (NRArenaItem *item, NRArenaItem *child, NRArenaItem *ref);
147 /*
148 * Invoke update to given state, if item is inside area
149 *
150 * area == NULL is infinite
151 * gc is PARENT gc for invoke, CHILD gc in corresponding virtual method
152 * state - requested to state (bitwise or of requested flags)
153 * reset - reset to state (bitwise or of flags to reset)
154 */
156 unsigned int nr_arena_item_invoke_update (NRArenaItem *item, NRRectL *area, NRGC *gc, unsigned int state, unsigned int reset);
158 unsigned int nr_arena_item_invoke_render(cairo_t *ct, NRArenaItem *item, NRRectL const *area, NRPixBlock *pb, unsigned int flags);
160 unsigned int nr_arena_item_invoke_clip (NRArenaItem *item, NRRectL *area, NRPixBlock *pb);
161 NRArenaItem *nr_arena_item_invoke_pick (NRArenaItem *item, NR::Point p, double delta, unsigned int sticky);
163 void nr_arena_item_request_update (NRArenaItem *item, unsigned int reset, unsigned int propagate);
164 void nr_arena_item_request_render (NRArenaItem *item);
166 /* Public */
168 NRArenaItem *nr_arena_item_unparent (NRArenaItem *item);
170 void nr_arena_item_append_child (NRArenaItem *parent, NRArenaItem *child);
172 void nr_arena_item_set_transform(NRArenaItem *item, NR::Matrix const &transform);
173 void nr_arena_item_set_transform(NRArenaItem *item, NR::Matrix const *transform);
174 void nr_arena_item_set_opacity (NRArenaItem *item, double opacity);
175 void nr_arena_item_set_sensitive (NRArenaItem *item, unsigned int sensitive);
176 void nr_arena_item_set_visible (NRArenaItem *item, unsigned int visible);
177 void nr_arena_item_set_clip (NRArenaItem *item, NRArenaItem *clip);
178 void nr_arena_item_set_mask (NRArenaItem *item, NRArenaItem *mask);
179 void nr_arena_item_set_order (NRArenaItem *item, int order);
180 void nr_arena_item_set_item_bbox (NRArenaItem *item, NR::Maybe<NR::Rect> &bbox);
182 NRPixBlock *nr_arena_item_get_background (NRArenaItem const *item, int depth = 0);
184 /* Helpers */
186 NRArenaItem *nr_arena_item_attach (NRArenaItem *parent, NRArenaItem *child, NRArenaItem *prev, NRArenaItem *next);
187 NRArenaItem *nr_arena_item_detach (NRArenaItem *parent, NRArenaItem *child);
189 #define NR_ARENA_ITEM_SET_DATA(i,v) (((NRArenaItem *) (i))->data = (v))
190 #define NR_ARENA_ITEM_GET_DATA(i) (((NRArenaItem *) (i))->data)
192 #define NR_ARENA_ITEM_SET_KEY(i,k) (((NRArenaItem *) (i))->key = (k))
193 #define NR_ARENA_ITEM_GET_KEY(i) (((NRArenaItem *) (i))->key)
196 #endif /* !__NR_ARENA_ITEM_H__ */
198 /*
199 Local Variables:
200 mode:c++
201 c-file-style:"stroustrup"
202 c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
203 indent-tabs-mode:nil
204 fill-column:99
205 End:
206 */
207 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :