home *** CD-ROM | disk | FTP | other *** search
/ Hackers Magazine 57 / CdHackersMagazineNr57.iso / Software / Multimedia / k3d-setup-0.7.11.0.exe / include / k3d / k3dsdk / aspect_ratios.h < prev    next >
Encoding:
C/C++ Source or Header  |  2008-01-23  |  1.6 KB  |  58 lines
  1. #ifndef K3DSDK_ASPECT_RATIOS_H
  2. #define K3DSDK_ASPECT_RATIOS_H
  3.  
  4. // K-3D
  5. // Copyright (c) 1995-2005, 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 Tim Shead (tshead@k-3d.com)
  25. */
  26.  
  27. #include "ienumeration_property.h"
  28.  
  29. #include <string>
  30. #include <vector>
  31.  
  32. namespace k3d
  33. {
  34.  
  35. /// Encapsulates a named aspect ratio
  36. struct aspect_ratio
  37. {
  38.     aspect_ratio(const std::string& Name, const std::string& Description, const double Value) : name(Name), description(Description), value(Value) { }
  39.  
  40.     std::string name;
  41.     std::string description;
  42.     double value;    
  43. };
  44.  
  45. /// Defines a collection of named aspect ratios
  46. typedef std::vector<aspect_ratio> aspect_ratios_t;
  47.  
  48. /// Returns a list of useful aspect ratios
  49. const aspect_ratios_t& aspect_ratios();
  50. /// Returns descriptions of the available aspect ratios for use with enumeration properties
  51. const ienumeration_property::enumeration_values_t& aspect_ratio_values();
  52.  
  53. } // namespace k3d
  54.  
  55. #endif // !K3DSDK_ASPECT_RATIOS_H
  56.  
  57.  
  58.