synfig-core/trunk/src/synfig/target_tile.h

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file target_tile.h
   3 **      \brief Template Header
   4 **
   5 **      $Id$
   6 **
   7 **      \legal
   8 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
   9 **
  10 **      This package is free software; you can redistribute it and/or
  11 **      modify it under the terms of the GNU General Public License as
  12 **      published by the Free Software Foundation; either version 2 of
  13 **      the License, or (at your option) any later version.
  14 **
  15 **      This package is distributed in the hope that it will be useful,
  16 **      but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 **      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18 **      General Public License for more details.
  19 **      \endlegal
  20 */
  21 /* ========================================================================= */
  22
  23 /* === S T A R T =========================================================== */
  24
  25 #ifndef __SYNFIG_TARGET_TILE_H
  26 #define __SYNFIG_TARGET_TILE_H
  27
  28 /* === H E A D E R S ======================================================= */
  29
  30 #include "target.h"
  31
  32 /* === M A C R O S ========================================================= */
  33
  34 #define TILE_SIZE 120
  35
  36 /* === T Y P E D E F S ===================================================== */
  37
  38 /* === C L A S S E S & S T R U C T S ======================================= */
  39
  40 namespace synfig {
  41
  42 /*!     \class Target_Tile
  43 **      \brief Render-target
  44 **      \todo writeme
  45 */
  46 class Target_Tile : public Target
  47 {
  48         int threads_;
  49         int tile_w_;
  50         int tile_h_;
  51         int curr_tile_;
  52         int curr_frame_;
  53         bool clipping_;
  54 public:
  55         typedef etl::handle<Target_Tile> Handle;
  56         typedef etl::loose_handle<Target_Tile> LooseHandle;
  57         typedef etl::handle<const Target_Tile> ConstHandle;
  58
  59         Target_Tile();
  60
  61         //! Renders the canvas to the target
  62         virtual bool render(ProgressCallback *cb=NULL);
  63
  64         //! Determines which tile needs to be rendered next.
  65         /*!     Most cases will not have to redefine this function.
  66         **      The default should be adequate in nearly all situations.
  67         **      \returns The number of tiles left to go <i>plus one</i>.
  68         **              This means that whenever this function returns zero,
  69         **              there are no more tiles to render and that any value
  70         **              in \a x or \a y should be disregarded. */
  71         virtual int next_tile(int& x, int& y);
  72
  73         virtual int next_frame(Time& time);
  74
  75         //! Adds the tile at \a x , \a y contained in \a surface
  76         virtual bool add_tile(const synfig::Surface &surface, int x, int y)=0;
  77
  78         virtual int total_tiles()const
  79         {
  80                 // Width of the image(in tiles)
  81                 const int tw(rend_desc().get_w()/tile_w_+(rend_desc().get_w()%tile_w_?1:0));
  82                 const int th(rend_desc().get_h()/tile_h_+(rend_desc().get_h()%tile_h_?1:0));
  83
  84                 return tw*th;
  85         }
  86
  87         //! Marks the start of a frame
  88         /*! \return \c true on success, \c false upon an error.
  89         **      \see end_frame(), start_scanline()
  90         */
  91         virtual bool start_frame(ProgressCallback *cb=NULL)=0;
  92
  93         //! Marks the end of a frame
  94         /*! \see start_frame() */
  95         virtual void end_frame()=0;
  96
  97         void set_threads(int x) { threads_=x; }
  98
  99         int get_threads()const { return threads_; }
 100
 101         void set_tile_w(int w) { tile_w_=w; }
 102
 103         int get_tile_w()const { return tile_w_; }
 104
 105         void set_tile_h(int h) { tile_h_=h; }
 106
 107         int get_tile_h()const { return tile_h_; }
 108
 109         bool get_clipping()const { return clipping_; }
 110
 111         void set_clipping(bool x) { clipping_=x; }
 112
 113 private:
 114
 115         bool render_frame_(Context context,ProgressCallback *cb=0);
 116
 117 }; // END of class Target_Tile
 118
 119 }; // END of namespace synfig
 120
 121 /* === E N D =============================================================== */
 122
 123 #endif