Menge Plugin Examples
A Collection of Example Plugins for the Menge Framework
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
FormationsModifier.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 
43 #ifndef __FORMATIONS_MODIFIER_H__
44 #define __FORMATIONS_MODIFIER_H__
45 
46 #include "FormationsConfig.h"
47 #include "FreeFormation.h"
50 #include "FSMEnumeration.h"
51 #include "ReadersWriterLock.h"
52 
53 using namespace Menge;
54 
55 #if defined(_MSC_VER)
56  // Visual Studio spews warnings about some members.
57  // It wants them to be exposed in the dll IN CASE a client uses it.
58  //TODO: remove this warning supression, correct the problem
59  #pragma warning(disable:4251)
60 #endif
61 
62 //forward declaration
63 class TiXmlElement;
64 
65 namespace Formations {
66 
67  // forward declaration
68  class FormationModifierFactory;
69 
74  class FORMATIONS_API FormationModifier : public BFSM::VelModifier {
75  public:
80 
87 
88  protected:
92  virtual ~FormationModifier();
93 
94  public:
95 
99  BFSM::VelModifier* copy() const;
100 
107  void adaptPrefVelocity( const Agents::BaseAgent * agent, Agents::PrefVelocity & pVel );
108 
114  virtual BFSM::Task * getTask();
115 
121  void setFormation( FormationPtr form );
122 
126  void registerAgent(const Agents::BaseAgent * agent);
127 
131  void unregisterAgent(const Agents::BaseAgent * agent);
132 
140  //virtual VelModContext * getContext();
141 
143 
144  protected:
145 
150 
155 
156  };
157 
159 
163  class FORMATIONS_API FormationModifierFactory : public BFSM::VelModFactory {
164  public:
169 
178  virtual const char * name() const { return "formation"; }
179 
187  virtual const char * description() const {
188  return "Forces agents in this state or machine to move in formation";
189  };
190 
191  protected:
202  BFSM::VelModifier * instance() const { return new FormationModifier(); }
203 
222  virtual bool setFromXML( BFSM::VelModifier * modifier, TiXmlElement * node, const std::string & behaveFldr ) const;
223 
227  size_t _fileNameID;
228  };
229 };
230 #endif
virtual const char * description() const
A description of the modifier.
Definition: FormationsModifier.h:187
The name space for the Formation Model.
Definition: FormationsModifier.cpp:45
BFSM::VelModifier * instance() const
Create an instance of this class's modifier.
Definition: FormationsModifier.h:202
FormationPtr _formation
The underlying formation data.
Definition: FormationsModifier.h:149
Configures the shared library aspect of the includes.
virtual const char * name() const
The name of the modifier.
Definition: FormationsModifier.h:178
ReadersWriterLock _lock
Concurrency lock for _formation.
Definition: FormationsModifier.h:154
A velocity modifier which adapts agent preferred velocities so that they move in formations.
Definition: FormationsModifier.h:74
Implementatin of freestyle formations.
The factory class for the FormationModifier.
Definition: FormationsModifier.h:163
size_t _fileNameID
The identifier for the "file_name" string attribute.
Definition: FormationsModifier.h:227