Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
SpatialQuery.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 
45 #ifndef __SPATIAL_QUERY_H__
46 #define __SPATIAL_QUERY_H__
47 
48 
49 // UTILS
50 #include "CoreConfig.h"
51 #include "Element.h"
52 #include "Obstacle.h"
54 #include "MengeException.h"
55 #include <vector>
56 
57 namespace Menge {
58 
59  namespace Agents {
60 
64  class MENGE_API SpatialQueryException : public virtual MengeException {
65  public:
70 
76  SpatialQueryException( const std::string & s ): MengeException(s) {}
77  };
78 
83  public:
88 
95  };
96 
97  // FORWARD DECLARATIONS
98  class BaseAgent;
99 
114  class MENGE_API SpatialQuery : public Element {
115  public:
119  SpatialQuery();
120 
121  protected:
125  virtual ~SpatialQuery() {}
126 
127  // Agent operations
128  public:
132  virtual void setAgents( const std::vector< BaseAgent * > & agents ) = 0;
133 
139  virtual void updateAgents() = 0;
140 
145  virtual void addObstacle(Obstacle *obs);
146 
152  const std::vector< Obstacle * > getObstacles() {return _obstacles;};
153 
158  virtual void agentQuery( ProximityQuery *query) const = 0;
159 
160  // Obstacle operations
161 
166  virtual void processObstacles() = 0;
167 
172  virtual void obstacleQuery( ProximityQuery *query) const = 0;
173 
186  virtual bool queryVisibility(const Vector2& q1, const Vector2& q2, float radius) const = 0;
187 
194  virtual void setNeighborVisibleTest( bool state ) {}
195 
201  inline void setTestVisibility( bool status ) { _testVisibility = status; }
202 
209  inline bool getTestVisibility() const { return _testVisibility; }
210 
211  protected:
217 
222  std::vector<Obstacle *> _obstacles;
223  };
224  } // namespace Agents
225 } // namespace Menge
226 #endif // __SPATIAL_QUERY_H__
std::vector< Obstacle * > _obstacles
an internal central list of obstacles
Definition: SpatialQuery.h:222
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
const std::vector< Obstacle * > getObstacles()
returns the collected obstacles of the spatial query for use in visualization
Definition: SpatialQuery.h:152
virtual void setNeighborVisibleTest(bool state)
Sets the spatial query to include visibility in finding agent neighbors.
Definition: SpatialQuery.h:194
Contains the Obstacle class.
Sets up the proper compiler directives for platform and dll export/import.
The base definition for exceptions in Menge.
Base class for all Menge elements.
void setTestVisibility(bool status)
Sets the test visibility status of the neighbor functions.
Definition: SpatialQuery.h:201
SpatialQueryFatalException()
Default constructor.
Definition: SpatialQuery.h:87
The basic interface of extendible Menge Elements.
Definition: Element.h:67
virtual ~SpatialQuery()
Virtual destructor.
Definition: SpatialQuery.h:125
Base exception class for menge operations.
Definition: MengeException.h:58
The base class for filtering spatial queries according to proximity.
Definition: ProximityQuery.h:72
The fatal spatial query exception.
Definition: SpatialQuery.h:82
SpatialQueryException(const std::string &s)
Constructor with message.
Definition: SpatialQuery.h:76
Exception class for spatial query operations.
Definition: SpatialQuery.h:64
bool getTestVisibility() const
Reports the test visibility property of the spatial query instance.
Definition: SpatialQuery.h:209
Base class for fatal exceptions.
Definition: MengeException.h:99
SpatialQueryException()
Default constructor.
Definition: SpatialQuery.h:69
Defines static obstacles in the simulation.
Definition: Obstacle.h:56
The base class for performing spatial queries.
Definition: SpatialQuery.h:114
The base class for all objects which actually perform filtering and store results from spatial querie...
SpatialQueryFatalException(const std::string &s)
Constructor with message.
Definition: SpatialQuery.h:94
The namespace that contains the basic simulation mechanisms.
bool _testVisibility
Dictates if visibility queries should be used (true) for neighbor queries or not (false).
Definition: SpatialQuery.h:216