home *** CD-ROM | disk | FTP | other *** search
/ Hackers Magazine 57 / CdHackersMagazineNr57.iso / Software / Multimedia / k3d-setup-0.7.11.0.exe / include / k3d / k3dsdk / attribute_arrays.h < prev    next >
Encoding:
C/C++ Source or Header  |  2008-11-07  |  4.2 KB  |  118 lines
  1. #ifndef K3DSDK_ATTRIBUTE_ARRAYS_H
  2. #define K3DSDK_ATTRIBUTE_ARRAYS_H
  3.  
  4. // K-3D
  5. // Copyright (c) 1995-2007, 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. #include <vector>
  29.  
  30. namespace k3d
  31. {
  32.  
  33. class array;
  34.  
  35. /// Defines a heterogeneous collection of named, shared arrays of equal length.  Note that the length of every
  36. /// array in the collection must remain equal at all times.
  37. /// For a concrete list of the datatypes that can be stored using attribute_arrays, see k3d::named_array_types.
  38. class attribute_arrays :
  39.     public std::map<string_t, pipeline_data<array> >
  40. {
  41. public:
  42.     /// Creates a new array with given name and type, inserting it into the collection and returning a reference to the result.
  43.     /** \note: An existing array with the same name will be replaced by the new array. */
  44.     template<typename ArrayT>
  45.     ArrayT& create(const string_t& Name)
  46.     {
  47.         ArrayT* const array = new ArrayT();
  48.         (*this)[Name].create(array);
  49.         return *array;
  50.     }
  51.     /// Inserts a new array into the collection with the given name, returning a reference to the result.
  52.     /** \note: An existing array with the same name will be replaced by the new array. */
  53.     template<typename ArrayT>
  54.     ArrayT& create(const string_t& Name, ArrayT* Array)
  55.     {
  56.         (*this)[Name].create(Array);
  57.         return *Array;
  58.     }
  59.     /// Returns an existing array with the given name, or NULL if no matching array exists.
  60.     const array* lookup(const string_t& Name) const;
  61.     /// Returns an existing array with the given name and type, or NULL if no matching array exists.
  62.     template<typename ArrayT>
  63.     const ArrayT* lookup(const string_t& Name) const
  64.     {
  65.         return dynamic_cast<const ArrayT*>(lookup(Name));
  66.     }
  67.     /// Returns an existing array with the given name, or NULL if no matching array exists.
  68.     array* writable(const string_t& Name);
  69.     /// Returns an existing array with the given name and type, or NULL if no matching array exists.
  70.     template<typename ArrayT>
  71.     ArrayT* writable(const string_t& Name)
  72.     {
  73.         return dynamic_cast<ArrayT*>(writable(Name));
  74.     }
  75.     /// Returns an object containing empty arrays with the same name and type as the originals.
  76.     attribute_arrays clone_types() const;
  77.     /// Returns an object containing deep copies of all the original arrays.
  78.     attribute_arrays clone() const;
  79.     /// Returns an object containing copies of a half-open range of all the original arrays.
  80.     attribute_arrays clone(const uint_t Begin, const uint_t End) const;
  81.     /// Returns true iff two collections are equivalent, using the imprecise semantics of almost_equal to compare values.
  82.     const bool_t almost_equal(const attribute_arrays& Other, const uint64_t Threshold) const;
  83.  
  84.     typedef std::vector<const attribute_arrays*> attribute_arrays_collection;
  85.     static attribute_arrays clone_types(const attribute_arrays_collection& AttributeArrays);
  86.  
  87.     /// Sets the size of every array in the collection.
  88.     void resize(const uint_t NewSize);
  89.  
  90.     /// Returns true if every array in the collection matches the given size (or there aren't any arrays in the collection).
  91.     const bool_t match_size(const uint_t Size) const;
  92. };
  93.  
  94. /// Specialization of almost_equal that tests attribute_arrays for equality
  95. template<>
  96. class almost_equal<attribute_arrays>
  97. {
  98.     typedef attribute_arrays T;
  99.  
  100. public:
  101.     almost_equal(const uint64_t Threshold) :
  102.         threshold(Threshold)
  103.     {
  104.     }
  105.  
  106.     inline const bool_t operator()(const T& A, const T& B) const
  107.     {
  108.         return A.almost_equal(B, threshold);
  109.     }
  110.  
  111.     const uint64_t threshold;
  112. };
  113.  
  114. } // namespace k3d
  115.  
  116. #endif // !K3DSDK_ATTRIBUTE_ARRAYS_H
  117.  
  118.