src/filters/composite.cpp

   1 /** \file
   2  * SVG <feComposite> implementation.
   3  *
   4  */
   5 /*
   6  * Authors:
   7  *   hugo Rodrigues <haa.rodrigues@gmail.com>
   8  *   Abhishek Sharma
   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 "svg/svg.h"
  21 #include "composite.h"
  22 #include "helper-fns.h"
  23 #include "xml/repr.h"
  24 #include "display/nr-filter-composite.h"
  25
  26 /* FeComposite base class */
  27
  28 static void sp_feComposite_class_init(SPFeCompositeClass *klass);
  29 static void sp_feComposite_init(SPFeComposite *feComposite);
  30
  31 static void sp_feComposite_build(SPObject *object, SPDocument *document, Inkscape::XML::Node *repr);
  32 static void sp_feComposite_release(SPObject *object);
  33 static void sp_feComposite_set(SPObject *object, unsigned int key, gchar const *value);
  34 static void sp_feComposite_update(SPObject *object, SPCtx *ctx, guint flags);
  35 static Inkscape::XML::Node *sp_feComposite_write(SPObject *object, Inkscape::XML::Document *doc, Inkscape::XML::Node *repr, guint flags);
  36 static void sp_feComposite_build_renderer(SPFilterPrimitive *primitive, Inkscape::Filters::Filter *filter);
  37
  38 static SPFilterPrimitiveClass *feComposite_parent_class;
  39
  40 GType
  41 sp_feComposite_get_type()
  42 {
  43     static GType feComposite_type = 0;
  44
  45     if (!feComposite_type) {
  46         GTypeInfo feComposite_info = {
  47             sizeof(SPFeCompositeClass),
  48             NULL, NULL,
  49             (GClassInitFunc) sp_feComposite_class_init,
  50             NULL, NULL,
  51             sizeof(SPFeComposite),
  52             16,
  53             (GInstanceInitFunc) sp_feComposite_init,
  54             NULL,    /* value_table */
  55         };
  56         feComposite_type = g_type_register_static(SP_TYPE_FILTER_PRIMITIVE, "SPFeComposite", &feComposite_info, (GTypeFlags)0);
  57     }
  58     return feComposite_type;
  59 }
  60
  61 static void
  62 sp_feComposite_class_init(SPFeCompositeClass *klass)
  63 {
  64     SPObjectClass *sp_object_class = (SPObjectClass *)klass;
  65     SPFilterPrimitiveClass *sp_primitive_class = (SPFilterPrimitiveClass *)klass;
  66
  67     feComposite_parent_class = (SPFilterPrimitiveClass*)g_type_class_peek_parent(klass);
  68
  69     sp_object_class->build = sp_feComposite_build;
  70     sp_object_class->release = sp_feComposite_release;
  71     sp_object_class->write = sp_feComposite_write;
  72     sp_object_class->set = sp_feComposite_set;
  73     sp_object_class->update = sp_feComposite_update;
  74
  75     sp_primitive_class->build_renderer = sp_feComposite_build_renderer;
  76 }
  77
  78 static void
  79 sp_feComposite_init(SPFeComposite *feComposite)
  80 {
  81     feComposite->composite_operator = COMPOSITE_DEFAULT;
  82     feComposite->k1 = 0;
  83     feComposite->k2 = 0;
  84     feComposite->k3 = 0;
  85     feComposite->k4 = 0;
  86     feComposite->in2 = Inkscape::Filters::NR_FILTER_SLOT_NOT_SET;
  87 }
  88
  89 /**
  90  * Reads the Inkscape::XML::Node, and initializes SPFeComposite 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_feComposite_build(SPObject *object, SPDocument *document, Inkscape::XML::Node *repr)
  96 {
  97     if (((SPObjectClass *) feComposite_parent_class)->build) {
  98         ((SPObjectClass *) feComposite_parent_class)->build(object, document, repr);
  99     }
 100
 101     SPFeComposite *comp = SP_FECOMPOSITE(object);
 102
 103     object->readAttr( "operator" );
 104     if (comp->composite_operator == COMPOSITE_ARITHMETIC) {
 105         object->readAttr( "k1" );
 106         object->readAttr( "k2" );
 107         object->readAttr( "k3" );
 108         object->readAttr( "k4" );
 109     }
 110     object->readAttr( "in2" );
 111
 112     /* Unlike normal in, in2 is required attribute. Make sure, we can call
 113      * it by some name. */
 114     if (comp->in2 == Inkscape::Filters::NR_FILTER_SLOT_NOT_SET ||
 115         comp->in2 == Inkscape::Filters::NR_FILTER_UNNAMED_SLOT)
 116     {
 117         SPFilter *parent = SP_FILTER(object->parent);
 118         comp->in2 = sp_filter_primitive_name_previous_out(comp);
 119         repr->setAttribute("in2", sp_filter_name_for_image(parent, comp->in2));
 120     }
 121 }
 122
 123 /**
 124  * Drops any allocated memory.
 125  */
 126 static void
 127 sp_feComposite_release(SPObject *object)
 128 {
 129     if (((SPObjectClass *) feComposite_parent_class)->release)
 130         ((SPObjectClass *) feComposite_parent_class)->release(object);
 131 }
 132
 133 static FeCompositeOperator
 134 sp_feComposite_read_operator(gchar const *value) {
 135     if (!value) return COMPOSITE_DEFAULT;
 136
 137     if (strcmp(value, "over") == 0) return COMPOSITE_OVER;
 138     else if (strcmp(value, "in") == 0) return COMPOSITE_IN;
 139     else if (strcmp(value, "out") == 0) return COMPOSITE_OUT;
 140     else if (strcmp(value, "atop") == 0) return COMPOSITE_ATOP;
 141     else if (strcmp(value, "xor") == 0) return COMPOSITE_XOR;
 142     else if (strcmp(value, "arithmetic") == 0) return COMPOSITE_ARITHMETIC;
 143     return COMPOSITE_DEFAULT;
 144 }
 145
 146 /**
 147  * Sets a specific value in the SPFeComposite.
 148  */
 149 static void
 150 sp_feComposite_set(SPObject *object, unsigned int key, gchar const *value)
 151 {
 152     SPFeComposite *feComposite = SP_FECOMPOSITE(object);
 153     (void)feComposite;
 154
 155     int input;
 156     FeCompositeOperator op;
 157     double k_n;
 158     switch(key) {
 159         /*DEAL WITH SETTING ATTRIBUTES HERE*/
 160         case SP_ATTR_OPERATOR:
 161             op = sp_feComposite_read_operator(value);
 162             if (op != feComposite->composite_operator) {
 163                 feComposite->composite_operator = op;
 164                 object->parent->requestModified(SP_OBJECT_MODIFIED_FLAG);
 165             }
 166             break;
 167
 168         case SP_ATTR_K1:
 169             k_n = value ? helperfns_read_number(value) : 0;
 170             if (k_n != feComposite->k1) {
 171                 feComposite->k1 = k_n;
 172                 if (feComposite->composite_operator == COMPOSITE_ARITHMETIC)
 173                     object->parent->requestModified(SP_OBJECT_MODIFIED_FLAG);
 174             }
 175             break;
 176
 177         case SP_ATTR_K2:
 178             k_n = value ? helperfns_read_number(value) : 0;
 179             if (k_n != feComposite->k2) {
 180                 feComposite->k2 = k_n;
 181                 if (feComposite->composite_operator == COMPOSITE_ARITHMETIC)
 182                     object->parent->requestModified(SP_OBJECT_MODIFIED_FLAG);
 183             }
 184             break;
 185
 186         case SP_ATTR_K3:
 187             k_n = value ? helperfns_read_number(value) : 0;
 188             if (k_n != feComposite->k3) {
 189                 feComposite->k3 = k_n;
 190                 if (feComposite->composite_operator == COMPOSITE_ARITHMETIC)
 191                     object->parent->requestModified(SP_OBJECT_MODIFIED_FLAG);
 192             }
 193             break;
 194
 195         case SP_ATTR_K4:
 196             k_n = value ? helperfns_read_number(value) : 0;
 197             if (k_n != feComposite->k4) {
 198                 feComposite->k4 = k_n;
 199                 if (feComposite->composite_operator == COMPOSITE_ARITHMETIC)
 200                     object->parent->requestModified(SP_OBJECT_MODIFIED_FLAG);
 201             }
 202             break;
 203
 204         case SP_ATTR_IN2:
 205             input = sp_filter_primitive_read_in(feComposite, value);
 206             if (input != feComposite->in2) {
 207                 feComposite->in2 = input;
 208                 object->parent->requestModified(SP_OBJECT_MODIFIED_FLAG);
 209             }
 210             break;
 211
 212         default:
 213             if (((SPObjectClass *) feComposite_parent_class)->set)
 214                 ((SPObjectClass *) feComposite_parent_class)->set(object, key, value);
 215             break;
 216     }
 217
 218 }
 219
 220 /**
 221  * Receives update notifications.
 222  */
 223 static void
 224 sp_feComposite_update(SPObject *object, SPCtx *ctx, guint flags)
 225 {
 226     SPFeComposite *comp = SP_FECOMPOSITE(object);
 227
 228     if (flags & (SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_STYLE_MODIFIED_FLAG |
 229                  SP_OBJECT_VIEWPORT_MODIFIED_FLAG)) {
 230
 231         /* do something to trigger redisplay, updates? */
 232
 233     }
 234
 235     /* Unlike normal in, in2 is required attribute. Make sure, we can call
 236      * it by some name. */
 237     if (comp->in2 == Inkscape::Filters::NR_FILTER_SLOT_NOT_SET ||
 238         comp->in2 == Inkscape::Filters::NR_FILTER_UNNAMED_SLOT)
 239     {
 240         SPFilter *parent = SP_FILTER(object->parent);
 241         comp->in2 = sp_filter_primitive_name_previous_out(comp);
 242
 243                 //XML Tree being used directly here while it shouldn't be.
 244         object->getRepr()->setAttribute("in2", sp_filter_name_for_image(parent, comp->in2));
 245     }
 246
 247     if (((SPObjectClass *) feComposite_parent_class)->update) {
 248         ((SPObjectClass *) feComposite_parent_class)->update(object, ctx, flags);
 249     }
 250 }
 251
 252 /**
 253  * Writes its settings to an incoming repr object, if any.
 254  */
 255 static Inkscape::XML::Node *
 256 sp_feComposite_write(SPObject *object, Inkscape::XML::Document *doc, Inkscape::XML::Node *repr, guint flags)
 257 {
 258     SPFeComposite *comp = SP_FECOMPOSITE(object);
 259     SPFilter *parent = SP_FILTER(object->parent);
 260
 261     if (!repr) {
 262         repr = doc->createElement("svg:feComposite");
 263     }
 264
 265     gchar const *out_name = sp_filter_name_for_image(parent, comp->in2);
 266     if (out_name) {
 267         repr->setAttribute("in2", out_name);
 268     } else {
 269         SPObject *i = parent->children;
 270         while (i && i->next != object) i = i->next;
 271         SPFilterPrimitive *i_prim = SP_FILTER_PRIMITIVE(i);
 272         out_name = sp_filter_name_for_image(parent, i_prim->image_out);
 273         repr->setAttribute("in2", out_name);
 274         if (!out_name) {
 275             g_warning("Unable to set in2 for feComposite");
 276         }
 277     }
 278
 279     char const *comp_op;
 280     switch (comp->composite_operator) {
 281         case COMPOSITE_OVER:
 282             comp_op = "over"; break;
 283         case COMPOSITE_IN:
 284             comp_op = "in"; break;
 285         case COMPOSITE_OUT:
 286             comp_op = "out"; break;
 287         case COMPOSITE_ATOP:
 288             comp_op = "atop"; break;
 289         case COMPOSITE_XOR:
 290             comp_op = "xor"; break;
 291         case COMPOSITE_ARITHMETIC:
 292             comp_op = "arithmetic"; break;
 293         default:
 294             comp_op = 0;
 295     }
 296     repr->setAttribute("operator", comp_op);
 297
 298     if (comp->composite_operator == COMPOSITE_ARITHMETIC) {
 299         sp_repr_set_svg_double(repr, "k1", comp->k1);
 300         sp_repr_set_svg_double(repr, "k2", comp->k2);
 301         sp_repr_set_svg_double(repr, "k3", comp->k3);
 302         sp_repr_set_svg_double(repr, "k4", comp->k4);
 303     } else {
 304         repr->setAttribute("k1", 0);
 305         repr->setAttribute("k2", 0);
 306         repr->setAttribute("k3", 0);
 307         repr->setAttribute("k4", 0);
 308     }
 309
 310     if (((SPObjectClass *) feComposite_parent_class)->write) {
 311         ((SPObjectClass *) feComposite_parent_class)->write(object, doc, repr, flags);
 312     }
 313
 314     return repr;
 315 }
 316
 317 static void sp_feComposite_build_renderer(SPFilterPrimitive *primitive, Inkscape::Filters::Filter *filter) {
 318     g_assert(primitive != NULL);
 319     g_assert(filter != NULL);
 320
 321     SPFeComposite *sp_composite = SP_FECOMPOSITE(primitive);
 322
 323     int primitive_n = filter->add_primitive(Inkscape::Filters::NR_FILTER_COMPOSITE);
 324     Inkscape::Filters::FilterPrimitive *nr_primitive = filter->get_primitive(primitive_n);
 325     Inkscape::Filters::FilterComposite *nr_composite = dynamic_cast<Inkscape::Filters::FilterComposite*>(nr_primitive);
 326     g_assert(nr_composite != NULL);
 327
 328     sp_filter_primitive_renderer_common(primitive, nr_primitive);
 329
 330     nr_composite->set_operator(sp_composite->composite_operator);
 331     nr_composite->set_input(1, sp_composite->in2);
 332     if (sp_composite->composite_operator == COMPOSITE_ARITHMETIC) {
 333         nr_composite->set_arithmetic(sp_composite->k1, sp_composite->k2,
 334                                      sp_composite->k3, sp_composite->k4);
 335     }
 336 }
 337
 338
 339 /*
 340   Local Variables:
 341   mode:c++
 342   c-file-style:"stroustrup"
 343   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 344   indent-tabs-mode:nil
 345   fill-column:99
 346   End:
 347 */
 348 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:fileencoding=utf-8:textwidth=99 :