Menge Plugin Examples
A Collection of Example Plugins for the Menge Framework
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
ElevationHeightField.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 
47 #ifndef __ELEVATION_HEIGHT_FIELD_H__
48 #define __ELEVATION_HEIGHT_FIELD_H__
49 
50 // Resources
51 #include "HeightField.h"
52 
53 // Menge Base
54 #include "Elevations/Elevation.h"
56 
57 // forward declaration
58 namespace Menge {
59  namespace Agents {
60  class BaseAgent;
61  }
62 }
63 
64 using namespace Menge;
65 
71 namespace Terrain {
72 
76  class EXPORT_API HeightFieldElevation : public Agents::Elevation {
77  public:
82 
90  virtual float getElevation( const Vector2 & point ) const;
91 
98  virtual float getElevation( const Agents::BaseAgent * agent ) const;
99 
107  virtual Vector2 getGradient( const Vector2 & point ) const;
108 
115  virtual Vector2 getGradient( const Agents::BaseAgent * agent ) const;
116 
122  void setHeightField( HeightFieldPtr hfPtr ) { _field = hfPtr; }
123 
124  protected:
129  };
130 
132 
136  class EXPORT_API HeightFieldElevationFactory : public Agents::ElevationFactory {
137  public:
142 
151  virtual const char * name() const { return "height_field"; }
152 
160  virtual const char * description() const {
161  return "Provides elevation based on location on a height field.";
162  };
163 
164  protected:
175  Agents::Elevation * instance() const { return new HeightFieldElevation(); }
176 
195  virtual bool setFromXML( Agents::Elevation * e, TiXmlElement * node, const std::string & specFldr ) const;
196 
200  size_t _fileNameID;
201  };
202 } // namespace Terrain
203 #endif // __ELEVATION_HEIGHT_FIELD_H__
204 
Definition of a height field based on a uniform discretization of space.
virtual const char * description() const
A description of the elevation.
Definition: ElevationHeightField.h:160
Factory for the HeightFieldElevation.
Definition: ElevationHeightField.h:136
Agents::Elevation * instance() const
Create an instance of this class's elevation implementation.
Definition: ElevationHeightField.h:175
HeightFieldPtr _field
The height field used to query elevation and gradient.
Definition: ElevationHeightField.h:128
void setHeightField(HeightFieldPtr hfPtr)
Sets the height field for this elevation object to use.
Definition: ElevationHeightField.h:122
virtual const char * name() const
The name of the elevation.
Definition: ElevationHeightField.h:151
size_t _fileNameID
The identifier for the "file_name" string attribute.
Definition: ElevationHeightField.h:200
Elevation definition based on a height field.
Definition: ElevationHeightField.h:76
The namespace containing the height field resource and Menge elements which use the height field...
Definition: ElevationHeightField.cpp:44