src/sp-filter.cpp

   1 #define __SP_FILTER_CPP__
   2
   3 /** \file
   4  * SVG <filter> implementation.
   5  */
   6 /*
   7  * Authors:
   8  *   Hugo Rodrigues <haa.rodrigues@gmail.com>
   9  *
  10  * Copyright (C) 2006 Hugo Rodrigues
  11  *
  12  * Released under GNU GPL, read the file 'COPYING' for more information
  13  */
  14
  15 #ifdef HAVE_CONFIG_H
  16 # include "config.h"
  17 #endif
  18
  19 #include "attributes.h"
  20 #include "document.h"
  21 #include "sp-filter.h"
  22 #include "sp-filter-reference.h"
  23 #include "uri.h"
  24 #include "xml/repr.h"
  25
  26 #define SP_MACROS_SILENT
  27 #include "macros.h"
  28
  29
  30 /*
  31  * For debugging purposes only
  32  */
  33 void printfilter(SPFilter *filter)
  34 {
  35         if(filter->filterUnits==SP_FILTER_UNITS_USERSPACEONUSE)
  36                 g_print("filterUnits=SP_FILTER_UNITS_USERSPACEONUSE\n");
  37         else if(filter->filterUnits==SP_FILTER_UNITS_OBJECTBOUNDINGBOX)
  38                 g_print("filterUnits=SP_FILTER_UNITS_OBJECTBOUNDINGBOX\n");
  39         else
  40                 g_print("filterUnits=UNKNOWN!!!\n");
  41
  42         if(filter->primitiveUnits==SP_FILTER_UNITS_USERSPACEONUSE)
  43                 g_print("primitiveUnits=SP_FILTER_UNITS_USERSPACEONUSE\n");
  44         else if(filter->primitiveUnits==SP_FILTER_UNITS_OBJECTBOUNDINGBOX)
  45                 g_print("primitiveUnits=SP_FILTER_UNITS_OBJECTBOUNDINGBOX\n");
  46         else
  47                 g_print("primitiveUnits=UNKNOWN!!!\n");
  48
  49 //TODO: print X, Y, W and H units
  50         g_print("x=%lf\n", filter->x.computed);
  51         g_print("y=%lf\n", filter->y.computed);
  52         g_print("width=%lf\n", filter->width.computed);
  53         g_print("height=%lf\n", filter->height.computed);
  54         g_print("filterRes=(%lf %lf)\n", filter->filterRes.getNumber(), filter->filterRes.getOptNumber());
  55
  56 }
  57
  58
  59
  60 /* Filter base class */
  61
  62 static void sp_filter_class_init(SPFilterClass *klass);
  63 static void sp_filter_init(SPFilter *filter);
  64
  65 static void sp_filter_build(SPObject *object, SPDocument *document, Inkscape::XML::Node *repr);
  66 static void sp_filter_release(SPObject *object);
  67 static void sp_filter_set(SPObject *object, unsigned int key, gchar const *value);
  68 static void sp_filter_update(SPObject *object, SPCtx *ctx, guint flags);
  69 static Inkscape::XML::Node *sp_filter_write(SPObject *object, Inkscape::XML::Node *repr, guint flags);
  70
  71 static void filter_ref_changed(SPObject *old_ref, SPObject *ref, SPFilter *filter);
  72 static void filter_ref_modified(SPObject *href, SPFilter *filter);
  73
  74 static SPObjectClass *filter_parent_class;
  75
  76 GType
  77 sp_filter_get_type()
  78 {
  79     static GType filter_type = 0;
  80
  81     if (!filter_type) {
  82         GTypeInfo filter_info = {
  83             sizeof(SPFilterClass),
  84             NULL, NULL,
  85             (GClassInitFunc) sp_filter_class_init,
  86             NULL, NULL,
  87             sizeof(SPFilter),
  88             16,
  89             (GInstanceInitFunc) sp_filter_init,
  90             NULL,    /* value_table */
  91         };
  92         filter_type = g_type_register_static(SP_TYPE_OBJECT, "SPFilter", &filter_info, (GTypeFlags)0);
  93     }
  94     return filter_type;
  95 }
  96
  97 static void
  98 sp_filter_class_init(SPFilterClass *klass)
  99 {
 100
 101     SPObjectClass *sp_object_class = (SPObjectClass *)klass;
 102
 103     filter_parent_class = (SPObjectClass*)g_type_class_peek_parent(klass);
 104
 105     sp_object_class->build = sp_filter_build;
 106     sp_object_class->release = sp_filter_release;
 107     sp_object_class->write = sp_filter_write;
 108     sp_object_class->set = sp_filter_set;
 109     sp_object_class->update = sp_filter_update;
 110 }
 111
 112 static void
 113 sp_filter_init(SPFilter *filter)
 114 {
 115     filter->href = new SPFilterReference(SP_OBJECT(filter));
 116     filter->href->changedSignal().connect(sigc::bind(sigc::ptr_fun(filter_ref_changed), filter));
 117
 118     filter->x = 0;
 119     filter->y = 0;
 120     filter->width = 0;
 121     filter->height = 0;
 122
 123     filter->filterUnits = SP_FILTER_UNITS_OBJECTBOUNDINGBOX;
 124     filter->primitiveUnits = SP_FILTER_UNITS_OBJECTBOUNDINGBOX;
 125     filter->filterUnits_set = FALSE;
 126     filter->primitiveUnits_set = FALSE;
 127
 128 }
 129
 130 /**
 131  * Reads the Inkscape::XML::Node, and initializes SPFilter variables.  For this to get called,
 132  * our name must be associated with a repr via "sp_object_type_register".  Best done through
 133  * sp-object-repr.cpp's repr_name_entries array.
 134  */
 135 static void
 136 sp_filter_build(SPObject *object, SPDocument *document, Inkscape::XML::Node *repr)
 137 {
 138     if (((SPObjectClass *) filter_parent_class)->build) {
 139         ((SPObjectClass *) filter_parent_class)->build(object, document, repr);
 140     }
 141
 142     //Read values of key attributes from XML nodes into object.
 143     sp_object_read_attr(object, "filterUnits");
 144     sp_object_read_attr(object, "primitiveUnits");
 145     sp_object_read_attr(object, "x");
 146     sp_object_read_attr(object, "y");
 147     sp_object_read_attr(object, "width");
 148     sp_object_read_attr(object, "height");
 149     sp_object_read_attr(object, "filterRes");
 150     sp_object_read_attr(object, "xlink:href");
 151
 152 //is this necessary?
 153     sp_document_add_resource(document, "filter", object);
 154 }
 155
 156 /**
 157  * Drops any allocated memory.
 158  */
 159 static void
 160 sp_filter_release(SPObject *object)
 161 {
 162     SPFilter *filter = SP_FILTER(object);
 163
 164     if (SP_OBJECT_DOCUMENT(object)) {
 165         /* Unregister ourselves */
 166         sp_document_remove_resource(SP_OBJECT_DOCUMENT(object), "filter", SP_OBJECT(object));
 167     }
 168
 169 //TODO: release resources here
 170
 171     //release href
 172     if (filter->href) {
 173         if (filter->href->getObject()) {
 174             sp_signal_disconnect_by_data(filter->href->getObject(), filter);
 175         }
 176         filter->href->detach();
 177         delete filter->href;
 178         filter->href = NULL;
 179     }
 180
 181     if (((SPObjectClass *) filter_parent_class)->release)
 182         ((SPObjectClass *) filter_parent_class)->release(object);
 183 }
 184
 185 /**
 186  * Sets a specific value in the SPFilter.
 187  */
 188 static void
 189 sp_filter_set(SPObject *object, unsigned int key, gchar const *value)
 190 {
 191     SPFilter *filter = SP_FILTER(object);
 192
 193     switch (key) {
 194         case SP_ATTR_FILTERUNITS:
 195             if (value) {
 196                 if (!strcmp(value, "userSpaceOnUse")) {
 197                     filter->filterUnits = SP_FILTER_UNITS_USERSPACEONUSE;
 198                 } else {
 199                     filter->filterUnits = SP_FILTER_UNITS_OBJECTBOUNDINGBOX;
 200                 }
 201                 filter->filterUnits_set = TRUE;
 202             } else {
 203                 filter->filterUnits = SP_FILTER_UNITS_OBJECTBOUNDINGBOX;
 204                 filter->filterUnits_set = FALSE;
 205             }
 206             object->requestModified(SP_OBJECT_MODIFIED_FLAG);
 207             break;
 208         case SP_ATTR_PRIMITIVEUNITS:
 209             if (value) {
 210                 if (!strcmp(value, "userSpaceOnUse")) {
 211                     filter->primitiveUnits = SP_FILTER_UNITS_USERSPACEONUSE;
 212                 } else {
 213                     filter->primitiveUnits = SP_FILTER_UNITS_OBJECTBOUNDINGBOX;
 214                 }
 215                 filter->primitiveUnits_set = TRUE;
 216             } else {
 217                 filter->primitiveUnits = SP_FILTER_UNITS_OBJECTBOUNDINGBOX;
 218                 filter->primitiveUnits_set = FALSE;
 219             }
 220             object->requestModified(SP_OBJECT_MODIFIED_FLAG);
 221             break;
 222         case SP_ATTR_X:
 223             filter->x.readOrUnset(value);
 224             object->requestModified(SP_OBJECT_MODIFIED_FLAG);
 225             break;
 226         case SP_ATTR_Y:
 227             filter->y.readOrUnset(value);
 228             object->requestModified(SP_OBJECT_MODIFIED_FLAG);
 229             break;
 230         case SP_ATTR_WIDTH:
 231             filter->width.readOrUnset(value);
 232             object->requestModified(SP_OBJECT_MODIFIED_FLAG);
 233             break;
 234         case SP_ATTR_HEIGHT:
 235             filter->height.readOrUnset(value);
 236             object->requestModified(SP_OBJECT_MODIFIED_FLAG);
 237             break;
 238         case SP_ATTR_FILTERRES:
 239                 filter->filterRes.set(value);
 240             break;
 241         case SP_ATTR_XLINK_HREF:
 242             if (value) {
 243                 try {
 244                     filter->href->attach(Inkscape::URI(value));
 245                 } catch (Inkscape::BadURIException &e) {
 246                     g_warning("%s", e.what());
 247                     filter->href->detach();
 248                 }
 249             } else {
 250                 filter->href->detach();
 251             }
 252             break;
 253         default:
 254             // See if any parents need this value.
 255             if (((SPObjectClass *) filter_parent_class)->set) {
 256                 ((SPObjectClass *) filter_parent_class)->set(object, key, value);
 257             }
 258             break;
 259     }
 260 }
 261
 262 /**
 263  * Receives update notifications.
 264  */
 265 static void
 266 sp_filter_update(SPObject *object, SPCtx *ctx, guint flags)
 267 {
 268     //SPFilter *filter = SP_FILTER(object);
 269
 270     if (flags & (SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_STYLE_MODIFIED_FLAG |
 271                  SP_OBJECT_VIEWPORT_MODIFIED_FLAG)) {
 272
 273         /* do something to trigger redisplay, updates? */
 274
 275     }
 276
 277     if (((SPObjectClass *) filter_parent_class)->update) {
 278         ((SPObjectClass *) filter_parent_class)->update(object, ctx, flags);
 279     }
 280 }
 281
 282 /**
 283  * Writes its settings to an incoming repr object, if any.
 284  */
 285 static Inkscape::XML::Node *
 286 sp_filter_write(SPObject *object, Inkscape::XML::Node *repr, guint flags)
 287 {
 288     SPFilter *filter = SP_FILTER(object);
 289
 290     if (!repr) {
 291         repr = SP_OBJECT_REPR(object)->duplicate();
 292     }
 293
 294     if ((flags & SP_OBJECT_WRITE_ALL) || filter->filterUnits_set) {
 295         switch (filter->filterUnits) {
 296             case SP_FILTER_UNITS_USERSPACEONUSE:
 297                 repr->setAttribute("filterUnits", "userSpaceOnUse");
 298                 break;
 299             default:
 300                 repr->setAttribute("filterUnits", "objectBoundingBox");
 301                 break;
 302         }
 303     }
 304
 305     if ((flags & SP_OBJECT_WRITE_ALL) || filter->primitiveUnits_set) {
 306         switch (filter->primitiveUnits) {
 307             case SP_FILTER_UNITS_USERSPACEONUSE:
 308                 repr->setAttribute("primitiveUnits", "userSpaceOnUse");
 309                 break;
 310             default:
 311                 repr->setAttribute("primitiveUnits", "objectBoundingBox");
 312                 break;
 313         }
 314     }
 315
 316     if (filter->x._set) {
 317         sp_repr_set_svg_double(repr, "x", filter->x.computed);
 318     } else {
 319         repr->setAttribute("x", NULL);
 320     }
 321
 322     if (filter->y._set) {
 323         sp_repr_set_svg_double(repr, "y", filter->y.computed);
 324     } else {
 325         repr->setAttribute("y", NULL);
 326     }
 327
 328     if (filter->width._set) {
 329         sp_repr_set_svg_double(repr, "width", filter->width.computed);
 330     } else {
 331         repr->setAttribute("width", NULL);
 332     }
 333
 334     if (filter->height._set) {
 335         sp_repr_set_svg_double(repr, "height", filter->height.computed);
 336     } else {
 337         repr->setAttribute("height", NULL);
 338     }
 339
 340     if (filter->filterRes._set) {
 341         char filterRes[32];
 342         repr->setAttribute("filterRes", filter->filterRes.getValueString(filterRes));
 343     } else {
 344         repr->setAttribute("filterRes", NULL);
 345     }
 346
 347     if (filter->href->getURI()) {
 348         gchar *uri_string = filter->href->getURI()->toString();
 349         repr->setAttribute("xlink:href", uri_string);
 350         g_free(uri_string);
 351     }
 352
 353     if (((SPObjectClass *) filter_parent_class)->write) {
 354         ((SPObjectClass *) filter_parent_class)->write(object, repr, flags);
 355     }
 356
 357     return repr;
 358 }
 359
 360
 361 /**
 362  * Gets called when the filter is (re)attached to another filter.
 363  */
 364 static void
 365 filter_ref_changed(SPObject *old_ref, SPObject *ref, SPFilter *filter)
 366 {
 367     if (old_ref) {
 368         sp_signal_disconnect_by_data(old_ref, filter);
 369     }
 370     if ( SP_IS_FILTER(ref)
 371          && ref != filter )
 372     {
 373         g_signal_connect(G_OBJECT(ref), "modified", G_CALLBACK(filter_ref_modified), filter);
 374     }
 375
 376     filter_ref_modified(ref, filter);
 377 }
 378
 379 static void
 380 filter_ref_modified(SPObject *href, SPFilter *filter)
 381 {
 382     SP_OBJECT(filter)->requestModified(SP_OBJECT_MODIFIED_FLAG);
 383 }
 384
 385
 386 /*
 387   Local Variables:
 388   mode:c++
 389   c-file-style:"stroustrup"
 390   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 391   indent-tabs-mode:nil
 392   fill-column:99
 393   End:
 394 */
 395 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :