Eclipse SUMO - Simulation of Urban MObility
SUMORTree.h
Go to the documentation of this file.
1 /****************************************************************************/
2 // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
3 // Copyright (C) 2001-2020 German Aerospace Center (DLR) and others.
4 // This program and the accompanying materials are made available under the
5 // terms of the Eclipse Public License 2.0 which is available at
6 // https://www.eclipse.org/legal/epl-2.0/
7 // This Source Code may also be made available under the following Secondary
8 // Licenses when the conditions for such availability set forth in the Eclipse
9 // Public License 2.0 are satisfied: GNU General Public License, version 2
10 // or later which is available at
11 // https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
12 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
13 /****************************************************************************/
18 // A RT-tree for efficient storing of SUMO's GL-objects
19 /****************************************************************************/
20 #pragma once
21 #include <config.h>
22 
23 #include <fx.h>
25 #include <utils/geom/Boundary.h>
29 
30 #include "RTree.h"
31 
32 
33 #define GUI_RTREE_QUAL RTree<GUIGlObject*, GUIGlObject, float, 2, GUIVisualizationSettings>
34 
35 // specialized implementation for speedup and avoiding warnings
36 
37 template<>
38 inline float GUI_RTREE_QUAL::RectSphericalVolume(Rect* a_rect) {
39  ASSERT(a_rect);
40  const float extent0 = a_rect->m_max[0] - a_rect->m_min[0];
41  const float extent1 = a_rect->m_max[1] - a_rect->m_min[1];
42  return .78539816f * (extent0 * extent0 + extent1 * extent1);
43 }
44 
45 template<>
46 inline GUI_RTREE_QUAL::Rect GUI_RTREE_QUAL::CombineRect(Rect* a_rectA, Rect* a_rectB) {
47  ASSERT(a_rectA && a_rectB);
48  Rect newRect;
49  newRect.m_min[0] = rtree_min(a_rectA->m_min[0], a_rectB->m_min[0]);
50  newRect.m_max[0] = rtree_max(a_rectA->m_max[0], a_rectB->m_max[0]);
51  newRect.m_min[1] = rtree_min(a_rectA->m_min[1], a_rectB->m_min[1]);
52  newRect.m_max[1] = rtree_max(a_rectA->m_max[1], a_rectB->m_max[1]);
53  return newRect;
54 }
55 
56 
57 // ===========================================================================
58 // class definitions
59 // ===========================================================================
66 class SUMORTree : private GUI_RTREE_QUAL, public Boundary {
67 public:
69  SUMORTree() :
70  GUI_RTREE_QUAL(&GUIGlObject::drawGL),
71  myLock(true) {
72  }
73 
75  virtual ~SUMORTree() {
76  // check if lock is locked before insert objects
77  if (myLock.locked()) {
78  // cannot throw exception in destructor
79  WRITE_ERROR("Mutex of SUMORTree is locked during call of the destructor");
80  }
81  // show information in gui testing debug gl mode
82  WRITE_GLDEBUG("Number of objects in SUMORTree during call of the destructor: " + toString(myTreeDebug.size()));
83  }
84 
91  virtual void Insert(const float a_min[2], const float a_max[2], GUIGlObject* const & a_dataId) {
92  FXMutexLock locker(myLock);
93  GUI_RTREE_QUAL::Insert(a_min, a_max, a_dataId);
94  }
95 
102  virtual void Remove(const float a_min[2], const float a_max[2], GUIGlObject* const & a_dataId) {
103  FXMutexLock locker(myLock);
104  GUI_RTREE_QUAL::Remove(a_min, a_max, a_dataId);
105  }
106 
116  virtual int Search(const float a_min[2], const float a_max[2], const GUIVisualizationSettings& c) const {
117  FXMutexLock locker(myLock);
118  return GUI_RTREE_QUAL::Search(a_min, a_max, c);
119  }
120 
125  // check if lock is locked before insert objects
126  if (myLock.locked()) {
127  throw ProcessError("Mutex of SUMORTree is locked before object insertion");
128  }
129  // lock mutex
130  FXMutexLock locker(myLock);
131  // obtain boundary of object
133  // show information in gui testing debug gl mode
135  if ((b.getWidth() == 0) || (b.getHeight() == 0)) {
136  throw ProcessError("Boundary of GUIGlObject " + o->getMicrosimID() + " has an invalid size");
137  } else if (myTreeDebug.count(o) > 0) {
138  throw ProcessError("GUIGlObject was already inserted");
139  } else {
140  myTreeDebug[o] = b;
141  // write GL Debug
142  WRITE_GLDEBUG("\tInserted " + o->getFullName() + " into SUMORTree with boundary " + toString(b));
143  }
144  }
145  // insert it in Tree
146  const float cmin[2] = {(float) b.xmin(), (float) b.ymin()};
147  const float cmax[2] = {(float) b.xmax(), (float) b.ymax()};
148  Insert(cmin, cmax, o);
149  }
150 
155  // check if lock is locked remove insert objects
156  if (myLock.locked()) {
157  throw ProcessError("Mutex of SUMORTree is locked before object remove");
158  }
159  // lock mutex
160  FXMutexLock locker(myLock);
161  // obtain boundary of object
163  // show information in gui testing debug gl mode
165  if ((b.getWidth() == 0) || (b.getHeight() == 0)) {
166  throw ProcessError("Boundary of GUIGlObject " + o->getMicrosimID() + " has an invalid size");
167  } else if (myTreeDebug.count(o) == 0) {
168  throw ProcessError("GUIGlObject wasn't inserted");
169  } else if (toString(b) != toString(myTreeDebug.at(o))) {
170  // show information in console before throwing exception
171  std::cout << "Tree: " << toString(myTreeDebug.at(o)) << " original: " << toString(b) << std::endl;
172  throw ProcessError("add boundary of GUIGlObject " + o->getMicrosimID() + " is different of removed boundary (" + toString(b) + " != " + toString(myTreeDebug.at(o)) + ")");
173  } else {
174  myTreeDebug.erase(o);
175  WRITE_GLDEBUG("\tRemoved object " + o->getFullName() + " from SUMORTree with boundary " + toString(b));
176  }
177  }
178  // remove it from Tree
179  const float cmin[2] = {(float) b.xmin(), (float) b.ymin()};
180  const float cmax[2] = {(float) b.xmax(), (float) b.ymax()};
181  Remove(cmin, cmax, o);
182  }
183 
184 protected:
186  mutable FXMutex myLock;
187 
188 private:
192  std::map<GUIGlObject*, Boundary> myTreeDebug;
193 };
#define WRITE_ERROR(msg)
Definition: MsgHandler.h:284
#define WRITE_GLDEBUG(msg)
Definition: MsgHandler.h:287
#define rtree_min(a, b)
Definition: RTree.h:20
#define rtree_max(a, b)
Definition: RTree.h:21
#define ASSERT
Definition: RTree.h:12
#define GUI_RTREE_QUAL
Definition: SUMORTree.h:33
std::string toString(const T &t, std::streamsize accuracy=gPrecision)
Definition: ToString.h:44
A class that stores a 2D geometrical boundary.
Definition: Boundary.h:39
double ymin() const
Returns minimum y-coordinate.
Definition: Boundary.cpp:129
double xmin() const
Returns minimum x-coordinate.
Definition: Boundary.cpp:117
double getHeight() const
Returns the height of the boundary (y-axis)
Definition: Boundary.cpp:159
double getWidth() const
Returns the width of the boudary (x-axis)
Definition: Boundary.cpp:153
double ymax() const
Returns maximum y-coordinate.
Definition: Boundary.cpp:135
double xmax() const
Returns maximum x-coordinate.
Definition: Boundary.cpp:123
virtual const std::string & getMicrosimID() const
Returns the id of the object as known to microsim.
virtual Boundary getCenteringBoundary() const =0
const std::string & getFullName() const
Stores the information about how to visualize structures.
static bool writeDebugGLMessages()
check whether to enable/disable gl-debug messages
Definition: MsgHandler.h:94
A RT-tree for efficient storing of SUMO's GL-objects.
Definition: SUMORTree.h:66
virtual void Remove(const float a_min[2], const float a_max[2], GUIGlObject *const &a_dataId)
Remove entry.
Definition: SUMORTree.h:102
void removeAdditionalGLObject(GUIGlObject *o)
Removes an additional object (detector/shape/trigger) from being visualised.
Definition: SUMORTree.h:154
std::map< GUIGlObject *, Boundary > myTreeDebug
Map only used for check that SUMORTree works as expected, only is used if option "gui-testing-debug-g...
Definition: SUMORTree.h:192
SUMORTree()
Constructor.
Definition: SUMORTree.h:69
virtual void Insert(const float a_min[2], const float a_max[2], GUIGlObject *const &a_dataId)
Insert entry.
Definition: SUMORTree.h:91
virtual int Search(const float a_min[2], const float a_max[2], const GUIVisualizationSettings &c) const
Find all within search rectangle.
Definition: SUMORTree.h:116
void addAdditionalGLObject(GUIGlObject *o)
Adds an additional object (detector/shape/trigger) for visualisation.
Definition: SUMORTree.h:124
FXMutex myLock
A mutex avoiding parallel change and traversal of the tree.
Definition: SUMORTree.h:186
virtual ~SUMORTree()
Destructor.
Definition: SUMORTree.h:75