synfig-core/tags/synfig_0_61_04/synfig-core/src/synfig/listimporter.h

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file listimporter.h
   3 **      \brief Template Header
   4 **
   5 **      $Id: listimporter.h,v 1.1.1.1 2005/01/04 01:23:14 darco Exp $
   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_LISTIMPORTER_H
  26 #define __SYNFIG_LISTIMPORTER_H
  27
  28 /* === H E A D E R S ======================================================= */
  29
  30 #include "importer.h"
  31 #include "surface.h"
  32 #include <ETL/smart_ptr>
  33 #include <vector>
  34 //#include <deque>
  35 #include <list>
  36 #include <utility>
  37
  38 /* === M A C R O S ========================================================= */
  39
  40 /* === T Y P E D E F S ===================================================== */
  41
  42 /* === C L A S S E S & S T R U C T S ======================================= */
  43
  44 namespace synfig {
  45
  46 /*!     \class ListImporter
  47 **      \todo Write more detailed description
  48 */
  49 class ListImporter : public Importer
  50 {
  51         float fps;
  52         std::vector<String> filename_list;
  53         std::list<std::pair<int,Surface> > frame_cache;
  54 protected:
  55         ListImporter(const String &filename);
  56
  57 public:
  58
  59         virtual ~ListImporter();
  60
  61         virtual bool get_frame(Surface &surface,Time time, ProgressCallback *callback=NULL);
  62
  63         virtual bool is_animated();
  64
  65         static Importer* create(const char *filename);
  66 };
  67
  68 }; // END of namespace synfig
  69
  70 /* === E N D =============================================================== */
  71
  72 #endif