1 #define __SP_FEDISPLACEMENTMAP_CPP__
3 /** \file
4 * SVG <feDisplacementMap> implementation.
5 *
6 */
7 /*
8 * Authors:
9 * hugo Rodrigues <haa.rodrigues@gmail.com>
10 *
11 * Copyright (C) 2006 Hugo Rodrigues
12 *
13 * Released under GNU GPL, read the file 'COPYING' for more information
14 */
16 #ifdef HAVE_CONFIG_H
17 # include "config.h"
18 #endif
20 #include "attributes.h"
21 #include "svg/svg.h"
22 #include "displacementmap.h"
23 #include "xml/repr.h"
24 #include "display/nr-filter-displacement-map.h"
25 #include "helper-fns.h"
27 /* FeDisplacementMap base class */
29 static void sp_feDisplacementMap_class_init(SPFeDisplacementMapClass *klass);
30 static void sp_feDisplacementMap_init(SPFeDisplacementMap *feDisplacementMap);
32 static void sp_feDisplacementMap_build(SPObject *object, SPDocument *document, Inkscape::XML::Node *repr);
33 static void sp_feDisplacementMap_release(SPObject *object);
34 static void sp_feDisplacementMap_set(SPObject *object, unsigned int key, gchar const *value);
35 static void sp_feDisplacementMap_update(SPObject *object, SPCtx *ctx, guint flags);
36 static void sp_feDisplacementMap_build_renderer(SPFilterPrimitive *primitive, Inkscape::Filters::Filter *filter);
37 static Inkscape::XML::Node *sp_feDisplacementMap_write(SPObject *object, Inkscape::XML::Document *doc, Inkscape::XML::Node *repr, guint flags);
39 static SPFilterPrimitiveClass *feDisplacementMap_parent_class;
41 GType
42 sp_feDisplacementMap_get_type()
43 {
44 static GType feDisplacementMap_type = 0;
46 if (!feDisplacementMap_type) {
47 GTypeInfo feDisplacementMap_info = {
48 sizeof(SPFeDisplacementMapClass),
49 NULL, NULL,
50 (GClassInitFunc) sp_feDisplacementMap_class_init,
51 NULL, NULL,
52 sizeof(SPFeDisplacementMap),
53 16,
54 (GInstanceInitFunc) sp_feDisplacementMap_init,
55 NULL, /* value_table */
56 };
57 feDisplacementMap_type = g_type_register_static(SP_TYPE_FILTER_PRIMITIVE, "SPFeDisplacementMap", &feDisplacementMap_info, (GTypeFlags)0);
58 }
59 return feDisplacementMap_type;
60 }
62 static void
63 sp_feDisplacementMap_class_init(SPFeDisplacementMapClass *klass)
64 {
65 SPObjectClass *sp_object_class = (SPObjectClass *)klass;
66 SPFilterPrimitiveClass *sp_primitive_class = (SPFilterPrimitiveClass *)klass;
68 feDisplacementMap_parent_class = (SPFilterPrimitiveClass*)g_type_class_peek_parent(klass);
70 sp_object_class->build = sp_feDisplacementMap_build;
71 sp_object_class->release = sp_feDisplacementMap_release;
72 sp_object_class->write = sp_feDisplacementMap_write;
73 sp_object_class->set = sp_feDisplacementMap_set;
74 sp_object_class->update = sp_feDisplacementMap_update;
75 sp_primitive_class->build_renderer = sp_feDisplacementMap_build_renderer;
76 }
78 static void
79 sp_feDisplacementMap_init(SPFeDisplacementMap *feDisplacementMap)
80 {
81 feDisplacementMap->scale=0;
82 feDisplacementMap->xChannelSelector = DISPLACEMENTMAP_CHANNEL_ALPHA;
83 feDisplacementMap->yChannelSelector = DISPLACEMENTMAP_CHANNEL_ALPHA;
84 feDisplacementMap->in2 = Inkscape::Filters::NR_FILTER_SLOT_NOT_SET;
85 }
87 /**
88 * Reads the Inkscape::XML::Node, and initializes SPFeDisplacementMap variables. For this to get called,
89 * our name must be associated with a repr via "sp_object_type_register". Best done through
90 * sp-object-repr.cpp's repr_name_entries array.
91 */
92 static void
93 sp_feDisplacementMap_build(SPObject *object, SPDocument *document, Inkscape::XML::Node *repr)
94 {
95 if (((SPObjectClass *) feDisplacementMap_parent_class)->build) {
96 ((SPObjectClass *) feDisplacementMap_parent_class)->build(object, document, repr);
97 }
99 /*LOAD ATTRIBUTES FROM REPR HERE*/
100 sp_object_read_attr(object, "scale");
101 sp_object_read_attr(object, "in2");
102 sp_object_read_attr(object, "xChannelSelector");
103 sp_object_read_attr(object, "yChannelSelector");
105 /* Unlike normal in, in2 is required attribute. Make sure, we can call
106 * it by some name. */
107 SPFeDisplacementMap *disp = SP_FEDISPLACEMENTMAP(object);
108 if (disp->in2 == Inkscape::Filters::NR_FILTER_SLOT_NOT_SET ||
109 disp->in2 == Inkscape::Filters::NR_FILTER_UNNAMED_SLOT)
110 {
111 SPFilter *parent = SP_FILTER(object->parent);
112 disp->in2 = sp_filter_primitive_name_previous_out(disp);
113 repr->setAttribute("in2", sp_filter_name_for_image(parent, disp->in2));
114 }
115 }
117 /**
118 * Drops any allocated memory.
119 */
120 static void
121 sp_feDisplacementMap_release(SPObject *object)
122 {
123 if (((SPObjectClass *) feDisplacementMap_parent_class)->release)
124 ((SPObjectClass *) feDisplacementMap_parent_class)->release(object);
125 }
127 static FilterDisplacementMapChannelSelector sp_feDisplacementMap_readChannelSelector(gchar const *value)
128 {
129 if (!value) return DISPLACEMENTMAP_CHANNEL_ALPHA;
130 switch (value[0]) {
131 case 'R':
132 return DISPLACEMENTMAP_CHANNEL_RED;
133 break;
134 case 'G':
135 return DISPLACEMENTMAP_CHANNEL_GREEN;
136 break;
137 case 'B':
138 return DISPLACEMENTMAP_CHANNEL_BLUE;
139 break;
140 case 'A':
141 return DISPLACEMENTMAP_CHANNEL_ALPHA;
142 break;
143 default:
144 // error
145 g_warning("Invalid attribute for Channel Selector. Valid modes are 'R', 'G', 'B' or 'A'");
146 break;
147 }
148 return DISPLACEMENTMAP_CHANNEL_ALPHA; //default is Alpha Channel
149 }
151 /**
152 * Sets a specific value in the SPFeDisplacementMap.
153 */
154 static void
155 sp_feDisplacementMap_set(SPObject *object, unsigned int key, gchar const *value)
156 {
157 SPFeDisplacementMap *feDisplacementMap = SP_FEDISPLACEMENTMAP(object);
158 (void)feDisplacementMap;
159 int input;
160 double read_num;
161 FilterDisplacementMapChannelSelector read_selector;
162 switch(key) {
163 /*DEAL WITH SETTING ATTRIBUTES HERE*/
164 case SP_ATTR_XCHANNELSELECTOR:
165 read_selector = sp_feDisplacementMap_readChannelSelector(value);
166 if (read_selector != feDisplacementMap->xChannelSelector){
167 feDisplacementMap->xChannelSelector = read_selector;
168 object->parent->requestModified(SP_OBJECT_MODIFIED_FLAG);
169 }
170 break;
171 case SP_ATTR_YCHANNELSELECTOR:
172 read_selector = sp_feDisplacementMap_readChannelSelector(value);
173 if (read_selector != feDisplacementMap->yChannelSelector){
174 feDisplacementMap->yChannelSelector = read_selector;
175 object->parent->requestModified(SP_OBJECT_MODIFIED_FLAG);
176 }
177 break;
178 case SP_ATTR_SCALE:
179 read_num = value ? helperfns_read_number(value) : 0;
180 if (read_num != feDisplacementMap->scale) {
181 feDisplacementMap->scale = read_num;
182 object->parent->requestModified(SP_OBJECT_MODIFIED_FLAG);
183 }
184 break;
185 case SP_ATTR_IN2:
186 input = sp_filter_primitive_read_in(feDisplacementMap, value);
187 if (input != feDisplacementMap->in2) {
188 feDisplacementMap->in2 = input;
189 object->parent->requestModified(SP_OBJECT_MODIFIED_FLAG);
190 }
191 break;
192 default:
193 if (((SPObjectClass *) feDisplacementMap_parent_class)->set)
194 ((SPObjectClass *) feDisplacementMap_parent_class)->set(object, key, value);
195 break;
196 }
198 }
200 /**
201 * Receives update notifications.
202 */
203 static void
204 sp_feDisplacementMap_update(SPObject *object, SPCtx *ctx, guint flags)
205 {
206 if (flags & (SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_STYLE_MODIFIED_FLAG |
207 SP_OBJECT_VIEWPORT_MODIFIED_FLAG)) {
209 /* do something to trigger redisplay, updates? */
211 }
213 /* Unlike normal in, in2 is required attribute. Make sure, we can call
214 * it by some name. */
215 SPFeDisplacementMap *disp = SP_FEDISPLACEMENTMAP(object);
216 if (disp->in2 == Inkscape::Filters::NR_FILTER_SLOT_NOT_SET ||
217 disp->in2 == Inkscape::Filters::NR_FILTER_UNNAMED_SLOT)
218 {
219 SPFilter *parent = SP_FILTER(object->parent);
220 disp->in2 = sp_filter_primitive_name_previous_out(disp);
221 object->repr->setAttribute("in2", sp_filter_name_for_image(parent, disp->in2));
222 }
224 if (((SPObjectClass *) feDisplacementMap_parent_class)->update) {
225 ((SPObjectClass *) feDisplacementMap_parent_class)->update(object, ctx, flags);
226 }
227 }
229 static char const * get_channelselector_name(FilterDisplacementMapChannelSelector selector) {
230 switch(selector) {
231 case DISPLACEMENTMAP_CHANNEL_RED:
232 return "R";
233 case DISPLACEMENTMAP_CHANNEL_GREEN:
234 return "G";
235 case DISPLACEMENTMAP_CHANNEL_BLUE:
236 return "B";
237 case DISPLACEMENTMAP_CHANNEL_ALPHA:
238 return "A";
239 default:
240 return 0;
241 }
242 }
244 /**
245 * Writes its settings to an incoming repr object, if any.
246 */
247 static Inkscape::XML::Node *
248 sp_feDisplacementMap_write(SPObject *object, Inkscape::XML::Document *doc, Inkscape::XML::Node *repr, guint flags)
249 {
250 SPFeDisplacementMap *disp = SP_FEDISPLACEMENTMAP(object);
251 SPFilter *parent = SP_FILTER(object->parent);
253 if (!repr) {
254 repr = doc->createElement("svg:feDisplacementMap");
255 }
257 gchar const *out_name = sp_filter_name_for_image(parent, disp->in2);
258 if (out_name) {
259 repr->setAttribute("in2", out_name);
260 } else {
261 SPObject *i = parent->children;
262 while (i && i->next != object) i = i->next;
263 SPFilterPrimitive *i_prim = SP_FILTER_PRIMITIVE(i);
264 out_name = sp_filter_name_for_image(parent, i_prim->image_out);
265 repr->setAttribute("in2", out_name);
266 if (!out_name) {
267 g_warning("Unable to set in2 for feDisplacementMap");
268 }
269 }
271 sp_repr_set_svg_double(repr, "scale", disp->scale);
272 repr->setAttribute("xChannelSelector",
273 get_channelselector_name(disp->xChannelSelector));
274 repr->setAttribute("yChannelSelector",
275 get_channelselector_name(disp->yChannelSelector));
277 if (((SPObjectClass *) feDisplacementMap_parent_class)->write) {
278 ((SPObjectClass *) feDisplacementMap_parent_class)->write(object, doc, repr, flags);
279 }
281 return repr;
282 }
284 static void sp_feDisplacementMap_build_renderer(SPFilterPrimitive *primitive, Inkscape::Filters::Filter *filter) {
285 g_assert(primitive != NULL);
286 g_assert(filter != NULL);
288 SPFeDisplacementMap *sp_displacement_map = SP_FEDISPLACEMENTMAP(primitive);
290 int primitive_n = filter->add_primitive(Inkscape::Filters::NR_FILTER_DISPLACEMENTMAP);
291 Inkscape::Filters::FilterPrimitive *nr_primitive = filter->get_primitive(primitive_n);
292 Inkscape::Filters::FilterDisplacementMap *nr_displacement_map = dynamic_cast<Inkscape::Filters::FilterDisplacementMap*>(nr_primitive);
293 g_assert(nr_displacement_map != NULL);
295 sp_filter_primitive_renderer_common(primitive, nr_primitive);
297 nr_displacement_map->set_input(1, sp_displacement_map->in2);
298 nr_displacement_map->set_scale(sp_displacement_map->scale);
299 nr_displacement_map->set_channel_selector(0, sp_displacement_map->xChannelSelector);
300 nr_displacement_map->set_channel_selector(1, sp_displacement_map->yChannelSelector);
301 }
304 /*
305 Local Variables:
306 mode:c++
307 c-file-style:"stroustrup"
308 c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
309 indent-tabs-mode:nil
310 fill-column:99
311 End:
312 */
313 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :