Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
GoalPoint.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_POINT_H__
45 #define __GOAL_POINT_H__
46 
47 #include "CoreConfig.h"
48 #include "fsmCommon.h"
49 #include "Goals/Goal.h"
50 #include "Goals/GoalFactory.h"
51 
52 namespace Menge {
53 
54  namespace BFSM {
58  class MENGE_API PointGoal : public Goal {
59  public:
63  PointGoal();
64 
71  virtual float squaredDistance( const Vector2 & pt ) const { return absSq( pt - _point ); }
72 
86  virtual void setDirections( const Vector2 & q, float r, Agents::PrefVelocity & directions ) const;
87 
103  virtual Vector2 getTargetPoint( const Vector2 & q, float r ) const { return _point; }
104 
108  virtual Vector2 getCentroid() const { return _point; }
109 
113  virtual void drawGL() const;
114 
120  void setPosition( const Vector2 & p ) { _point.set( p ); }
121 
128  void setPosition( float x, float y ) { _point.set( x, y ); }
129 
130  protected:
135  };
136 
140  class MENGE_API PointGoalFactory : public GoalFactory {
141  public:
146 
155  virtual const char * name() const { return "point"; }
156 
164  virtual const char * description() const {
165  return "An agent goal consisting of a single point in two-dimensional space";
166  };
167 
168  protected:
174  Goal * instance() const { return new PointGoal(); }
175 
188  virtual bool setFromXML( Goal * goal, TiXmlElement * node, const std::string & behaveFldr ) const;
189 
193  size_t _xID;
194 
198  size_t _yID;
199  };
200 
201  } // namespace BFSM
202 } // namespace Menge
203 
204 #endif // __GOAL_POINT_H__
A class for parsing the xml description of a goal and instantiating particular instances.
Definition: GoalFactory.h:62
Vector2 _point
The point for this goal.
Definition: GoalPoint.h:134
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
virtual const char * name() const
The name of the goal type.
Definition: GoalPoint.h:155
Sets up the proper compiler directives for platform and dll export/import.
Defines the goal classes for agent behaviors.
The base, abstract class defining goals.
Definition: Goal.h:110
size_t _xID
The identifier for the "x" float attribute.
Definition: GoalPoint.h:193
Goal * instance() const
Create an instance of this class's goal.
Definition: GoalPoint.h:174
size_t _yID
The identifier for the "y" float attribute.
Definition: GoalPoint.h:198
The namespace contains the Behavior Finite State Machine (BFSM) definition.
void setPosition(const Vector2 &p)
Sets the goal's position.
Definition: GoalPoint.h:120
Collection of convenient pre-compiler information for fsm definitions.
void setPosition(float x, float y)
Sets the goal's position.
Definition: GoalPoint.h:128
virtual const char * description() const
A description of the goal.
Definition: GoalPoint.h:164
The definition of a preferred velocity.
Definition: PrefVelocity.h:68
Factory for the PointGoal.
Definition: GoalPoint.h:140
virtual float squaredDistance(const Vector2 &pt) const
Reports the squared distance from the given point to the goal.
Definition: GoalPoint.h:71
virtual Vector2 getCentroid() const
Return the centroid of the goal.
Definition: GoalPoint.h:108
A simple point goal. The goal is trivially this point.
Definition: GoalPoint.h:58
virtual Vector2 getTargetPoint(const Vector2 &q, float r) const
Returns the closest "target" point in the goal to the given query point.
Definition: GoalPoint.h:103
The factory for parsing xml data and instantiating goals.