Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
VectorField.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 __VECTOR_FIELD_H__
45 #define __VECTOR_FIELD_H__
46 
47 // A 2D vector field
48 // The field itself need not be square, but the cells are.
49 // STL
50 #include <string>
51 #include <map>
52 #include "Resource.h"
53 #include "mengeCommon.h"
54 
55 namespace Menge {
56 
63  class MENGE_API VectorField : public Resource {
64  public:
70  VectorField( const std::string & fileName );
71 
72  protected:
76  virtual ~VectorField();
77 
78  public:
79 
85  virtual const std::string & getLabel() const { return LABEL; }
86 
98  void getCell( const Vector2 & pos, int & r, int & c );
99 
109  Vector2 getFieldValue( int row, int col ) const;
110 
121  Vector2 getFieldValue( const Vector2 & pos );
122 
133  Vector2 getFieldValueInterp( const Vector2 & pos );
134 
147  static Resource * load( const std::string & fileName );
148 
154  Vector2 getMinimumPoint() const { return _minPoint; }
155 
161  Vector2 getMaximumPoint() const;
162 
168  Vector2 getSize() const;
169 
175  inline int getRowCount() const { return _resolution[0]; }
176 
182  inline int getColCount() const { return _resolution[1]; }
183 
189  inline float getCellSize() const { return _cellSize; }
190 
199  friend Logger & operator<< ( Logger & out, const VectorField & vf );
200 
205  static const std::string LABEL;
206 
207  protected:
212 
216  int _resolution[2];
217 
221  float _cellSize;
222 
227 
239  void setDimensions( float width, float height );
240 
244  void initDataArray();
245 
249  void freeDataArray();
250  };
251 
256 
264  VectorFieldPtr loadVectorField( const std::string & fileName ) throw ( ResourceException );
265 } // namespace Menge
266 
267 #endif // __VECTOR_FIELD_H__
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
Logger & operator<<(Logger &out, const BFSM::PropertyOperand op)
Friend function for printing string versions of the PropertyOperand enum.
Definition: FSMEnumeration.cpp:43
int getColCount() const
Reports the number of columns in the field.
Definition: VectorField.h:182
Vector2 _minPoint
The minimum extent of the vector field.
Definition: VectorField.h:211
Basic class for managing on-disk resources.
Definition: Resource.h:98
static const std::string LABEL
The unique label for this data type to be used with resource management.
Definition: VectorField.h:205
Vector2 getMinimumPoint() const
Reports the minimum extent of the field.
Definition: VectorField.h:154
int getRowCount() const
Reports the number of rows in the field.
Definition: VectorField.h:175
A base exception for resources to throw.
Definition: Resource.h:58
An html logger - writes messages to a formatted html file.
Definition: Logger.h:59
virtual const std::string & getLabel() const
Returns a unique resource label to be used to identify different resource types which use the same un...
Definition: VectorField.h:85
VectorFieldPtr loadVectorField(const std::string &fileName)
Loads the vector field of the given name.
Definition: VectorField.cpp:254
Vector2 ** _data
The 2D array of vector data for each cell.
Definition: VectorField.h:226
float _cellSize
Size of the grid cell.
Definition: VectorField.h:221
float getCellSize() const
Reports the number of rows in the field.
Definition: VectorField.h:189
The basic class for all on-disk resources.
ResourcePtr< VectorField > VectorFieldPtr
forward declaration of VectorField resource pointer. see VectorField.h for more details ...
Definition: VelCompVF.h:59
A simple 2D vector field.
Definition: VectorField.h:63