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-2022 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 
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 
124  void addAdditionalGLObject(GUIGlObject *o, const double exaggeration = 1) {
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  // grow using exaggeration
134  if (exaggeration > 1) {
135  b.scale(exaggeration);
136  }
137  // show information in gui testing debug gl mode
139  if ((b.getWidth() == 0) || (b.getHeight() == 0)) {
140  throw ProcessError("Boundary of GUIGlObject " + o->getMicrosimID() + " has an invalid size");
141  } else if (myTreeDebug.count(o) > 0) {
142  throw ProcessError("GUIGlObject was already inserted");
143  } else {
144  myTreeDebug[o] = b;
145  // write GL Debug
146  WRITE_GLDEBUG("\tInserted " + o->getFullName() + " into SUMORTree with boundary " + toString(b));
147  }
148  }
149  // insert it in Tree
150  const float cmin[2] = {(float) b.xmin(), (float) b.ymin()};
151  const float cmax[2] = {(float) b.xmax(), (float) b.ymax()};
152  Insert(cmin, cmax, o);
153  }
154 
158  void removeAdditionalGLObject(GUIGlObject *o, const double exaggeration = 1) {
159  // check if lock is locked remove insert objects
160  if (myLock.locked()) {
161  throw ProcessError("Mutex of SUMORTree is locked before object remove");
162  }
163  // lock mutex
164  FXMutexLock locker(myLock);
165  // obtain boundary of object
167  // grow using exaggeration
168  if (exaggeration > 1) {
169  b.scale(exaggeration);
170  }
171  // show information in gui testing debug gl mode
173  if ((b.getWidth() == 0) || (b.getHeight() == 0)) {
174  throw ProcessError("Boundary of GUIGlObject " + o->getMicrosimID() + " has an invalid size");
175  } else if (myTreeDebug.count(o) == 0) {
176  throw ProcessError("GUIGlObject wasn't inserted");
177  } else if (toString(b) != toString(myTreeDebug.at(o))) {
178  // show information in console before throwing exception
179  std::cout << "Tree: " << toString(myTreeDebug.at(o)) << " original: " << toString(b) << std::endl;
180  throw ProcessError("add boundary of GUIGlObject " + o->getMicrosimID() + " is different of removed boundary (" + toString(b) + " != " + toString(myTreeDebug.at(o)) + ")");
181  } else {
182  myTreeDebug.erase(o);
183  WRITE_GLDEBUG("\tRemoved object " + o->getFullName() + " from SUMORTree with boundary " + toString(b));
184  }
185  }
186  // remove it from Tree
187  const float cmin[2] = {(float) b.xmin(), (float) b.ymin()};
188  const float cmax[2] = {(float) b.xmax(), (float) b.ymax()};
189  Remove(cmin, cmax, o);
190  }
191 
192 protected:
194  mutable FXMutex myLock;
195 
196 private:
200  std::map<GUIGlObject*, Boundary> myTreeDebug;
201 };
#define WRITE_ERROR(msg)
Definition: MsgHandler.h:288
#define WRITE_GLDEBUG(msg)
Definition: MsgHandler.h:291
#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:46
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
Boundary & scale(double by)
scale the boundary by the given amount
Definition: Boundary.cpp:309
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:95
A RT-tree for efficient storing of SUMO's GL-objects.
Definition: SUMORTree.h:66
void addAdditionalGLObject(GUIGlObject *o, const double exaggeration=1)
Adds an additional object (detector/shape/trigger) for visualisation.
Definition: SUMORTree.h:124
virtual void Remove(const float a_min[2], const float a_max[2], GUIGlObject *const &a_dataId)
Remove entry.
Definition: SUMORTree.h:102
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:200
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
void removeAdditionalGLObject(GUIGlObject *o, const double exaggeration=1)
Removes an additional object (detector/shape/trigger) from being visualised.
Definition: SUMORTree.h:158
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
FXMutex myLock
A mutex avoiding parallel change and traversal of the tree.
Definition: SUMORTree.h:194
virtual ~SUMORTree()
Destructor.
Definition: SUMORTree.h:75