synfig-studio/trunk/src/gtkmm/asyncrenderer.h

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file asyncrenderer.h
   3 **      \brief Template Header
   4 **
   5 **      $Id$
   6 **
   7 **      \legal
   8 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
   9 **      Copyright (c) 2007 Chris Moore
  10 **
  11 **      This package is free software; you can redistribute it and/or
  12 **      modify it under the terms of the GNU General Public License as
  13 **      published by the Free Software Foundation; either version 2 of
  14 **      the License, or (at your option) any later version.
  15 **
  16 **      This package is distributed in the hope that it will be useful,
  17 **      but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 **      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19 **      General Public License for more details.
  20 **      \endlegal
  21 */
  22 /* ========================================================================= */
  23
  24 /* === S T A R T =========================================================== */
  25
  26 #ifndef __SYNFIG_ASYNCRENDERER_H
  27 #define __SYNFIG_ASYNCRENDERER_H
  28
  29 /* === H E A D E R S ======================================================= */
  30
  31 #include <ETL/handle>
  32 #include <sigc++/signal.h>
  33 #include <sigc++/trackable.h>
  34 #include <sigc++/connection.h>
  35
  36 #include <synfig/target_scanline.h>
  37 #include <synfig/target_tile.h>
  38 #include <synfig/surface.h>
  39 #include <glibmm/main.h>
  40 #include <ETL/ref_count>
  41 #include <glibmm/thread.h>
  42 #include <glibmm/dispatcher.h>
  43
  44 /* === M A C R O S ========================================================= */
  45
  46 // uncomment to use a single thread, and hopefully get more stability
  47 // #define SINGLE_THREADED
  48 #ifdef SINGLE_THREADED
  49 #  define single_threaded()     App::single_threaded
  50 #endif
  51
  52 /* === T Y P E D E F S ===================================================== */
  53
  54 /* === C L A S S E S & S T R U C T S ======================================= */
  55
  56 namespace studio {
  57
  58 class AsyncRenderer : public etl::shared_object, public sigc::trackable
  59 {
  60         sigc::signal<void> signal_finished_;
  61         sigc::signal<void> signal_success_;
  62
  63         std::list<sigc::connection> activity_connection_list;
  64
  65         //etl::handle<synfig::Target_Scanline> target_scanline;
  66         //etl::handle<synfig::Target_Tile> target_tile;
  67         etl::handle<synfig::Target> target;
  68
  69         bool error;
  70         bool success;
  71
  72         synfig::ProgressCallback *cb;
  73
  74         sigc::signal<void> signal_stop_;
  75
  76         Glib::Thread* render_thread;
  77         Glib::Dispatcher signal_done_;
  78         Glib::Mutex mutex;
  79         sigc::connection done_connection;
  80
  81         /*
  82  --     ** -- P A R E N T   M E M B E R S -----------------------------------------
  83         */
  84 public:
  85
  86         AsyncRenderer(etl::handle<synfig::Target> target,synfig::ProgressCallback *cb=0);
  87         virtual ~AsyncRenderer();
  88
  89         void start();
  90         void stop();
  91         void pause();
  92         void resume();
  93 #ifdef SINGLE_THREADED
  94         void rendering_progress();
  95         bool updating;
  96 #endif
  97
  98         bool has_error()const { return error; }
  99         bool has_success()const { return success; }
 100
 101         sigc::signal<void>& signal_finished() { return signal_finished_; }
 102         sigc::signal<void>& signal_success() { return signal_success_; }
 103
 104 private:
 105
 106         void render_target();
 107         void start_();
 108
 109         /*
 110  --     ** -- C H I L D   M E M B E R S -------------------------------------------
 111         */
 112
 113 protected:
 114
 115 };
 116
 117 }; // END of namespace studio
 118
 119 /* === E N D =============================================================== */
 120
 121 #endif