home *** CD-ROM | disk | FTP | other *** search
/ Hackers Magazine 57 / CdHackersMagazineNr57.iso / Software / Multimedia / k3d-setup-0.7.11.0.exe / include / k3d / k3dsdk / isnappable.h < prev    next >
C/C++ Source or Header  |  2008-11-07  |  2KB  |  67 lines
  1. #ifndef K3DSDK_ISNAPPABLE_H
  2. #define K3DSDK_ISNAPPABLE_H
  3.  
  4. // K-3D
  5. // Copyright (c) 1995-2006, 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 isnappable, an abstract interface implemented by objects to which other objects can be interactively "snapped"
  25.         \author Tim Shead (tshead@k-3d.com)
  26. */
  27.  
  28. #include "iunknown.h"
  29. #include <vector>
  30.  
  31. namespace k3d
  32. {
  33.  
  34. class isnap_source;
  35. class isnap_target;
  36.     
  37. /// Abstract interface implemented by objects to which other objects can be interactively "snapped"
  38. class isnappable :
  39.     public virtual iunknown
  40. {
  41. public:
  42.     virtual ~isnappable() {}
  43.  
  44.     /// Defines a collection of "snap sources" that describe what parts of this object can be snapped
  45.     typedef std::vector<isnap_source*> snap_sources_t;
  46.     virtual const snap_sources_t snap_sources() = 0;
  47.     
  48.     /// Defines a collection of "snap targets" that describe what parts of this object can be snapped-to
  49.     typedef std::vector<isnap_target*> snap_targets_t;
  50.     virtual const snap_targets_t snap_targets() = 0;
  51.  
  52.     /// Adds a new snap source to the object (which takes control of the lifetime of the new source)
  53.     virtual void add_snap_source(isnap_source* const SnapSource) = 0;
  54.     /// Adds a new snap target to the object (which takes control of the lifetime of the new target)
  55.     virtual void add_snap_target(isnap_target* const SnapTarget) = 0;
  56.     
  57. protected:
  58.     isnappable() {}
  59.     isnappable(const isnappable&) {}
  60.     isnappable& operator=(const isnappable&) { return *this; }
  61. };
  62.  
  63. } // namespace k3d
  64.  
  65. #endif // !K3DSDK_ISNAPPABLE_H
  66.  
  67.