Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
NavMeshObstacleSet.h
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 __NAVMESH_OBSTACLE_SET_H__
45 #define __NAVMESH_OBSTACLE_SET_H__
46 
47 #include "mengeCommon.h"
50 #include "Obstacle.h"
51 #include "NavMesh.h"
52 #include <vector>
53 
54 namespace Menge {
55 
56  namespace Agents {
57 
58  class NavMeshObstacleSetFactory;
63  class MENGE_API NavMeshObstacleSet : public ListObstacleSet {
64  public:
69 
76  bool extractFromNavMesh(NavMeshPtr nm);
77 
78  };
79 
81 
85  class MENGE_API NavMeshObstacleSetFactory : public ObstacleSetFactory {
86  public:
87 
92 
101  virtual const char * name() const { return "nav_mesh"; }
102 
110  virtual const char * description() const {
111  return "Obstacle definitions extracted from a provided nav_mesh.";
112  };
113 
114  protected:
125  ObstacleSet * instance() const { return new NavMeshObstacleSet(); }
126 
145  virtual bool setFromXML( ObstacleSet * gen, TiXmlElement * node, const std::string & specFldr ) const;
146 
147 
151  size_t _fileNameID;
152 
153  };
154  } // namespace Agents
155 } // namespace Menge
156 
157 #endif // __EXPLICIT_OBSTACLE_SET_H__
Factory for NavMeshObstacleSet.
Definition: NavMeshObstacleSet.h:85
The base class for obstacle set definitions.
Definition: ObstacleSet.h:101
Definition of obstacle set class which produces obstacles based on explicit definition in an XML file...
Definition: ListObstacleSet.h:62
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
Contains the Obstacle class.
An abstract class for any obstacle set which will need an _obstacles list. Provides transformations f...
virtual const char * name() const
The name of the obstacleset type.
Definition: NavMeshObstacleSet.h:101
size_t _fileNameID
The identifier for the "file_name" string attribute.
Definition: NavMeshObstacleSet.h:151
A class for parsing the xml description of an agent generator and instantiating particular instances...
Definition: ObstacleSetFactory.h:60
virtual const char * description() const
A description of the obstacle set.
Definition: NavMeshObstacleSet.h:110
ObstacleSet * instance() const
Create an instance of this class's obstacleset implementation.
Definition: NavMeshObstacleSet.h:125
The factory for parsing xml data and instantiating ObstacleSet implementations.
Defines the classes which maintain the navigation mesh data.
The namespace that contains the basic simulation mechanisms.
Definition of obstacle set class which produces obstacles based on explicit definition in an XML file...
Definition: NavMeshObstacleSet.h:63