home *** CD-ROM | disk | FTP | other *** search
/ Hackers Magazine 57 / CdHackersMagazineNr57.iso / Software / Multimedia / k3d-setup-0.7.11.0.exe / include / k3d / k3dsdk / file_range.h < prev    next >
Encoding:
C/C++ Source or Header  |  2008-11-07  |  2.0 KB  |  65 lines
  1. #ifndef K3DSDK_FILE_RANGE_H
  2. #define K3DSDK_FILE_RANGE_H
  3.  
  4. // K-3D
  5. // Copyright (c) 1995-2007, Timothy M. Shead
  6. //
  7. // Contact: tshead@k-3d.com
  8. //
  9. // This program is free software; you can redistribute it and/or
  10. // modify it under the terms of the GNU General Public
  11. // License as published by the Free Software Foundation; either
  12. // version 2 of the License, or (at your option) any later version.
  13. //
  14. // This program is distributed in the hope that it will be useful,
  15. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17. // General Public License for more details.
  18. //
  19. // You should have received a copy of the GNU General Public
  20. // License along with this program; if not, write to the Free Software
  21. // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22.  
  23. /** \file
  24.     \author Timothy M. Shead (tshead@k-3d.com)
  25. */
  26.  
  27. #include "path.h"
  28.  
  29. namespace k3d
  30. {
  31.  
  32. /////////////////////////////////////////////////////////////////////////////
  33. // file_range
  34.  
  35. /// Encapsulates a half-open range of numbered files (useful for working with animation frames)
  36. class file_range
  37. {
  38. public:
  39.     /// Creates an empty range
  40.     file_range();
  41.  
  42.     /// Returns the maximum number of files that can be represented by this range
  43.     const size_t max_file_count() const;
  44.     /// Returns the full path to the Nth file (N does *not* have to be within the valid range)
  45.     const filesystem::path file(const size_t N) const;
  46.  
  47.     /// Stores the directory that contains the range of files
  48.     filesystem::path directory;
  49.     /// Stores an optional string that precedes the filename number
  50.     ustring before;
  51.     /// Stores the number of digits used to number the filename
  52.     size_t digits;
  53.     /// Stores an optional string that follows the filename number (including file extension, etc)
  54.     ustring after;
  55.     /// Stores the first filename number in the range
  56.     size_t begin;
  57.     /// Stores the one-past-last filename number in the range
  58.     size_t end;
  59. };
  60.  
  61. } // namespace k3d
  62.  
  63. #endif // !K3DSDK_FILE_RANGE_H
  64.  
  65.