home *** CD-ROM | disk | FTP | other *** search
/ Hackers Magazine 57 / CdHackersMagazineNr57.iso / Software / Multimedia / k3d-setup-0.7.11.0.exe / include / k3d / k3dsdk / inetwork_render_frame.h < prev    next >
Encoding:
C/C++ Source or Header  |  2008-11-07  |  2.9 KB  |  102 lines
  1. #ifndef K3DSDK_INETWORK_RENDER_FRAME_H
  2. #define K3DSDK_INETWORK_RENDER_FRAME_H
  3.  
  4. // K-3D
  5. // Copyright (c) 1995-2008, 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 "iunknown.h"
  28. #include "types.h"
  29.  
  30. namespace k3d
  31. {
  32.  
  33. namespace filesystem { class path; }
  34.  
  35. /// Abstract interface that encapsulates all of the work required to render a "frame".
  36. /// All of the steps ("commands") required to render the frame will be executed in the
  37. /// order that they were added using add_exec_command(), add_copy_command(), and add_view_command().
  38. class inetwork_render_frame :
  39.     public virtual iunknown
  40. {
  41. public:
  42.     /// Defines storage for an environment variable
  43.     class variable
  44.     {
  45.     public:
  46.         variable()
  47.         {
  48.         }
  49.  
  50.         variable(const string_t& Name, const string_t& Value) :
  51.             name(Name),
  52.             value(Value)
  53.         {
  54.         }
  55.  
  56.         string_t name;
  57.         string_t value;
  58.     };
  59.  
  60.     /// Defines storage for a collection of environment variables
  61.     typedef std::vector<variable> environment;
  62.  
  63.     /// Defines storage for a command-line argument
  64.     class argument
  65.     {
  66.     public:
  67.         argument()
  68.         {
  69.         }
  70.  
  71.         argument(const string_t& Value) :
  72.             value(Value)
  73.         {
  74.         }
  75.  
  76.         string_t value;
  77.     };
  78.  
  79.     /// Defines storage for a collection of command-line arguments
  80.     typedef std::vector<argument> arguments;
  81.  
  82.     /// Returns a unique filepath that can be used as an input/output file for this frame
  83.     virtual const filesystem::path add_file(const string_t& Name) = 0;
  84.     /// Sets-up an arbitrary command to be executed.  Supplied environment variables will supplement the application environment.
  85.     virtual void add_exec_command(const string_t& Binary, const environment& Environment, const arguments& Arguments) = 0;
  86.     /// Sets-up a copy operation from one filesystem location to another
  87.     virtual void add_copy_command(const filesystem::path& Source, const filesystem::path& Target) = 0;
  88.     /// Sets-up an view operation that will display a file to the user
  89.     virtual void add_view_command(const filesystem::path& File) = 0;
  90.  
  91. protected:
  92.     inetwork_render_frame() {}
  93.     inetwork_render_frame(const inetwork_render_frame&) {}
  94.     inetwork_render_frame& operator=(const inetwork_render_frame&) { return *this; }
  95.     virtual ~inetwork_render_frame() {}
  96. };
  97.  
  98. } // namespace k3d
  99.  
  100. #endif // !K3DSDK_INETWORK_RENDER_FRAME_H
  101.  
  102.