ShadedRelief.h
Go to the documentation of this file.
1 /* Copyright (C) 2008 National Institute For Space Research (INPE) - Brazil.
2 
3  This file is part of the TerraLib - a Framework for building GIS enabled applications.
4 
5  TerraLib is free software: you can redistribute it and/or modify
6  it under the terms of the GNU Lesser General Public License as published by
7  the Free Software Foundation, either version 3 of the License,
8  or (at your option) any later version.
9 
10  TerraLib is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  GNU Lesser General Public License for more details.
14 
15  You should have received a copy of the GNU Lesser General Public License
16  along with TerraLib. See COPYING. If not, write to
17  TerraLib Team at <terralib-team@terralib.org>.
18  */
19 
20 /*!
21  \file terralib/se/ShadedRelief.h
22 
23  \brief ShadedRelief specifies the application of relief shading (or "hill shading") to a DEM raster to give it somewhat of a three-dimensional effect and to make elevation changes more visible.
24 */
25 
26 #ifndef __TERRALIB_SE_INTERNAL_SHADEDRELIEF_H
27 #define __TERRALIB_SE_INTERNAL_SHADEDRELIEF_H
28 
29 // TerraLib
30 #include "Config.h"
31 
32 // Boost
33 #include <boost/noncopyable.hpp>
34 
35 namespace te
36 {
37  namespace se
38  {
39  /*!
40  \class ShadedRelief
41 
42  \brief ShadedRelief specifies the application of relief shading (or "hill shading") to a DEM raster to give it somewhat of a three-dimensional effect and to make elevation changes more visible.
43 
44  Exact parameters of the shading are system-dependent (for now).
45  If the BrightnessOnly flag is "0" or "false" (false, default),
46  the shading is applied to the layer being rendered as the current
47  RasterSymbolizer. If BrightnessOnly is "1" or "true" (true),
48  the shading is applied to the brightness of the colors
49  in the rendering canvas generated so far by other layers,
50  with the effect of relief-shading these other layers. The
51  default for BrightnessOnly is "0" (false). The ReliefFactor
52  gives the amount of exaggeration to use for the height of
53  the "hills". A value of around 55 (times) gives reasonable results
54  for Earth-based DEMs. The default value is system-dependent.
55 
56  \sa RasterSymbolizer
57  */
58  class TESEEXPORT ShadedRelief : public boost::noncopyable
59  {
60  public:
61 
62  /** @name Initializer Methods
63  * Methods related to instantiation and destruction.
64  */
65  //@{
66 
67  /*! \brief It initializes a new ShadedRelief. */
68  ShadedRelief();
69 
70  /*! \brief Destructor. */
71  ~ShadedRelief();
72 
73  //@}
74 
75  /** @name Accessor methods
76  * Methods used to get or set properties.
77  */
78  //@{
79 
80  /*! \Set brigtness parameter. */
81  void setBrightnessOnly(bool b);
82 
83  /*! \Get brigtness parameter. */
84  bool isBrightnessOnly() const;
85 
86  /*! \Set relief factor parameter. */
87  void setReliefFactor(const double& rf);
88 
89  /*! \Get relief factor parameter. */
90  double getReliefFactor() const;
91 
92  //@}
93 
94  /*! \brief It creates a new copy of this object. */
95  ShadedRelief* clone() const;
96 
97  private:
98 
99  bool m_brightnessOnly; //!< It may be 0 (false) or 1 (true). (Optional)
100  double m_reliefFactor; //!< It gives the amount of exaggeration to use for the height of the "hills". (Optional)
101  };
102 
103  } // end namespace se
104 } // end namespace te
105 
106 #endif // __TERRALIB_SE_INTERNAL_SHADEDRELIEF_H
URI C++ Library.
#define TESEEXPORT
You can use this macro in order to export/import classes and functions from this module.
Definition: Config.h:187
Configuration flags for the Symbology Encoding support of TerraLib.
double m_reliefFactor
It gives the amount of exaggeration to use for the height of the "hills". (Optional) ...
Definition: ShadedRelief.h:100
bool m_brightnessOnly
It may be 0 (false) or 1 (true). (Optional)
Definition: ShadedRelief.h:99
ShadedRelief specifies the application of relief shading (or "hill shading") to a DEM raster to give ...
Definition: ShadedRelief.h:58