src/filters/composite.cpp

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