home *** CD-ROM | disk | FTP | other *** search
/ Hackers Magazine 57 / CdHackersMagazineNr57.iso / Software / Multimedia / k3d-setup-0.7.11.0.exe / include / k3d / k3dsdk / idocument.h < prev    next >
Encoding:
C/C++ Source or Header  |  2008-11-07  |  2.5 KB  |  83 lines
  1. #ifndef K3DSDK_IDOCUMENT_H
  2. #define K3DSDK_IDOCUMENT_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.         \brief Declares idocument, an abstract interface for an open K-3D document
  25.         \author Tim Shead (tshead@k-3d.com)
  26. */
  27.  
  28. #include "iunknown.h"
  29. #include "signal_accumulators.h"
  30. #include "signal_system.h"
  31. #include "uuid.h"
  32.  
  33. #include <map>
  34. #include <string>
  35.  
  36. namespace k3d
  37. {
  38.  
  39. class ipipeline;
  40. class inode_collection;
  41. class inode_name_map;
  42. class ipipeline_profiler;
  43. class iproperty;
  44. class istate_recorder;
  45.  
  46. /// Abstract interface for an open K-3D document
  47. class idocument :
  48.     public virtual iunknown
  49. {
  50. public:
  51.     /// Returns the collection of K-3D objects within this document
  52.     virtual inode_collection& nodes() = 0;
  53.     /// Returns the directed acyclic graph of dependencies between object properties within this document
  54.     virtual ipipeline& pipeline() = 0;
  55.     /// Returns an object that can be used to collect and distribute profiling data for the visualization pipeline
  56.     virtual ipipeline_profiler& pipeline_profiler() = 0;
  57.     /// Returns the istate_recorder interface for this document
  58.     virtual istate_recorder& state_recorder() = 0;
  59.  
  60.     /// Returns an interface that provides a mapping of nodes to unique names
  61.     virtual inode_name_map& unique_node_names() = 0;
  62.     
  63.     /// Returns a property that will store the document filepath (could be empty)
  64.     virtual iproperty& path() = 0;
  65.     /// Returns a property that will store the document title (could be empty string)
  66.     virtual iproperty& title() = 0;
  67.  
  68.     /// Defines a signal emitted when the document closes
  69.     typedef sigc::signal<void> close_signal_t;
  70.     virtual close_signal_t& close_signal() = 0;
  71.  
  72. protected:
  73.     idocument() {}
  74.     idocument(const idocument&) {}
  75.     idocument& operator=(const idocument&) { return *this; }
  76.     virtual ~idocument() {}
  77. };
  78.  
  79. } // namespace k3d
  80.  
  81. #endif // !K3DSDK_IDOCUMENT_H
  82.  
  83.