QGIS API Documentation  3.24.2-Tisler (13c1a02865)
qgsrasterpyramid.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsrasterpyramid.h
3 
4  -------------------
5  begin : 2007
6  copyright : (C) 2007 by Gary E. Sherman
7  email : [email protected]
8 ***************************************************************************/
9 
10 /***************************************************************************
11  * *
12  * This program is free software; you can redistribute it and/or modify *
13  * it under the terms of the GNU General Public License as published by *
14  * the Free Software Foundation; either version 2 of the License, or *
15  * (at your option) any later version. *
16  * *
17  ***************************************************************************/
18 #ifndef QGSRASTERPYRAMID
19 #define QGSRASTERPYRAMID
20 
21 #include "qgis_core.h"
22 #include "qgis_sip.h"
23 
28 class CORE_EXPORT QgsRasterPyramid
29 {
30  public:
31 
32  //TODO QGIS 4.0 - rename get* to remove get prefix, and remove
33  //temporary SIP_PROPERTY definitions
34 
43  int getLevel() const { return mLevel; }
44 
53  void setLevel( int level ) { mLevel = level; }
54 
55 #ifdef SIP_RUN
56  SIP_PROPERTY( name = level, get = getLevel, set = setLevel )
57 #endif
58 
64  void setXDim( int dimension ) { mXDim = dimension; }
65 
71  int getXDim() const { return mXDim; }
72 
73 #ifdef SIP_RUN
74  SIP_PROPERTY( name = xDim, get = getXDim, set = setXDim )
75 #endif
76 
82  void setYDim( int dimension ) { mYDim = dimension; }
83 
89  int getYDim() const { return mYDim; }
90 
91 #ifdef SIP_RUN
92  SIP_PROPERTY( name = yDim, get = getYDim, set = setYDim )
93 #endif
94 
100  bool getExists() const { return mExists; }
101 
107  void setExists( bool exists ) { mExists = exists; }
108 
109 #ifdef SIP_RUN
110  SIP_PROPERTY( name = exists, get = getExists, set = setExists )
111 #endif
112 
121  bool getBuild() const { return mBuild; }
122 
132  void setBuild( bool build ) { mBuild = build; }
133 
134 #ifdef SIP_RUN
135  SIP_PROPERTY( name = build, get = getBuild, set = setBuild )
136 #endif
137 
138  private:
139 
141  int mLevel = 0;
143  int mXDim = 0;
145  int mYDim = 0;
147  bool mExists = false;
149  bool mBuild = false;
150 
151 };
152 #endif
This struct is used to store pyramid info for the raster layer.
void setBuild(bool build)
Sets whether the pyramid layer will be built.
int getLevel() const
Returns the pyramid level.
void setExists(bool exists)
Sets whether the pyramid layer currently exists.
void setYDim(int dimension)
Sets the y dimension for this pyramid layer.
bool getExists() const
Returns true if the pyramid layer currently exists.
bool getBuild() const
Returns true if the pyramid layer will be built.
void setLevel(int level)
Sets the pyramid level.
int getXDim() const
Returns the x dimension for this pyramid layer.
int getYDim() const
Returns the y dimension for this pyramid layer.
void setXDim(int dimension)
Sets the x dimension for this pyramid layer.
CORE_EXPORT QString build(const QVariantMap &map)
Build a hstore-formatted string from a QVariantMap.
#define SIP_PROPERTY(name, getter, setter)
Definition: qgis_sip.h:264