src/trace/trace.h

   1 /*
   2  * A generic interface for plugging different
   3  *  autotracers into Inkscape.
   4  *
   5  * Authors:
   6  *   Bob Jamison <rjamison@titan.com>
   7  *
   8  * Copyright (C) 2004 Bob Jamison
   9  *
  10  * Released under GNU GPL, read the file 'COPYING' for more information
  11  */
  12 #ifndef __TRACE_H__
  13 #define __TRACE_H__
  14
  15 #ifdef HAVE_CONFIG_H
  16 # include "config.h"
  17 #endif
  18
  19 #ifdef HAVE_STDLIB_H
  20 # include <stdlib.h>
  21 #endif
  22
  23 #ifdef HAVE_STRING_H
  24 # include <string.h>
  25 #endif
  26
  27 #include <gdk/gdkpixbuf.h>
  28
  29 #include <vector>
  30
  31 struct SPImage;
  32 struct SPItem;
  33
  34 namespace Inkscape {
  35
  36 namespace Trace {
  37
  38
  39
  40 /**
  41  *
  42  */
  43 class TracingEngineResult
  44 {
  45
  46 public:
  47
  48     /**
  49      *
  50      */
  51     TracingEngineResult(char *theStyle, char *thePathData, long theNodeCount)
  52         {
  53         next      = NULL;
  54         style     = strdup(theStyle);
  55         pathData  = strdup(thePathData);
  56         nodeCount = theNodeCount;
  57         }
  58
  59     /**
  60      *
  61      */
  62     virtual ~TracingEngineResult()
  63         {
  64         if (next)
  65             delete next;
  66         if (style)
  67             free(style);
  68         if (pathData)
  69             free(pathData);
  70         }
  71
  72
  73     /**
  74      *
  75      */
  76     char *getStyle()
  77         { return style; }
  78
  79     /**
  80      *
  81      */
  82     char *getPathData()
  83         { return pathData; }
  84
  85     /**
  86      *
  87      */
  88     long getNodeCount()
  89         { return nodeCount; }
  90
  91     /**
  92      *
  93      */
  94     TracingEngineResult *next;
  95
  96 private:
  97
  98     char *style;
  99
 100     char *pathData;
 101
 102     long nodeCount;
 103
 104 };
 105
 106
 107
 108 /**
 109  *
 110  */
 111 class TracingEngine
 112 {
 113
 114     public:
 115
 116     /**
 117      *
 118      */
 119     TracingEngine()
 120         {}
 121
 122     /**
 123      *
 124      */
 125     virtual ~TracingEngine()
 126         {}
 127
 128     /**
 129      *  This is the working method of this interface, and all
 130      *  implementing classes.  Take a GdkPixbuf, trace it, and
 131      *  return a style attribute and the path data that is
 132      *  compatible with the d="" attribute
 133      *  of an SVG <path> element.
 134      */
 135     virtual  TracingEngineResult *trace(GdkPixbuf *pixbuf, int *nrPaths)
 136         { return NULL; }
 137
 138
 139     /**
 140      *  Abort the thread that is executing getPathDataFromPixbuf()
 141      */
 142     virtual void abort()
 143         {}
 144
 145
 146
 147 };//class TracingEngine
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157 /**
 158  *  This simple class allows a generic wrapper around a given
 159  *  TracingEngine object.  Its purpose is to provide a gateway
 160  *  to a variety of tracing engines, while maintaining a
 161  *  consistent interface.
 162  */
 163 class Tracer
 164 {
 165
 166 public:
 167
 168
 169     /**
 170      *
 171      */
 172     Tracer()
 173         {
 174         engine       = NULL;
 175         sioxEnabled  = false;
 176         }
 177
 178
 179
 180     /**
 181      *
 182      */
 183     ~Tracer()
 184         {}
 185
 186
 187     /**
 188      *  A convenience method to allow other software to 'see' the
 189      *  same image that this class sees.
 190      */
 191     GdkPixbuf *getSelectedImage();
 192
 193     /**
 194      * This is the main working method.  Trace the selected image, if
 195      * any, and create a <path> element from it, inserting it into
 196      * the current document.
 197      */
 198     void trace(TracingEngine *engine);
 199
 200
 201     /**
 202      *  Abort the thread that is executing convertImageToPath()
 203      */
 204     void abort();
 205
 206     /**
 207      *  Whether we want to enable SIOX subimage selection
 208      */
 209     void enableSiox(bool enable);
 210
 211
 212 private:
 213
 214     /**
 215      * This is the single path code that is called by its counterpart above.
 216      */
 217     void traceThread();
 218
 219     /**
 220      * This is true during execution. Setting it to false (like abort()
 221      * does) should inform the threaded code that it needs to stop
 222      */
 223     bool keepGoing;
 224
 225     /**
 226      *  During tracing, this is Non-null, and refers to the
 227      *  engine that is currently doing the tracing.
 228      */
 229     TracingEngine *engine;
 230
 231     SPImage *getSelectedSPImage();
 232
 233     std::vector<SPItem *> sioxItems;
 234
 235     bool sioxEnabled;
 236
 237     GdkPixbuf *sioxProcessImage(SPImage *img, GdkPixbuf *origPixbuf);
 238
 239 };//class Tracer
 240
 241
 242
 243
 244 } // namespace Trace
 245
 246 } // namespace Inkscape
 247
 248
 249
 250 #endif //__TRACE_H__
 251
 252 //#########################################################################
 253 //# E N D   O F   F I L E
 254 //#########################################################################
 255