Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Select.h
Go to the documentation of this file.
1 /*
2 
3 License
4 
5 Menge
6 Copyright and trademark 2012-14 University of North Carolina at Chapel Hill.
7 All rights reserved.
8 
9 Permission to use, copy, modify, and distribute this software and its documentation
10 for educational, research, and non-profit purposes, without fee, and without a
11 written agreement is hereby granted, provided that the above copyright notice,
12 this paragraph, and the following four paragraphs appear in all copies.
13 
14 This software program and documentation are copyrighted by the University of North
15 Carolina at Chapel Hill. The software program and documentation are supplied "as is,"
16 without any accompanying services from the University of North Carolina at Chapel
17 Hill or the authors. The University of North Carolina at Chapel Hill and the
18 authors do not warrant that the operation of the program will be uninterrupted
19 or error-free. The end-user understands that the program was developed for research
20 purposes and is advised not to rely exclusively on the program for any reason.
21 
22 IN NO EVENT SHALL THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL OR THE AUTHORS
23 BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL
24 DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS
25 DOCUMENTATION, EVEN IF THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL OR THE
26 AUTHORS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 
28 THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL AND THE AUTHORS SPECIFICALLY
29 DISCLAIM ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
30 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE AND ANY STATUTORY WARRANTY
31 OF NON-INFRINGEMENT. THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND
32 THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL AND THE AUTHORS HAVE NO OBLIGATIONS
33 TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
34 
35 Any questions or comments should be sent to the authors {menge,geom}@cs.unc.edu
36 
37 */
38 
44 #ifndef __SELECT_H__
45 #define __SELECT_H__
46 
47 #include "CoreConfig.h"
48 #include <vector>
49 #include <string>
50 
51 namespace Menge {
52 
53  namespace SceneGraph {
54 
59  class MENGE_API Selectable {
60  public:
64  Selectable();
65 
69  void loadSelectName() const;
70 
76  unsigned int getID() const { return _id; }
77 
82  virtual void dummy() { return; }
83 
89  static Selectable * getSelectedObject() { return _selectedObject; }
90 
100  static unsigned int getSelectedName() { return _selectedName; }
101 
105  static void clearSelectedObject() {
106  if ( _selectedObject ) _selectedObject->_selected = false;
107  _selectedObject = 0x0;
108  _selectedName = 0;
109  }
110 
116  static void setSelectedObject( Selectable * obj ) {
117  clearSelectedObject();
118  _selectedName = obj->_id;
119  _selectedObject = obj;
120  obj->_selected = true;
121  }
122 
129  static void selectStart();
130 
139  static bool selectEnd();
140 
144  static unsigned int nextSelectName() { return ID; }
145 
146  protected:
150  unsigned int _id;
151 
158  bool _selected;
159 
160  private:
164  static const unsigned int BUFFER_SIZE;
165 
169  static unsigned int * _buffer;
170 
176  static unsigned int ID;
177 
184  static Selectable * _selectedObject;
185 
189  static unsigned int _selectedName;
190 
194  static std::vector< Selectable * > _selectables;
195 
196  };
197 
201  typedef std::vector< Selectable * > SelectableVector;
202 
206  typedef SelectableVector::iterator SelectableVectorItr;
207 
211  typedef SelectableVector::const_iterator SelectableVectorCItr;
212 
213  } // namespace SceneGraph
214 } // namespace Menge
215 #endif // __SELECT_H__
static Selectable * getSelectedObject()
Retrives a pointer to the currently selected node.
Definition: Select.h:89
static unsigned int getSelectedName()
Returns the "name" of the currently selected object.
Definition: Select.h:100
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
virtual void dummy()
A dummy function that makes Selectable polymorphic. It enables the use of dynamic_cast. Otherwise, it is a no-op.
Definition: Select.h:82
Sets up the proper compiler directives for platform and dll export/import.
static void setSelectedObject(Selectable *obj)
Forces an arbitrary selectable to be selected.
Definition: Select.h:116
static void clearSelectedObject()
Clears the current selection.
Definition: Select.h:105
static unsigned int nextSelectName()
Reports the next available selection name.
Definition: Select.h:144
unsigned int _id
Globally unique OpenGL name for selection.
Definition: Select.h:150
The SceneGraph (SceneGraph) name space, containing all elements to use in a SceneGraph.
unsigned int getID() const
Returns this object's globally unique selection id.
Definition: Select.h:76
bool _selected
Reports if this node is selcted.
Definition: Select.h:158
The class interface for selectable objects – objects which can be selectedc in the OpenGL context by...
Definition: Select.h:59