iLab Neuromorphic Robotics Toolkit  0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
DisplayListManager.H
Go to the documentation of this file.
1 /*! @file
2  @author Laurent Itti
3  @copyright GNU Public License (GPL v3)
4  @section License
5  @verbatim
6  // ////////////////////////////////////////////////////////////////////////
7  // The iLab Neuromorphic Robotics Toolkit (NRT) //
8  // Copyright 2010-2012 by the University of Southern California (USC) //
9  // and the iLab at USC. //
10  // //
11  // iLab - University of Southern California //
12  // Hedco Neurociences Building, Room HNB-10 //
13  // Los Angeles, Ca 90089-2520 - USA //
14  // //
15  // See http://ilab.usc.edu for information about this project. //
16  // ////////////////////////////////////////////////////////////////////////
17  // This file is part of The iLab Neuromorphic Robotics Toolkit. //
18  // //
19  // The iLab Neuromorphic Robotics Toolkit is free software: you can //
20  // redistribute it and/or modify it under the terms of the GNU General //
21  // Public License as published by the Free Software Foundation, either //
22  // version 3 of the License, or (at your option) any later version. //
23  // //
24  // The iLab Neuromorphic Robotics Toolkit is distributed in the hope //
25  // that it will be useful, but WITHOUT ANY WARRANTY; without even the //
26  // implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR //
27  // PURPOSE. See the GNU General Public License for more details. //
28  // //
29  // You should have received a copy of the GNU General Public License //
30  // along with The iLab Neuromorphic Robotics Toolkit. If not, see //
31  // <http://www.gnu.org/licenses/>. //
32  // ////////////////////////////////////////////////////////////////////////
33  @endverbatim */
34 
35 #ifndef INCLUDE_NRT_GRAPHICS_DISPLAYLISTMANAGER_H
36 #define INCLUDE_NRT_GRAPHICS_DISPLAYLISTMANAGER_H
37 
39 #include <thread>
40 #include <map>
41 #include <mutex>
42 
43 namespace nrt
44 {
45  namespace graphics
46  {
47  //! Simple manager to create/delete OpenGL displaylists and give them a name
48  /* \ingroup graphics */
50  {
51  public:
52  //! Constructor
53  DisplayListManager() = default;
54 
55  //! Destructor
56  ~DisplayListManager() = default;
57 
58  //! Create a number of lists by providing a unique name
59  /*! Will throw if name already exists */
60  std::pair<unsigned int, size_t> create(std::string const & name, size_t const num = 1);
61 
62  //! Delete an existing block of lists, by name
63  /*! Will throw if name does not exist */
64  void remove(std::string const & name);
65 
66  //! Return true if we have created some lists for the given name
67  bool has(std::string const & name) const;
68 
69  //! Get the first OpenGL list index and the number of allocated lists, by name
70  /*! Will throw if name does not exist */
71  std::pair<unsigned int, size_t> get(std::string const & name) const;
72 
73  //! Clear the entire list
74  void clear();
75 
76  private:
77  std::map<std::string, std::pair<unsigned int, size_t> > itsDL;
78  mutable std::mutex itsMtx;
79  };
80 
81  } // namespace graphics
82 
83  namespace exception
84  {
85  //! Exception that gets thrown if anything goes wrong with DisplayListManager
86  /* \relates DisplayListManager */
88  {
89  public:
90  //! Constructor with a default non-specific error message
92 
93  //! Constructor with a given error message
94  DisplayListManagerException(char const * msg) throw();
95 
96  //! Virtual destructor
97  virtual ~DisplayListManagerException() throw();
98  };
99  }
100 }
101 
102 #endif // INCLUDE_NRT_GRAPHICS_DISPLAYLISTMANAGER_H