Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
GoalSelectorFarthestNM.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 __GOAL_SELECTOR_FARTHEST_NM_H__
45 #define __GOAL_SELECTOR_FARTHEST_NM_H__
46 
47 #include "CoreConfig.h"
48 #include "fsmCommon.h"
50 #include "NavMesh.h"
51 #include "NavMeshLocalizer.h"
52 
53 namespace Menge {
54 
55  namespace BFSM {
61  class MENGE_API FarthestNMGoalSelector : public SetGoalSelector {
62  public:
67 
75  virtual Goal * getGoal( const Agents::BaseAgent * agent ) const;
76 
84  virtual BFSM::Task * getTask();
85 
91  void setNavMesh( const NavMeshPtr & nm ) { _navMesh = nm; }
92 
98  NavMeshPtr getNavMesh() { return _navMesh; }
99 
105  NavMeshLocalizerPtr getLocalizer() { return _localizer; }
106 
112  void setNavMeshLocalizer( const NavMeshLocalizerPtr & nml ) { _localizer = nml; }
113 
114  protected:
119 
124 
125  };
126 
131  public:
136 
145  virtual const char * name() const { return "farthest_nav_mesh"; }
146 
154  virtual const char * description() const {
155  return "A goal selector. Assigns the agent the goal in the given " \
156  "goal set that is *farthest* from the agent based on shortest paths " \
157  "through the navigation mesh.";
158  };
159 
160  protected:
166  GoalSelector * instance() const { return new FarthestNMGoalSelector(); }
167 
180  virtual bool setFromXML( GoalSelector * selector, TiXmlElement * node, const std::string & behaveFldr ) const;
181 
185  size_t _fileNameID;
186  };
187  } // namespace BFSM
188 } // namespace Menge
189 
190 #endif // __GOAL_SELECTOR_FARTHEST_NM_H__
The farthest nav mesh goal selector selects the goal from a goal set that is farthest to the agent in...
Definition: GoalSelectorFarthestNM.h:61
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
Sets up the proper compiler directives for platform and dll export/import.
Data structure responsible for knowing where on the navigation mesh each agent is located...
NavMeshPtr getNavMesh()
Returns a resource pointer to the underlying navigation mesh.
Definition: GoalSelectorFarthestNM.h:98
The base, abstract class defining goals.
Definition: Goal.h:110
This is a base class – not to be instantiated. It provides the functional basis for GoalSelectors wh...
Definition: GoalSelectorSet.h:62
virtual const char * name() const
The name of the goal selector type.
Definition: GoalSelectorFarthestNM.h:145
NavMeshPtr _navMesh
The navigation mesh.
Definition: GoalSelectorFarthestNM.h:118
GoalSelector * instance() const
Create an instance of this class's goal selector.
Definition: GoalSelectorFarthestNM.h:166
NavMeshLocalizerPtr _localizer
The localizer for the navigation mesh.
Definition: GoalSelectorFarthestNM.h:123
NavMeshLocalizerPtr getLocalizer()
Returns a resource pointer to the underlying navigation mesh localizer.
Definition: GoalSelectorFarthestNM.h:105
void setNavMeshLocalizer(const NavMeshLocalizerPtr &nml)
Sets the navigation mesh localizer pointer.
Definition: GoalSelectorFarthestNM.h:112
virtual const char * description() const
A description of the goal selector.
Definition: GoalSelectorFarthestNM.h:154
The namespace contains the Behavior Finite State Machine (BFSM) definition.
void setNavMesh(const NavMeshPtr &nm)
Sets the navigation mesh pointer.
Definition: GoalSelectorFarthestNM.h:91
Collection of convenient pre-compiler information for fsm definitions.
Interface for basic FSM task.
Definition: Task.h:110
Defines the basic agent properties and functionality that all simulation agents share.
Definition: BaseAgent.h:123
The base, abstract class for selecting per-agent goals.
Definition: GoalSelector.h:113
The definition of the base class for handling goal selectors which operate on single goal sets...
Factory for the FarthestNMGoalSelector.
Definition: GoalSelectorFarthestNM.h:130
Defines the classes which maintain the navigation mesh data.
size_t _fileNameID
The identifier for the "file_name" string attribute.
Definition: GoalSelectorFarthestNM.h:185
Factory for the SetGoalSelector.
Definition: GoalSelectorSet.h:121