Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Watermark.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 __WATER_MARK_H__
45 #define __WATER_MARK_H__
46 
47 #include <string>
48 
49 // forward declaration
50 class TiXmlElement;
51 
52 namespace Menge {
53 
54  class Image;
55 
56  namespace Vis {
60  enum WatermarkAlign {
61  NO_ALIGN,
62  CENTERED,
63  BOTTOM_LEFT,
64  BOTTOM_RIGHT,
65  TOP_LEFT,
66  TOP_RIGHT
67  };
68 
74  class Watermark {
75  public:
79  Watermark();
80 
84  ~Watermark();
85 
89  const std::string & getFilename() const { return _fileName; }
90 
97  void drawGL( float w, float h ) const;
98 
99  friend Watermark * parseWatermark( TiXmlElement * node, const std::string & viewFldr );
100 
101  protected:
105  std::string _fileName;
106 
111 
115  WatermarkAlign _alignment;
116 
122  float _opacity;
123 
128  float _scale;
129  };
130 
139  Watermark * parseWatermark( TiXmlElement * node, const std::string & viewFldr );
140  } // namespace Vis
141 } // namespace Menge
142 #endif // __WATER_MARK_H__
const std::string & getFilename() const
Returns the file name for the water mark.
Definition: Watermark.h:89
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
The namespace containing visualization functionality for the pedestrian simulation.
Definition: GLViewer.h:64
void drawGL(float w, float h) const
Draws the watermark to the screen.
Definition: Watermark.cpp:97
Watermark()
Constructor.
Definition: Watermark.cpp:86
float _scale
The scale of the watermark. If the alignment is FULL_SCREEN, this can cause tiling.
Definition: Watermark.h:128
Image * _img
A pointer to the image the watermark uses.
Definition: Watermark.h:110
friend Watermark * parseWatermark(TiXmlElement *node, const std::string &viewFldr)
Parses a water mark xml specification and returns the corresponding instance.
Definition: Watermark.cpp:174
WatermarkAlign _alignment
The alignment of the watermark.
Definition: Watermark.h:115
float _opacity
The opacity of the watermark. Should be a value in the range [0, 1], where 0 is completely transparen...
Definition: Watermark.h:122
Wrapper for the managed ImageData.
Definition: image.h:175
A class for handling the watermark functionality.
Definition: Watermark.h:74
std::string _fileName
File name of the watermark.
Definition: Watermark.h:105
~Watermark()
Destructor.
Definition: Watermark.cpp:91