Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
VelModifierScale.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 
45 #ifndef __VEL_MOD_SCALE_H__
46 #define __VEL_MOD_SCALE_H__
47 
48 #include "CoreConfig.h"
49 #include "VelModifier.h"
50 #include "VelModifierContext.h"
51 #include "VelModifierFactory.h"
52 
53 namespace Menge {
54 
55  namespace BFSM {
56 
60  class MENGE_API ScaleVelModifier : public VelModifier {
61  public:
66 
72  ScaleVelModifier( const float scale );
73 
79  void setScale( const float scale );
80 
88  void adaptPrefVelocity(const Agents::BaseAgent * agent, Agents::PrefVelocity & pVel );
89 
95  float getScale() const { return _scale; }
96 
102  VelModifier * copy() const;
103 
109  virtual VelModContext * getContext(); //TODO: Implement the context
110 
111  friend class ScaleVMFactory;
112 
113  protected:
117  float _scale;
118 
119  };
120 
122 
126  //TODO: provide a context here
127  class MENGE_API ScaleVMContext : public VelModContext {
128  public:
136 
146  virtual std::string getUIText( const std::string & indent="" ) const;
147 
155  virtual void draw3DGL( const Agents::BaseAgent * agt);
156 
157  protected:
162  };
163 
165 
169  class MENGE_API ScaleVMFactory : public VelModFactory {
170  public:
174  ScaleVMFactory();
175 
184  virtual const char * name() const { return "scale"; }
185 
193  virtual const char * description() const {
194  return "Scales the input preferred velocity by the given scale factor.";
195  };
196 
197  protected:
208  VelModifier * instance() const { return new ScaleVelModifier(); }
209 
228  virtual bool setFromXML( VelModifier * vm, TiXmlElement * node, const std::string & behaveFldr ) const;
229 
230  // TODO: This should support a numerical distribution
234  size_t _scaleID;
235  };
236 
237  } // namespace BFSM
238 } // namespace Menge
239 #endif // __VEL_MOD_SCALE_H
VelModifier * instance() const
Create an instance of this class's velocity modifier.
Definition: VelModifierScale.h:208
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
A class for parsing the xml description of a velocity MODIFIER and instantiating particular instances...
Definition: VelModifierFactory.h:61
virtual const char * description() const
A description of the velocity modifier.
Definition: VelModifierScale.h:193
Sets up the proper compiler directives for platform and dll export/import.
The definition of a basic UI context for finite state machine velocity modifiers. ...
size_t _scaleID
The identifier for the "scale" float attribute.
Definition: VelModifierScale.h:234
virtual const char * name() const
The name of the velocity modifier.
Definition: VelModifierScale.h:184
Factory for the ScaleVelModifier.
Definition: VelModifierScale.h:169
The definition of how preferred velocity is modified by a filter.
ScaleVelModifier * _vm
The underlying finite state machine velocity modifier.
Definition: VelModifierScale.h:161
The context for the ScaleVelModifier.
Definition: VelModifierScale.h:127
float getScale() const
Returns scale factor.
Definition: VelModifierScale.h:95
A velocity modifier that scales the input velocity's speed.
Definition: VelModifierScale.h:60
The namespace contains the Behavior Finite State Machine (BFSM) definition.
The definition of a preferred velocity.
Definition: PrefVelocity.h:68
Defines the basic agent properties and functionality that all simulation agents share.
Definition: BaseAgent.h:123
The base class for modifying preferred velocities.
Definition: VelModifier.h:110
Base context for finite state machine velocity modifiers.
Definition: VelModifierContext.h:69
The factory for parsing xml data and instantiating velocity Modifierss.
float _scale
The scale factor to apply.
Definition: VelModifierScale.h:117