synfig-core/src/synfig/target.h

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file target.h
   3 **      \brief Target Class Implementation
   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_TARGET_H
  27 #define __SYNFIG_TARGET_H
  28
  29 /* === H E A D E R S ======================================================= */
  30
  31 #include <sigc++/signal.h>
  32 #include "string_decl.h"
  33 #include <utility>
  34 //#include <list>
  35 #include <map>
  36 #include <ETL/handle>
  37 #include "renddesc.h"
  38 //#include "general.h"
  39 #include "color.h"
  40 #include "canvas.h"
  41
  42 /* === M A C R O S ========================================================= */
  43
  44 //! \writeme
  45 #define SYNFIG_TARGET_MODULE_EXT public: static const char name__[], version__[], ext__[],cvs_id__[]; static Target *create(const char *filename);
  46
  47 //! Sets the name of the target
  48 #define SYNFIG_TARGET_SET_NAME(class,x) const char class::name__[]=x
  49
  50 //! \writeme
  51 #define SYNFIG_TARGET_SET_EXT(class,x) const char class::ext__[]=x
  52
  53 //! Sets the version of the target
  54 #define SYNFIG_TARGET_SET_VERSION(class,x) const char class::version__[]=x
  55
  56 //! Sets the CVS ID of the target
  57 #define SYNFIG_TARGET_SET_CVS_ID(class,x) const char class::cvs_id__[]=x
  58
  59 //! \writeme
  60 #define SYNFIG_TARGET_INIT(class) synfig::Target* class::create(const char *filename) { return new class(filename); }
  61
  62 /* === T Y P E D E F S ===================================================== */
  63
  64 /* === C L A S S E S & S T R U C T S ======================================= */
  65
  66 namespace synfig {
  67
  68 class Surface;
  69 class RendDesc;
  70 class Canvas;
  71 class ProgressCallback;
  72
  73 /*!     \class Target
  74 **      \brief Render-target
  75 **      \todo writeme
  76 */
  77 class Target : public etl::shared_object
  78 {
  79 public:
  80         typedef etl::handle<Target> Handle;
  81         typedef etl::loose_handle<Target> LooseHandle;
  82         typedef etl::handle<const Target> ConstHandle;
  83
  84         /*
  85  -- ** -- S I G N A L S -------------------------------------------------------
  86         */
  87
  88 private:
  89
  90         sigc::signal<void> signal_progress_;
  91
  92         /*
  93  -- ** -- S I G N A L   I N T E R F A C E -------------------------------------
  94         */
  95
  96 public:
  97
  98         sigc::signal<void>& signal_progress() { return signal_progress_; }
  99
 100         /*
 101  --     ** -- C O N S T R U C T O R S ---------------------------------------------
 102         */
 103
 104 public:
 105         //! Type that represents a pointer to a Target's constructor.
 106         /*! As a pointer to the constructor, it represents a "factory" of targets.
 107         **  Receives the output filename (including path).
 108         */
 109         typedef Target* (*Factory)(const char *filename);
 110
 111         struct BookEntry
 112         {
 113                 Factory factory;
 114                 String filename; ///< Output filename including path
 115         };
 116
 117         //! Book of types of targets indexed by the name of the Target.
 118         typedef std::map<String,BookEntry> Book;
 119
 120         typedef std::map<String,String> ExtBook;
 121
 122         //! Target Book, indexed by the target's name
 123         static Book* book_;
 124
 125         //! Map of target names indexed by associated file extension
 126         static ExtBook* ext_book_;
 127
 128         static Book& book();
 129         static ExtBook& ext_book();
 130
 131         static bool subsys_init();
 132         static bool subsys_stop();
 133
 134         //! Adjusted Render description set by set_rend_desc()
 135         RendDesc desc;
 136
 137         etl::handle<Canvas> canvas;
 138
 139         int quality_;
 140         Gamma gamma_;
 141
 142         bool remove_alpha;
 143
 144         bool avoid_time_sync_;
 145
 146 protected:
 147
 148         Target();
 149
 150 public:
 151         virtual ~Target() { }
 152
 153         int get_quality()const { return quality_; }
 154
 155         void set_quality(int q) { quality_=q; }
 156
 157         void set_avoid_time_sync(bool x=true) { avoid_time_sync_=x; }
 158
 159         bool get_avoid_time_sync()const { return avoid_time_sync_; }
 160
 161         bool get_remove_alpha()const { return remove_alpha; }
 162
 163         void set_remove_alpha(bool x=true) { remove_alpha=x; }
 164
 165         Gamma &gamma() { return gamma_; }
 166
 167         const Gamma &gamma()const { return gamma_; }
 168
 169         virtual void set_canvas(etl::handle<Canvas> c);
 170
 171         const etl::handle<Canvas> &get_canvas()const { return canvas; }
 172
 173         RendDesc &rend_desc() { return desc; }
 174         const RendDesc &rend_desc()const { return desc; }
 175
 176         //! Renders the canvas to the target
 177         virtual bool render(ProgressCallback *cb=NULL)=0;
 178
 179         //! Sets the RendDesc for the Target to \a desc.
 180         /*!     If there are any parts of \a desc that the render target
 181         **      is not capable of doing, the render target will adjust
 182         **      \a desc to fit its needs.
 183         */
 184         virtual bool set_rend_desc(RendDesc *d) { desc=*d; return true; }
 185
 186         virtual bool init() { return true; }
 187
 188         //! Creates a new Target described by \a type, outputting to a file described by \a filename.
 189         static Handle create(const String &type, const String &filename);
 190 }; // END of class Target
 191
 192 }; // END of namespace synfig
 193
 194 /* === E N D =============================================================== */
 195
 196 #include "canvas.h"
 197 #endif