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

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