home *** CD-ROM | disk | FTP | other *** search
/ Hackers Magazine 57 / CdHackersMagazineNr57.iso / Software / Multimedia / k3d-setup-0.7.11.0.exe / include / k3d / k3dsdk / named_arrays.h < prev    next >
Encoding:
C/C++ Source or Header  |  2008-11-07  |  3.6 KB  |  106 lines
  1. #ifndef K3DSDK_NAMED_ARRAYS_H
  2. #define K3DSDK_NAMED_ARRAYS_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. #include "almost_equal.h"
  24. #include "pipeline_data.h"
  25. #include "types.h"
  26.  
  27. #include <map>
  28.  
  29. namespace k3d
  30. {
  31.  
  32. class array;
  33.  
  34. /// Defines a heterogeneous collection of named, shared arrays.  Arrays in the collection are not length-constrained.
  35. /// For a collection of arrays that all have the same length, see attribute_arrays.  For a concrete list of the
  36. /// datatypes that can be stored using named_arrays, see k3d::named_array_types.
  37. class named_arrays :
  38.     public std::map<string_t, pipeline_data<array> >
  39. {
  40. public:
  41.     /// Creates a new array with given name and type, inserting it into the collection and returning a reference to the result.
  42.     /** \note: An existing array with the same name will be replaced by the new array. */
  43.     template<typename ArrayT>
  44.     ArrayT& create(const string_t& Name)
  45.     {
  46.         ArrayT* const array = new ArrayT();
  47.         (*this)[Name].create(array);
  48.         return *array;
  49.     }
  50.     /// Inserts a new array into the collection with the given name, returning a reference to the result.
  51.     /** \note: An existing array with the same name will be replaced by the new array. */
  52.     template<typename ArrayT>
  53.     ArrayT& create(const string_t& Name, ArrayT* Array)
  54.     {
  55.         (*this)[Name].create(Array);
  56.         return *Array;
  57.     }
  58.     /// Returns an existing array with the given name, or NULL if no matching array exists.
  59.     const array* lookup(const string_t& Name) const;
  60.     /// Returns an existing array with the given name and type, or NULL if no matching array exists.
  61.     template<typename ArrayT>
  62.     const ArrayT* lookup(const string_t& Name) const
  63.     {
  64.         return dynamic_cast<const ArrayT*>(lookup(Name));
  65.     }
  66.     /// Returns an existing array with the given name, or NULL if no matching array exists.
  67.     array* writable(const string_t& Name);
  68.     /// Returns an existing array with the given name and type, or NULL if no matching array exists.
  69.     template<typename ArrayT>
  70.     ArrayT* writable(const string_t& Name)
  71.     {
  72.         return dynamic_cast<ArrayT*>(writable(Name));
  73.     }
  74.     /// Returns an object containing empty arrays with the same name and type as the originals.
  75.     named_arrays clone_types() const;
  76.     /// Returns an object containing deep copies of all the original arrays.
  77.     named_arrays clone() const;
  78.     /// Returns true iff two collections are equivalent, using the imprecise semantics of almost_equal to compare values.
  79.     const bool_t almost_equal(const named_arrays& Other, const uint64_t Threshold) const;
  80. };
  81.  
  82. /// Specialization of almost_equal that tests named_arrays for equality
  83. template<>
  84. class almost_equal<named_arrays>
  85. {
  86.     typedef named_arrays T;
  87.  
  88. public:
  89.     almost_equal(const uint64_t Threshold) :
  90.         threshold(Threshold)
  91.     {
  92.     }
  93.  
  94.     inline const bool_t operator()(const T& A, const T& B) const
  95.     {
  96.         return A.almost_equal(B, threshold);
  97.     }
  98.  
  99.     const uint64_t threshold;
  100. };
  101.  
  102. } // namespace k3d
  103.  
  104. #endif // !K3DSDK_NAMED_ARRAYS_H
  105.  
  106.