1 /** \file
2 * SVG <feTurbulence> implementation.
3 *
4 */
5 /*
6 * Authors:
7 * Felipe CorrĂȘa da Silva Sanches <juca@members.fsf.org>
8 * hugo Rodrigues <haa.rodrigues@gmail.com>
9 * Abhishek Sharma
10 *
11 * Copyright (C) 2007 Felipe Sanches
12 * Copyright (C) 2006 Hugo Rodrigues
13 *
14 * Released under GNU GPL, read the file 'COPYING' for more information
15 */
17 #ifdef HAVE_CONFIG_H
18 # include "config.h"
19 #endif
21 #include "attributes.h"
22 #include "svg/svg.h"
23 #include "turbulence.h"
24 #include "helper-fns.h"
25 #include "xml/repr.h"
26 #include <string.h>
28 #include "display/nr-filter.h"
29 #include "display/nr-filter-turbulence.h"
31 /* FeTurbulence base class */
33 static void sp_feTurbulence_class_init(SPFeTurbulenceClass *klass);
34 static void sp_feTurbulence_init(SPFeTurbulence *feTurbulence);
36 static void sp_feTurbulence_build(SPObject *object, SPDocument *document, Inkscape::XML::Node *repr);
37 static void sp_feTurbulence_release(SPObject *object);
38 static void sp_feTurbulence_set(SPObject *object, unsigned int key, gchar const *value);
39 static void sp_feTurbulence_update(SPObject *object, SPCtx *ctx, guint flags);
40 static Inkscape::XML::Node *sp_feTurbulence_write(SPObject *object, Inkscape::XML::Document *doc, Inkscape::XML::Node *repr, guint flags);
41 static void sp_feTurbulence_build_renderer(SPFilterPrimitive *primitive, Inkscape::Filters::Filter *filter);
43 static SPFilterPrimitiveClass *feTurbulence_parent_class;
45 GType
46 sp_feTurbulence_get_type()
47 {
48 static GType feTurbulence_type = 0;
50 if (!feTurbulence_type) {
51 GTypeInfo feTurbulence_info = {
52 sizeof(SPFeTurbulenceClass),
53 NULL, NULL,
54 (GClassInitFunc) sp_feTurbulence_class_init,
55 NULL, NULL,
56 sizeof(SPFeTurbulence),
57 16,
58 (GInstanceInitFunc) sp_feTurbulence_init,
59 NULL, /* value_table */
60 };
61 feTurbulence_type = g_type_register_static(SP_TYPE_FILTER_PRIMITIVE, "SPFeTurbulence", &feTurbulence_info, (GTypeFlags)0);
62 }
63 return feTurbulence_type;
64 }
66 static void
67 sp_feTurbulence_class_init(SPFeTurbulenceClass *klass)
68 {
69 SPObjectClass *sp_object_class = (SPObjectClass *)klass;
70 SPFilterPrimitiveClass * sp_primitive_class = (SPFilterPrimitiveClass *)klass;
72 feTurbulence_parent_class = (SPFilterPrimitiveClass*)g_type_class_peek_parent(klass);
74 sp_object_class->build = sp_feTurbulence_build;
75 sp_object_class->release = sp_feTurbulence_release;
76 sp_object_class->write = sp_feTurbulence_write;
77 sp_object_class->set = sp_feTurbulence_set;
78 sp_object_class->update = sp_feTurbulence_update;
80 sp_primitive_class->build_renderer = sp_feTurbulence_build_renderer;
81 }
83 static void
84 sp_feTurbulence_init(SPFeTurbulence *feTurbulence)
85 {
86 feTurbulence->updated=false;
87 }
89 /**
90 * Reads the Inkscape::XML::Node, and initializes SPFeTurbulence variables. For this to get called,
91 * our name must be associated with a repr via "sp_object_type_register". Best done through
92 * sp-object-repr.cpp's repr_name_entries array.
93 */
94 static void
95 sp_feTurbulence_build(SPObject *object, SPDocument *document, Inkscape::XML::Node *repr)
96 {
97 if (((SPObjectClass *) feTurbulence_parent_class)->build) {
98 ((SPObjectClass *) feTurbulence_parent_class)->build(object, document, repr);
99 }
101 /*LOAD ATTRIBUTES FROM REPR HERE*/
102 object->readAttr( "baseFrequency" );
103 object->readAttr( "numOctaves" );
104 object->readAttr( "seed" );
105 object->readAttr( "stitchTiles" );
106 object->readAttr( "type" );
107 }
109 /**
110 * Drops any allocated memory.
111 */
112 static void
113 sp_feTurbulence_release(SPObject *object)
114 {
115 if (((SPObjectClass *) feTurbulence_parent_class)->release)
116 ((SPObjectClass *) feTurbulence_parent_class)->release(object);
117 }
119 static bool sp_feTurbulence_read_stitchTiles(gchar const *value){
120 if (!value) return false; // 'noStitch' is default
121 switch(value[0]){
122 case 's':
123 if (strncmp(value, "stitch", 6) == 0) return true;
124 break;
125 case 'n':
126 if (strncmp(value, "noStitch", 8) == 0) return false;
127 break;
128 }
129 return false; // 'noStitch' is default
130 }
132 static Inkscape::Filters::FilterTurbulenceType sp_feTurbulence_read_type(gchar const *value){
133 if (!value) return Inkscape::Filters::TURBULENCE_TURBULENCE; // 'turbulence' is default
134 switch(value[0]){
135 case 'f':
136 if (strncmp(value, "fractalNoise", 12) == 0) return Inkscape::Filters::TURBULENCE_FRACTALNOISE;
137 break;
138 case 't':
139 if (strncmp(value, "turbulence", 10) == 0) return Inkscape::Filters::TURBULENCE_TURBULENCE;
140 break;
141 }
142 return Inkscape::Filters::TURBULENCE_TURBULENCE; // 'turbulence' is default
143 }
145 /**
146 * Sets a specific value in the SPFeTurbulence.
147 */
148 static void
149 sp_feTurbulence_set(SPObject *object, unsigned int key, gchar const *value)
150 {
151 SPFeTurbulence *feTurbulence = SP_FETURBULENCE(object);
152 (void)feTurbulence;
154 int read_int;
155 double read_num;
156 bool read_bool;
157 Inkscape::Filters::FilterTurbulenceType read_type;
159 switch(key) {
160 /*DEAL WITH SETTING ATTRIBUTES HERE*/
162 case SP_ATTR_BASEFREQUENCY:
163 feTurbulence->baseFrequency.set(value);
164 //From SVG spec: If two <number>s are provided, the first number represents a base frequency in the X direction and the second value represents a base frequency in the Y direction. If one number is provided, then that value is used for both X and Y.
165 if (feTurbulence->baseFrequency.optNumIsSet() == false)
166 feTurbulence->baseFrequency.setOptNumber(feTurbulence->baseFrequency.getNumber());
167 feTurbulence->updated = false;
168 object->parent->requestModified(SP_OBJECT_MODIFIED_FLAG);
169 break;
170 case SP_ATTR_NUMOCTAVES:
171 read_int = value ? (int)floor(helperfns_read_number(value)) : 1;
172 if (read_int != feTurbulence->numOctaves){
173 feTurbulence->numOctaves = read_int;
174 feTurbulence->updated = false;
175 object->parent->requestModified(SP_OBJECT_MODIFIED_FLAG);
176 }
177 break;
178 case SP_ATTR_SEED:
179 read_num = value ? helperfns_read_number(value) : 0;
180 if (read_num != feTurbulence->seed){
181 feTurbulence->seed = read_num;
182 feTurbulence->updated = false;
183 object->parent->requestModified(SP_OBJECT_MODIFIED_FLAG);
184 }
185 break;
186 case SP_ATTR_STITCHTILES:
187 read_bool = sp_feTurbulence_read_stitchTiles(value);
188 if (read_bool != feTurbulence->stitchTiles){
189 feTurbulence->stitchTiles = read_bool;
190 feTurbulence->updated = false;
191 object->parent->requestModified(SP_OBJECT_MODIFIED_FLAG);
192 }
193 break;
194 case SP_ATTR_TYPE:
195 read_type = sp_feTurbulence_read_type(value);
196 if (read_type != feTurbulence->type){
197 feTurbulence->type = read_type;
198 feTurbulence->updated = false;
199 object->parent->requestModified(SP_OBJECT_MODIFIED_FLAG);
200 }
201 break;
202 default:
203 if (((SPObjectClass *) feTurbulence_parent_class)->set)
204 ((SPObjectClass *) feTurbulence_parent_class)->set(object, key, value);
205 break;
206 }
208 }
210 /**
211 * Receives update notifications.
212 */
213 static void
214 sp_feTurbulence_update(SPObject *object, SPCtx *ctx, guint flags)
215 {
216 if (flags & (SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_STYLE_MODIFIED_FLAG |
217 SP_OBJECT_VIEWPORT_MODIFIED_FLAG)) {
219 /* do something to trigger redisplay, updates? */
221 }
223 if (((SPObjectClass *) feTurbulence_parent_class)->update) {
224 ((SPObjectClass *) feTurbulence_parent_class)->update(object, ctx, flags);
225 }
226 }
228 /**
229 * Writes its settings to an incoming repr object, if any.
230 */
231 static Inkscape::XML::Node *
232 sp_feTurbulence_write(SPObject *object, Inkscape::XML::Document *doc, Inkscape::XML::Node *repr, guint flags)
233 {
234 /* TODO: Don't just clone, but create a new repr node and write all
235 * relevant values into it */
236 if (!repr) {
237 repr = SP_OBJECT_REPR(object)->duplicate(doc);
238 }
240 if (((SPObjectClass *) feTurbulence_parent_class)->write) {
241 ((SPObjectClass *) feTurbulence_parent_class)->write(object, doc, repr, flags);
242 }
244 /* turbulence doesn't take input */
245 repr->setAttribute("in", 0);
247 return repr;
248 }
250 static void sp_feTurbulence_build_renderer(SPFilterPrimitive *primitive, Inkscape::Filters::Filter *filter) {
251 g_assert(primitive != NULL);
252 g_assert(filter != NULL);
254 SPFeTurbulence *sp_turbulence = SP_FETURBULENCE(primitive);
256 int primitive_n = filter->add_primitive(Inkscape::Filters::NR_FILTER_TURBULENCE);
257 Inkscape::Filters::FilterPrimitive *nr_primitive = filter->get_primitive(primitive_n);
258 Inkscape::Filters::FilterTurbulence *nr_turbulence = dynamic_cast<Inkscape::Filters::FilterTurbulence*>(nr_primitive);
259 g_assert(nr_turbulence != NULL);
261 sp_filter_primitive_renderer_common(primitive, nr_primitive);
263 nr_turbulence->set_baseFrequency(0, sp_turbulence->baseFrequency.getNumber());
264 nr_turbulence->set_baseFrequency(1, sp_turbulence->baseFrequency.getOptNumber());
265 nr_turbulence->set_numOctaves(sp_turbulence->numOctaves);
266 nr_turbulence->set_seed(sp_turbulence->seed);
267 nr_turbulence->set_stitchTiles(sp_turbulence->stitchTiles);
268 nr_turbulence->set_type(sp_turbulence->type);
269 nr_turbulence->set_updated(sp_turbulence->updated);
270 }
272 /*
273 Local Variables:
274 mode:c++
275 c-file-style:"stroustrup"
276 c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
277 indent-tabs-mode:nil
278 fill-column:99
279 End:
280 */
281 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:fileencoding=utf-8:textwidth=99 :