src/filters/turbulence.cpp

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