Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
GoalSelectorMirror.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_MIRROR_H__
45 #define __GOAL_SELECTOR_MIRROR_H__
46 
47 #include "CoreConfig.h"
48 #include "fsmCommon.h"
51 
52 namespace Menge {
53 
54  namespace BFSM {
63  class MENGE_API MirrorGoalSelector : public GoalSelector {
64  public:
69 
77  virtual Goal * getGoal( const Agents::BaseAgent * agent ) const;
78 
85  inline void setMirror( bool mirrorX, bool mirrorY ) { _mirrorX = mirrorX; _mirrorY = mirrorY; }
86 
92  inline void setMirrorX( bool mirror ) { _mirrorX = mirror; }
93 
99  inline void setMirrorY( bool mirror ) { _mirrorY = mirror; }
100 
106  inline bool getMirrorX() const { return _mirrorX; }
107 
113  inline bool getMirrorY() const { return _mirrorY; }
114 
115  protected:
120  bool _mirrorX;
121 
126  bool _mirrorY;
127  };
128 
132  class MENGE_API MirrorGoalSelectorFactory : public GoalSelectorFactory {
133  public:
138 
147  virtual const char * name() const { return "mirror"; }
148 
156  virtual const char * description() const {
157  return "A goal selector. The goal an agent gets is the reflection " \
158  "of the agent's position across the world's origin over the "\
159  "world's x- and/or y-axes as specified.";
160  };
161 
162  protected:
168  GoalSelector * instance() const { return new MirrorGoalSelector(); }
169 
182  virtual bool setFromXML( GoalSelector * selector, TiXmlElement * node, const std::string & behaveFldr ) const;
183 
187  size_t _mirrorXID;
188 
192  size_t _mirrorYID;
193  };
194 
195  } // namespace BFSM
196 } // namespace Menge
197 
198 #endif // __GOAL_SELECTOR_MIRROR_H__
size_t _mirrorXID
The identifier for the "mirror_x" bool attribute.
Definition: GoalSelectorMirror.h:187
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.
virtual const char * description() const
A description of the goal selector.
Definition: GoalSelectorMirror.h:156
The base, abstract class defining goals.
Definition: Goal.h:110
void setMirrorY(bool mirror)
Sets the y-mirroring of the goal selector.
Definition: GoalSelectorMirror.h:99
bool _mirrorY
Determines if the agent's position is reflected over the y-axis (true) or not (false).
Definition: GoalSelectorMirror.h:126
size_t _mirrorYID
The identifier for the "mirror_y" bool attribute.
Definition: GoalSelectorMirror.h:192
bool getMirrorX() const
Returns the mirror x state.
Definition: GoalSelectorMirror.h:106
bool getMirrorY() const
Returns the mirror y state.
Definition: GoalSelectorMirror.h:113
The namespace contains the Behavior Finite State Machine (BFSM) definition.
Collection of convenient pre-compiler information for fsm definitions.
GoalSelector * instance() const
Create an instance of this class's goal selector.
Definition: GoalSelectorMirror.h:168
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
Defines the mechanism for selecting a goal for an agent.
The mirror goal selector makes a goal by reflecting the agent's position around the world's origin...
Definition: GoalSelectorMirror.h:63
The factory for parsing xml data and instantiating goals.
Factory for the MirrorGoalSelector.
Definition: GoalSelectorMirror.h:132
void setMirror(bool mirrorX, bool mirrorY)
Sets the mirroring of the goal selector.
Definition: GoalSelectorMirror.h:85
void setMirrorX(bool mirror)
Sets the x-mirroring of the goal selector.
Definition: GoalSelectorMirror.h:92
virtual const char * name() const
The name of the goal selector type.
Definition: GoalSelectorMirror.h:147
bool _mirrorX
Determines if the agent's position is reflected over the x-axis (true) or not (false).
Definition: GoalSelectorMirror.h:120
A class for parsing the xml description of a goal selector and instantiating particular instances...
Definition: GoalSelectorFactory.h:63