1 #define __SP_MASK_C__
3 /*
4 * SVG <mask> implementation
5 *
6 * Authors:
7 * Lauris Kaplinski <lauris@kaplinski.com>
8 *
9 * Copyright (C) 2003 authors
10 *
11 * Released under GNU GPL, read the file 'COPYING' for more information
12 */
14 #include <cstring>
15 #include <string>
17 #include "display/nr-arena.h"
18 #include "display/nr-arena-group.h"
19 #include "libnr/nr-matrix-ops.h"
20 #include <xml/repr.h>
22 #include "enums.h"
23 #include "attributes.h"
24 #include "document.h"
25 #include "document-private.h"
26 #include "sp-item.h"
28 #include "sp-mask.h"
30 struct SPMaskView {
31 SPMaskView *next;
32 unsigned int key;
33 NRArenaItem *arenaitem;
34 NRRect bbox;
35 };
37 static void sp_mask_class_init (SPMaskClass *klass);
38 static void sp_mask_init (SPMask *mask);
40 static void sp_mask_build (SPObject *object, SPDocument *document, Inkscape::XML::Node *repr);
41 static void sp_mask_release (SPObject * object);
42 static void sp_mask_set (SPObject *object, unsigned int key, const gchar *value);
43 static void sp_mask_child_added (SPObject *object, Inkscape::XML::Node *child, Inkscape::XML::Node *ref);
44 static void sp_mask_update (SPObject *object, SPCtx *ctx, guint flags);
45 static void sp_mask_modified (SPObject *object, guint flags);
46 static Inkscape::XML::Node *sp_mask_write (SPObject *object, Inkscape::XML::Document *doc, Inkscape::XML::Node *repr, guint flags);
48 SPMaskView *sp_mask_view_new_prepend (SPMaskView *list, unsigned int key, NRArenaItem *arenaitem);
49 SPMaskView *sp_mask_view_list_remove (SPMaskView *list, SPMaskView *view);
51 static SPObjectGroupClass *parent_class;
53 GType
54 sp_mask_get_type (void)
55 {
56 static GType type = 0;
57 if (!type) {
58 GTypeInfo info = {
59 sizeof (SPMaskClass),
60 NULL, NULL,
61 (GClassInitFunc) sp_mask_class_init,
62 NULL, NULL,
63 sizeof (SPMask),
64 16,
65 (GInstanceInitFunc) sp_mask_init,
66 NULL, /* value_table */
67 };
68 type = g_type_register_static (SP_TYPE_OBJECTGROUP, "SPMask", &info, (GTypeFlags)0);
69 }
70 return type;
71 }
73 static void
74 sp_mask_class_init (SPMaskClass *klass)
75 {
76 parent_class = (SPObjectGroupClass*) g_type_class_ref (SP_TYPE_OBJECTGROUP);
78 SPObjectClass *sp_object_class = (SPObjectClass *) klass;
79 sp_object_class->build = sp_mask_build;
80 sp_object_class->release = sp_mask_release;
81 sp_object_class->set = sp_mask_set;
82 sp_object_class->child_added = sp_mask_child_added;
83 sp_object_class->update = sp_mask_update;
84 sp_object_class->modified = sp_mask_modified;
85 sp_object_class->write = sp_mask_write;
86 }
88 static void
89 sp_mask_init (SPMask *mask)
90 {
91 mask->maskUnits_set = FALSE;
92 mask->maskUnits = SP_CONTENT_UNITS_OBJECTBOUNDINGBOX;
94 mask->maskContentUnits_set = FALSE;
95 mask->maskContentUnits = SP_CONTENT_UNITS_USERSPACEONUSE;
97 mask->display = NULL;
98 }
100 static void
101 sp_mask_build (SPObject *object, SPDocument *document, Inkscape::XML::Node *repr)
102 {
103 if (((SPObjectClass *) parent_class)->build) {
104 ((SPObjectClass *) parent_class)->build (object, document, repr);
105 }
107 sp_object_read_attr (object, "maskUnits");
108 sp_object_read_attr (object, "maskContentUnits");
110 /* Register ourselves */
111 sp_document_add_resource (document, "mask", object);
112 }
114 static void
115 sp_mask_release (SPObject * object)
116 {
117 if (SP_OBJECT_DOCUMENT (object)) {
118 /* Unregister ourselves */
119 sp_document_remove_resource (SP_OBJECT_DOCUMENT (object), "mask", object);
120 }
122 SPMask *cp = SP_MASK (object);
123 while (cp->display) {
124 /* We simply unref and let item manage this in handler */
125 cp->display = sp_mask_view_list_remove (cp->display, cp->display);
126 }
128 if (((SPObjectClass *) (parent_class))->release) {
129 ((SPObjectClass *) parent_class)->release (object);
130 }
131 }
133 static void
134 sp_mask_set (SPObject *object, unsigned int key, const gchar *value)
135 {
136 SPMask *mask = SP_MASK (object);
138 switch (key) {
139 case SP_ATTR_MASKUNITS:
140 mask->maskUnits = SP_CONTENT_UNITS_OBJECTBOUNDINGBOX;
141 mask->maskUnits_set = FALSE;
142 if (value) {
143 if (!strcmp (value, "userSpaceOnUse")) {
144 mask->maskUnits = SP_CONTENT_UNITS_USERSPACEONUSE;
145 mask->maskUnits_set = TRUE;
146 } else if (!strcmp (value, "objectBoundingBox")) {
147 mask->maskUnits_set = TRUE;
148 }
149 }
150 object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
151 break;
152 case SP_ATTR_MASKCONTENTUNITS:
153 mask->maskContentUnits = SP_CONTENT_UNITS_USERSPACEONUSE;
154 mask->maskContentUnits_set = FALSE;
155 if (value) {
156 if (!strcmp (value, "userSpaceOnUse")) {
157 mask->maskContentUnits_set = TRUE;
158 } else if (!strcmp (value, "objectBoundingBox")) {
159 mask->maskContentUnits = SP_CONTENT_UNITS_OBJECTBOUNDINGBOX;
160 mask->maskContentUnits_set = TRUE;
161 }
162 }
163 object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
164 break;
165 default:
166 if (((SPObjectClass *) parent_class)->set)
167 ((SPObjectClass *) parent_class)->set (object, key, value);
168 break;
169 }
170 }
172 static void
173 sp_mask_child_added (SPObject *object, Inkscape::XML::Node *child, Inkscape::XML::Node *ref)
174 {
175 /* Invoke SPObjectGroup implementation */
176 ((SPObjectClass *) (parent_class))->child_added (object, child, ref);
178 /* Show new object */
179 SPObject *ochild = SP_OBJECT_DOCUMENT (object)->getObjectByRepr(child);
180 if (SP_IS_ITEM (ochild)) {
181 SPMask *cp = SP_MASK (object);
182 for (SPMaskView *v = cp->display; v != NULL; v = v->next) {
183 NRArenaItem *ac = sp_item_invoke_show (SP_ITEM (ochild),
184 NR_ARENA_ITEM_ARENA (v->arenaitem),
185 v->key,
186 SP_ITEM_REFERENCE_FLAGS);
187 if (ac) {
188 nr_arena_item_add_child (v->arenaitem, ac, NULL);
189 nr_arena_item_unref (ac);
190 }
191 }
192 }
193 }
195 static void
196 sp_mask_update (SPObject *object, SPCtx *ctx, guint flags)
197 {
198 if (flags & SP_OBJECT_MODIFIED_FLAG) {
199 flags |= SP_OBJECT_PARENT_MODIFIED_FLAG;
200 }
202 flags &= SP_OBJECT_MODIFIED_CASCADE;
204 SPObjectGroup *og = SP_OBJECTGROUP (object);
205 GSList *l = NULL;
206 for (SPObject *child = sp_object_first_child(SP_OBJECT(og)); child != NULL; child = SP_OBJECT_NEXT(child)) {
207 g_object_ref (G_OBJECT (child));
208 l = g_slist_prepend (l, child);
209 }
210 l = g_slist_reverse (l);
211 while (l) {
212 SPObject *child = SP_OBJECT (l->data);
213 l = g_slist_remove (l, child);
214 if (flags || (child->uflags & (SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_CHILD_MODIFIED_FLAG))) {
215 child->updateDisplay(ctx, flags);
216 }
217 g_object_unref (G_OBJECT (child));
218 }
220 SPMask *mask = SP_MASK (object);
221 for (SPMaskView *v = mask->display; v != NULL; v = v->next) {
222 if (mask->maskContentUnits == SP_CONTENT_UNITS_OBJECTBOUNDINGBOX) {
223 NR::Matrix t(NR::scale(v->bbox.x1 - v->bbox.x0, v->bbox.y1 - v->bbox.y0));
224 t[4] = v->bbox.x0;
225 t[5] = v->bbox.y0;
226 nr_arena_group_set_child_transform (NR_ARENA_GROUP (v->arenaitem), &t);
227 } else {
228 nr_arena_group_set_child_transform (NR_ARENA_GROUP (v->arenaitem), NULL);
229 }
230 }
231 }
233 static void
234 sp_mask_modified (SPObject *object, guint flags)
235 {
236 if (flags & SP_OBJECT_MODIFIED_FLAG) {
237 flags |= SP_OBJECT_PARENT_MODIFIED_FLAG;
238 }
240 flags &= SP_OBJECT_MODIFIED_CASCADE;
242 SPObjectGroup *og = SP_OBJECTGROUP (object);
243 GSList *l = NULL;
244 for (SPObject *child = sp_object_first_child(SP_OBJECT(og)); child != NULL; child = SP_OBJECT_NEXT(child)) {
245 g_object_ref (G_OBJECT (child));
246 l = g_slist_prepend (l, child);
247 }
248 l = g_slist_reverse (l);
249 while (l) {
250 SPObject *child = SP_OBJECT (l->data);
251 l = g_slist_remove (l, child);
252 if (flags || (child->mflags & (SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_CHILD_MODIFIED_FLAG))) {
253 child->emitModified(flags);
254 }
255 g_object_unref (G_OBJECT (child));
256 }
257 }
259 static Inkscape::XML::Node *
260 sp_mask_write (SPObject *object, Inkscape::XML::Document *xml_doc, Inkscape::XML::Node *repr, guint flags)
261 {
262 if ((flags & SP_OBJECT_WRITE_BUILD) && !repr) {
263 repr = xml_doc->createElement("svg:mask");
264 }
266 if (((SPObjectClass *) (parent_class))->write)
267 ((SPObjectClass *) (parent_class))->write (object, xml_doc, repr, flags);
269 return repr;
270 }
272 // Create a mask element (using passed elements), add it to <defs>
273 const gchar *
274 sp_mask_create (GSList *reprs, SPDocument *document, NR::Matrix const* applyTransform)
275 {
276 Inkscape::XML::Node *defsrepr = SP_OBJECT_REPR (SP_DOCUMENT_DEFS (document));
278 Inkscape::XML::Document *xml_doc = sp_document_repr_doc(document);
279 Inkscape::XML::Node *repr = xml_doc->createElement("svg:mask");
280 repr->setAttribute("maskUnits", "userSpaceOnUse");
282 defsrepr->appendChild(repr);
283 const gchar *mask_id = repr->attribute("id");
284 SPObject *mask_object = document->getObjectById(mask_id);
286 for (GSList *it = reprs; it != NULL; it = it->next) {
287 Inkscape::XML::Node *node = (Inkscape::XML::Node *)(it->data);
288 SPItem *item = SP_ITEM(mask_object->appendChildRepr(node));
290 if (NULL != applyTransform) {
291 NR::Matrix transform (item->transform);
292 transform *= (*applyTransform);
293 sp_item_write_transform(item, SP_OBJECT_REPR(item), transform);
294 }
295 }
297 if (repr != defsrepr->lastChild())
298 defsrepr->changeOrder(repr, defsrepr->lastChild()); // workaround for bug 989084
300 Inkscape::GC::release(repr);
301 return mask_id;
302 }
304 NRArenaItem *
305 sp_mask_show (SPMask *mask, NRArena *arena, unsigned int key)
306 {
307 g_return_val_if_fail (mask != NULL, NULL);
308 g_return_val_if_fail (SP_IS_MASK (mask), NULL);
309 g_return_val_if_fail (arena != NULL, NULL);
310 g_return_val_if_fail (NR_IS_ARENA (arena), NULL);
312 NRArenaItem *ai = NRArenaGroup::create(arena);
313 mask->display = sp_mask_view_new_prepend (mask->display, key, ai);
315 for (SPObject *child = sp_object_first_child(SP_OBJECT(mask)) ; child != NULL; child = SP_OBJECT_NEXT(child)) {
316 if (SP_IS_ITEM (child)) {
317 NRArenaItem *ac = sp_item_invoke_show (SP_ITEM (child), arena, key, SP_ITEM_REFERENCE_FLAGS);
318 if (ac) {
319 /* The order is not important in mask */
320 nr_arena_item_add_child (ai, ac, NULL);
321 nr_arena_item_unref (ac);
322 }
323 }
324 }
326 if (mask->maskContentUnits == SP_CONTENT_UNITS_OBJECTBOUNDINGBOX) {
327 NR::Matrix t(NR::scale(mask->display->bbox.x1 - mask->display->bbox.x0, mask->display->bbox.y1 - mask->display->bbox.y0));
328 t[4] = mask->display->bbox.x0;
329 t[5] = mask->display->bbox.y0;
330 nr_arena_group_set_child_transform (NR_ARENA_GROUP (ai), &t);
331 }
333 return ai;
334 }
336 void
337 sp_mask_hide (SPMask *cp, unsigned int key)
338 {
339 g_return_if_fail (cp != NULL);
340 g_return_if_fail (SP_IS_MASK (cp));
342 for (SPObject *child = sp_object_first_child(SP_OBJECT(cp)); child != NULL; child = SP_OBJECT_NEXT(child)) {
343 if (SP_IS_ITEM (child)) {
344 sp_item_invoke_hide (SP_ITEM (child), key);
345 }
346 }
348 for (SPMaskView *v = cp->display; v != NULL; v = v->next) {
349 if (v->key == key) {
350 /* We simply unref and let item to manage this in handler */
351 cp->display = sp_mask_view_list_remove (cp->display, v);
352 return;
353 }
354 }
356 g_assert_not_reached ();
357 }
359 void
360 sp_mask_set_bbox (SPMask *mask, unsigned int key, NRRect *bbox)
361 {
362 for (SPMaskView *v = mask->display; v != NULL; v = v->next) {
363 if (v->key == key) {
364 if (!NR_DF_TEST_CLOSE (v->bbox.x0, bbox->x0, NR_EPSILON) ||
365 !NR_DF_TEST_CLOSE (v->bbox.y0, bbox->y0, NR_EPSILON) ||
366 !NR_DF_TEST_CLOSE (v->bbox.x1, bbox->x1, NR_EPSILON) ||
367 !NR_DF_TEST_CLOSE (v->bbox.y1, bbox->y1, NR_EPSILON)) {
368 v->bbox = *bbox;
369 }
370 break;
371 }
372 }
373 }
375 /* Mask views */
377 SPMaskView *
378 sp_mask_view_new_prepend (SPMaskView *list, unsigned int key, NRArenaItem *arenaitem)
379 {
380 SPMaskView *new_mask_view = g_new (SPMaskView, 1);
382 new_mask_view->next = list;
383 new_mask_view->key = key;
384 new_mask_view->arenaitem = nr_arena_item_ref(arenaitem);
385 new_mask_view->bbox.x0 = new_mask_view->bbox.x1 = 0.0;
386 new_mask_view->bbox.y0 = new_mask_view->bbox.y1 = 0.0;
388 return new_mask_view;
389 }
391 SPMaskView *
392 sp_mask_view_list_remove (SPMaskView *list, SPMaskView *view)
393 {
394 if (view == list) {
395 list = list->next;
396 } else {
397 SPMaskView *prev;
398 prev = list;
399 while (prev->next != view) prev = prev->next;
400 prev->next = view->next;
401 }
403 nr_arena_item_unref (view->arenaitem);
404 g_free (view);
406 return list;
407 }
409 /*
410 Local Variables:
411 mode:c++
412 c-file-style:"stroustrup"
413 c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
414 indent-tabs-mode:nil
415 fill-column:99
416 End:
417 */
418 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :