src/filters/displacementmap.cpp

   1 /** \file
   2  * SVG <feDisplacementMap> 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 "displacementmap.h"
  22 #include "xml/repr.h"
  23 #include "display/nr-filter-displacement-map.h"
  24 #include "helper-fns.h"
  25
  26 /* FeDisplacementMap base class */
  27
  28 static void sp_feDisplacementMap_class_init(SPFeDisplacementMapClass *klass);
  29 static void sp_feDisplacementMap_init(SPFeDisplacementMap *feDisplacementMap);
  30
  31 static void sp_feDisplacementMap_build(SPObject *object, SPDocument *document, Inkscape::XML::Node *repr);
  32 static void sp_feDisplacementMap_release(SPObject *object);
  33 static void sp_feDisplacementMap_set(SPObject *object, unsigned int key, gchar const *value);
  34 static void sp_feDisplacementMap_update(SPObject *object, SPCtx *ctx, guint flags);
  35 static void sp_feDisplacementMap_build_renderer(SPFilterPrimitive *primitive, Inkscape::Filters::Filter *filter);
  36 static Inkscape::XML::Node *sp_feDisplacementMap_write(SPObject *object, Inkscape::XML::Document *doc, Inkscape::XML::Node *repr, guint flags);
  37
  38 static SPFilterPrimitiveClass *feDisplacementMap_parent_class;
  39
  40 GType
  41 sp_feDisplacementMap_get_type()
  42 {
  43     static GType feDisplacementMap_type = 0;
  44
  45     if (!feDisplacementMap_type) {
  46         GTypeInfo feDisplacementMap_info = {
  47             sizeof(SPFeDisplacementMapClass),
  48             NULL, NULL,
  49             (GClassInitFunc) sp_feDisplacementMap_class_init,
  50             NULL, NULL,
  51             sizeof(SPFeDisplacementMap),
  52             16,
  53             (GInstanceInitFunc) sp_feDisplacementMap_init,
  54             NULL,    /* value_table */
  55         };
  56         feDisplacementMap_type = g_type_register_static(SP_TYPE_FILTER_PRIMITIVE, "SPFeDisplacementMap", &feDisplacementMap_info, (GTypeFlags)0);
  57     }
  58     return feDisplacementMap_type;
  59 }
  60
  61 static void
  62 sp_feDisplacementMap_class_init(SPFeDisplacementMapClass *klass)
  63 {
  64     SPObjectClass *sp_object_class = (SPObjectClass *)klass;
  65     SPFilterPrimitiveClass *sp_primitive_class = (SPFilterPrimitiveClass *)klass;
  66
  67     feDisplacementMap_parent_class = (SPFilterPrimitiveClass*)g_type_class_peek_parent(klass);
  68
  69     sp_object_class->build = sp_feDisplacementMap_build;
  70     sp_object_class->release = sp_feDisplacementMap_release;
  71     sp_object_class->write = sp_feDisplacementMap_write;
  72     sp_object_class->set = sp_feDisplacementMap_set;
  73     sp_object_class->update = sp_feDisplacementMap_update;
  74     sp_primitive_class->build_renderer = sp_feDisplacementMap_build_renderer;
  75 }
  76
  77 static void
  78 sp_feDisplacementMap_init(SPFeDisplacementMap *feDisplacementMap)
  79 {
  80     feDisplacementMap->scale=0;
  81     feDisplacementMap->xChannelSelector = DISPLACEMENTMAP_CHANNEL_ALPHA;
  82     feDisplacementMap->yChannelSelector = DISPLACEMENTMAP_CHANNEL_ALPHA;
  83     feDisplacementMap->in2 = Inkscape::Filters::NR_FILTER_SLOT_NOT_SET;
  84 }
  85
  86 /**
  87  * Reads the Inkscape::XML::Node, and initializes SPFeDisplacementMap variables.  For this to get called,
  88  * our name must be associated with a repr via "sp_object_type_register".  Best done through
  89  * sp-object-repr.cpp's repr_name_entries array.
  90  */
  91 static void
  92 sp_feDisplacementMap_build(SPObject *object, SPDocument *document, Inkscape::XML::Node *repr)
  93 {
  94     if (((SPObjectClass *) feDisplacementMap_parent_class)->build) {
  95         ((SPObjectClass *) feDisplacementMap_parent_class)->build(object, document, repr);
  96     }
  97
  98     /*LOAD ATTRIBUTES FROM REPR HERE*/
  99     object->readAttr( "scale" );
 100     object->readAttr( "in2" );
 101     object->readAttr( "xChannelSelector" );
 102     object->readAttr( "yChannelSelector" );
 103
 104     /* Unlike normal in, in2 is required attribute. Make sure, we can call
 105      * it by some name. */
 106     SPFeDisplacementMap *disp = SP_FEDISPLACEMENTMAP(object);
 107     if (disp->in2 == Inkscape::Filters::NR_FILTER_SLOT_NOT_SET ||
 108         disp->in2 == Inkscape::Filters::NR_FILTER_UNNAMED_SLOT)
 109     {
 110         SPFilter *parent = SP_FILTER(object->parent);
 111         disp->in2 = sp_filter_primitive_name_previous_out(disp);
 112         repr->setAttribute("in2", sp_filter_name_for_image(parent, disp->in2));
 113     }
 114 }
 115
 116 /**
 117  * Drops any allocated memory.
 118  */
 119 static void
 120 sp_feDisplacementMap_release(SPObject *object)
 121 {
 122     if (((SPObjectClass *) feDisplacementMap_parent_class)->release)
 123         ((SPObjectClass *) feDisplacementMap_parent_class)->release(object);
 124 }
 125
 126 static FilterDisplacementMapChannelSelector sp_feDisplacementMap_readChannelSelector(gchar const *value)
 127 {
 128     if (!value) return DISPLACEMENTMAP_CHANNEL_ALPHA;
 129     switch (value[0]) {
 130         case 'R':
 131             return DISPLACEMENTMAP_CHANNEL_RED;
 132             break;
 133         case 'G':
 134             return DISPLACEMENTMAP_CHANNEL_GREEN;
 135             break;
 136         case 'B':
 137             return DISPLACEMENTMAP_CHANNEL_BLUE;
 138             break;
 139         case 'A':
 140             return DISPLACEMENTMAP_CHANNEL_ALPHA;
 141             break;
 142         default:
 143             // error
 144             g_warning("Invalid attribute for Channel Selector. Valid modes are 'R', 'G', 'B' or 'A'");
 145             break;
 146     }
 147     return DISPLACEMENTMAP_CHANNEL_ALPHA; //default is Alpha Channel
 148 }
 149
 150 /**
 151  * Sets a specific value in the SPFeDisplacementMap.
 152  */
 153 static void
 154 sp_feDisplacementMap_set(SPObject *object, unsigned int key, gchar const *value)
 155 {
 156     SPFeDisplacementMap *feDisplacementMap = SP_FEDISPLACEMENTMAP(object);
 157     (void)feDisplacementMap;
 158     int input;
 159     double read_num;
 160     FilterDisplacementMapChannelSelector read_selector;
 161     switch(key) {
 162         /*DEAL WITH SETTING ATTRIBUTES HERE*/
 163         case SP_ATTR_XCHANNELSELECTOR:
 164             read_selector = sp_feDisplacementMap_readChannelSelector(value);
 165             if (read_selector != feDisplacementMap->xChannelSelector){
 166                 feDisplacementMap->xChannelSelector = read_selector;
 167                 object->parent->requestModified(SP_OBJECT_MODIFIED_FLAG);
 168             }
 169             break;
 170         case SP_ATTR_YCHANNELSELECTOR:
 171             read_selector = sp_feDisplacementMap_readChannelSelector(value);
 172             if (read_selector != feDisplacementMap->yChannelSelector){
 173                 feDisplacementMap->yChannelSelector = read_selector;
 174                 object->parent->requestModified(SP_OBJECT_MODIFIED_FLAG);
 175             }
 176             break;
 177         case SP_ATTR_SCALE:
 178             read_num = value ? helperfns_read_number(value) : 0;
 179             if (read_num != feDisplacementMap->scale) {
 180                 feDisplacementMap->scale = read_num;
 181                 object->parent->requestModified(SP_OBJECT_MODIFIED_FLAG);
 182             }
 183             break;
 184         case SP_ATTR_IN2:
 185             input = sp_filter_primitive_read_in(feDisplacementMap, value);
 186             if (input != feDisplacementMap->in2) {
 187                 feDisplacementMap->in2 = input;
 188                 object->parent->requestModified(SP_OBJECT_MODIFIED_FLAG);
 189             }
 190             break;
 191         default:
 192             if (((SPObjectClass *) feDisplacementMap_parent_class)->set)
 193                 ((SPObjectClass *) feDisplacementMap_parent_class)->set(object, key, value);
 194             break;
 195     }
 196
 197 }
 198
 199 /**
 200  * Receives update notifications.
 201  */
 202 static void
 203 sp_feDisplacementMap_update(SPObject *object, SPCtx *ctx, guint flags)
 204 {
 205     if (flags & (SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_STYLE_MODIFIED_FLAG |
 206                  SP_OBJECT_VIEWPORT_MODIFIED_FLAG)) {
 207
 208         /* do something to trigger redisplay, updates? */
 209
 210     }
 211
 212     /* Unlike normal in, in2 is required attribute. Make sure, we can call
 213      * it by some name. */
 214     SPFeDisplacementMap *disp = SP_FEDISPLACEMENTMAP(object);
 215     if (disp->in2 == Inkscape::Filters::NR_FILTER_SLOT_NOT_SET ||
 216         disp->in2 == Inkscape::Filters::NR_FILTER_UNNAMED_SLOT)
 217     {
 218         SPFilter *parent = SP_FILTER(object->parent);
 219         disp->in2 = sp_filter_primitive_name_previous_out(disp);
 220
 221         //XML Tree being used directly here while it shouldn't be.
 222         object->getRepr()->setAttribute("in2", sp_filter_name_for_image(parent, disp->in2));
 223     }
 224
 225     if (((SPObjectClass *) feDisplacementMap_parent_class)->update) {
 226         ((SPObjectClass *) feDisplacementMap_parent_class)->update(object, ctx, flags);
 227     }
 228 }
 229
 230 static char const * get_channelselector_name(FilterDisplacementMapChannelSelector selector) {
 231     switch(selector) {
 232         case DISPLACEMENTMAP_CHANNEL_RED:
 233             return "R";
 234         case DISPLACEMENTMAP_CHANNEL_GREEN:
 235             return "G";
 236         case DISPLACEMENTMAP_CHANNEL_BLUE:
 237             return "B";
 238         case DISPLACEMENTMAP_CHANNEL_ALPHA:
 239             return "A";
 240         default:
 241             return 0;
 242     }
 243 }
 244
 245 /**
 246  * Writes its settings to an incoming repr object, if any.
 247  */
 248 static Inkscape::XML::Node *
 249 sp_feDisplacementMap_write(SPObject *object, Inkscape::XML::Document *doc, Inkscape::XML::Node *repr, guint flags)
 250 {
 251     SPFeDisplacementMap *disp = SP_FEDISPLACEMENTMAP(object);
 252     SPFilter *parent = SP_FILTER(object->parent);
 253
 254     if (!repr) {
 255         repr = doc->createElement("svg:feDisplacementMap");
 256     }
 257
 258     gchar const *out_name = sp_filter_name_for_image(parent, disp->in2);
 259     if (out_name) {
 260         repr->setAttribute("in2", out_name);
 261     } else {
 262         SPObject *i = parent->children;
 263         while (i && i->next != object) i = i->next;
 264         SPFilterPrimitive *i_prim = SP_FILTER_PRIMITIVE(i);
 265         out_name = sp_filter_name_for_image(parent, i_prim->image_out);
 266         repr->setAttribute("in2", out_name);
 267         if (!out_name) {
 268             g_warning("Unable to set in2 for feDisplacementMap");
 269         }
 270     }
 271
 272     sp_repr_set_svg_double(repr, "scale", disp->scale);
 273     repr->setAttribute("xChannelSelector",
 274                        get_channelselector_name(disp->xChannelSelector));
 275     repr->setAttribute("yChannelSelector",
 276                        get_channelselector_name(disp->yChannelSelector));
 277
 278     if (((SPObjectClass *) feDisplacementMap_parent_class)->write) {
 279         ((SPObjectClass *) feDisplacementMap_parent_class)->write(object, doc, repr, flags);
 280     }
 281
 282     return repr;
 283 }
 284
 285 static void sp_feDisplacementMap_build_renderer(SPFilterPrimitive *primitive, Inkscape::Filters::Filter *filter) {
 286     g_assert(primitive != NULL);
 287     g_assert(filter != NULL);
 288
 289     SPFeDisplacementMap *sp_displacement_map = SP_FEDISPLACEMENTMAP(primitive);
 290
 291     int primitive_n = filter->add_primitive(Inkscape::Filters::NR_FILTER_DISPLACEMENTMAP);
 292     Inkscape::Filters::FilterPrimitive *nr_primitive = filter->get_primitive(primitive_n);
 293     Inkscape::Filters::FilterDisplacementMap *nr_displacement_map = dynamic_cast<Inkscape::Filters::FilterDisplacementMap*>(nr_primitive);
 294     g_assert(nr_displacement_map != NULL);
 295
 296     sp_filter_primitive_renderer_common(primitive, nr_primitive);
 297
 298     nr_displacement_map->set_input(1, sp_displacement_map->in2);
 299     nr_displacement_map->set_scale(sp_displacement_map->scale);
 300     nr_displacement_map->set_channel_selector(0, sp_displacement_map->xChannelSelector);
 301     nr_displacement_map->set_channel_selector(1, sp_displacement_map->yChannelSelector);
 302 }
 303
 304
 305 /*
 306   Local Variables:
 307   mode:c++
 308   c-file-style:"stroustrup"
 309   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 310   indent-tabs-mode:nil
 311   fill-column:99
 312   End:
 313 */
 314 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:fileencoding=utf-8:textwidth=99 :