Stellarium 0.13.2
Landscape.hpp
1 /*
2  * Stellarium
3  * Copyright (C) 2003 Fabien Chereau
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program 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 General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA 02110-1335, USA.
18  */
19 
20 #ifndef _LANDSCAPE_HPP_
21 #define _LANDSCAPE_HPP_
22 
23 #include "VecMath.hpp"
24 #include "StelToneReproducer.hpp"
25 #include "StelProjector.hpp"
26 
27 #include "StelFader.hpp"
28 #include "StelUtils.hpp"
29 #include "StelTextureTypes.hpp"
30 #include "StelLocation.hpp"
31 
32 #include <QMap>
33 #include <QImage>
34 
35 class QSettings;
36 class StelLocation;
37 class StelCore;
38 class StelPainter;
39 
60 class Landscape
61 {
62 public:
63  Landscape(float _radius = 2.f);
64  virtual ~Landscape();
68  virtual void load(const QSettings& landscapeIni, const QString& landscapeId) = 0;
69  virtual void draw(StelCore* core) = 0;
70  void update(double deltaTime)
71  {
72  landFader.update((int)(deltaTime*1000));
73  fogFader.update((int)(deltaTime*1000));
74  illumFader.update((int)(deltaTime*1000));
75  }
76 
79  void setBrightness(const float b, const float pollutionBrightness=0.0f) {landscapeBrightness = b; lightScapeBrightness=pollutionBrightness; }
80 
82  void setFlagShow(const bool b) {landFader=b;}
84  bool getFlagShow() const {return (bool)landFader;}
86  void setFlagShowFog(const bool b) {fogFader=b;}
88  bool getFlagShowFog() const {return (bool)fogFader;}
90  void setFlagShowIllumination(const bool b) {illumFader=b;}
92  bool getFlagShowIllumination() const {return (bool)illumFader;}
94  QString getName() const {return name;}
96  QString getAuthorName() const {return author;}
98  QString getDescription() const {return description;}
99 
101  const StelLocation& getLocation() const {return location;}
103  bool hasLocation() const {return (location.planetName.length() > 0);}
118 
125  void setZRotation(float d) {angleRotateZOffset = d * M_PI/180.0f;}
126 
128  bool getIsFullyVisible() const {return landFader.getInterstate() >= 0.999f;}
129 
130  // GZ: NEW FUNCTION:
133  virtual float getOpacity(Vec3d azalt) const {return (azalt[2]<0 ? 1.0f : 0.0f); }
136  azDeg_altDeg = 0,
142  };
143 
144 protected:
148  void loadCommon(const QSettings& landscapeIni, const QString& landscapeId);
153  void createPolygonalHorizon(const QString& lineFileName, const float polyAngleRotateZ=0.0f, const QString &listMode="azDeg_altDeg");
154 
159  const QString getTexturePath(const QString& basename, const QString& landscapeId) const;
160  float radius;
161  QString name;
162  QString author;
163  QString description;
164 
172  int rows;
173  int cols;
174  float angleRotateZ;
176 
184 
185  // Optional elements which, if present, describe a horizon polygon. They can be used to render a line or a filled region, esp. in LandscapePolygonal
190 };
192 
209 {
210 public:
211  LandscapeOldStyle(float radius = 2.f);
212  virtual ~LandscapeOldStyle();
213  virtual void load(const QSettings& landscapeIni, const QString& landscapeId);
214  virtual void draw(StelCore* core);
215  //void create(bool _fullpath, QMap<QString, QString> param); // still not implemented
216  virtual float getOpacity(Vec3d azalt) const;
217 protected:
218  typedef struct
219  {
220  StelTextureSP tex;
221  StelTextureSP tex_illum; // optional light texture.
222  float texCoords[4];
224 
225 private:
226  void drawFog(StelCore* core, StelPainter&) const;
227  // drawLight==true for illumination layer, it then selects only the self-illuminating panels.
228  void drawDecor(StelCore* core, StelPainter&, const bool drawLight=false) const;
229  void drawGround(StelCore* core, StelPainter&) const;
230  QVector<double> groundVertexArr;
231  QVector<float> groundTexCoordArr;
232  StelTextureSP* sideTexs;
233  int nbSideTexs;
234  int nbSide;
235  landscapeTexCoord* sides;
236  StelTextureSP fogTex;
237  StelTextureSP groundTex;
238  QVector<QImage*> sidesImages; // Required for opacity lookup
239  int nbDecorRepeat;
240  float fogAltAngle;
241  float fogAngleShift;
242  float decorAltAngle; // vertical extent of the side panels
243  float decorAngleShift;
244  float groundAngleShift;
245  float groundAngleRotateZ;
246  int drawGroundFirst;
247  bool tanMode; // Whether the angles should be converted using tan instead of sin, i.e., for a cylindrical pano
248  bool calibrated; // if true, the documented altitudes are indeed correct (the original code is buggy!)
249  struct LOSSide
250  {
251  StelVertexArray arr;
252  StelTextureSP tex;
253  bool light; // GZ NEW: true if texture is self-lighting.
254  };
255 
256  QList<LOSSide> precomputedSides;
257 };
258 
269 {
270 public:
271  LandscapePolygonal(float radius = 1.f);
272  virtual ~LandscapePolygonal();
273  virtual void load(const QSettings& landscapeIni, const QString& landscapeId);
274  virtual void draw(StelCore* core);
275  virtual float getOpacity(Vec3d azalt) const;
276 private:
277  // we have inherited: horizonFileName, horizonPolygon, horizonPolygonLineColor
278  Vec3f groundColor;
279 };
280 
288 {
289 public:
290  LandscapeFisheye(float radius = 1.f);
291  virtual ~LandscapeFisheye();
292  virtual void load(const QSettings& landscapeIni, const QString& landscapeId);
293  virtual void draw(StelCore* core);
296  virtual float getOpacity(Vec3d azalt) const;
303  void create(const QString name, const QString& maptex, float texturefov, float angleRotateZ);
304  void create(const QString name, float texturefov, const QString& maptex, const QString &_maptexFog="", const QString& _maptexIllum="", const float angleRotateZ=0.0f);
305 private:
306 
307  StelTextureSP mapTex;
308  StelTextureSP mapTexFog;
309  StelTextureSP mapTexIllum;
311  QImage *mapImage;
313 
314  float texFov;
315 };
316 
328 {
329 public:
330  LandscapeSpherical(float radius = 1.f);
331  virtual ~LandscapeSpherical();
332  virtual void load(const QSettings& landscapeIni, const QString& landscapeId);
333  virtual void draw(StelCore* core);
337  virtual float getOpacity(Vec3d azalt) const;
349  void create(const QString name, const QString& maptex, const QString &_maptexFog="", const QString& _maptexIllum="", const float _angleRotateZ=0.0f,
350  const float _mapTexTop=90.0f, const float _mapTexBottom=-90.0f,
351  const float _fogTexTop=90.0f, const float _fogTexBottom=-90.0f,
352  const float _illumTexTop=90.0f, const float _illumTexBottom=-90.0f);
353 private:
354 
355  StelTextureSP mapTex;
356  StelTextureSP mapTexFog;
357  StelTextureSP mapTexIllum;
359  // These vars are here to conserve texture memory. They must be allowed to be different: a landscape may have its highest elevations at 15°, fog may reach from -25 to +15°,
361  // light pollution may cover -5° (street lamps slightly below) plus parts of or even the whole sky. All have default values to simplify life.
362  float mapTexTop;
363  float mapTexBottom;
364  float fogTexTop;
365  float fogTexBottom;
366  float illumTexTop;
367  float illumTexBottom;
368  QImage *mapImage;
369 };
370 
371 #endif // _LANDSCAPE_HPP_
float getDefaultAtmosphericExtinction() const
Return default atmosperic extinction [mag/airmass], or -1 (no change)
Definition: Landscape.hpp:109
int rows
Used to slowly fade in/out illumination painting.
Definition: Landscape.hpp:172
bool getFlagShow() const
Get whether landscape is displayed (does not concern fog)
Definition: Landscape.hpp:84
Store the informations for a location on a planet.
virtual float getOpacity(Vec3d azalt) const
Sample landscape texture for transparency/opacity.
int defaultBortleIndex
OPTIONAL. If present, can be used to set location.
Definition: Landscape.hpp:179
float minBrightness
Read from landscape.ini:[landscape]description.
Definition: Landscape.hpp:165
Store and manages the displaying of the Landscape.
Definition: Landscape.hpp:60
int defaultFogSetting
May be given in landscape.ini:[location]light_pollution. Default: -1 (no change). ...
Definition: Landscape.hpp:180
Implementation of StelFader which implements a linear transition.
Definition: StelFader.hpp:77
int getDefaultBortleIndex() const
Return default Bortle index (light pollution value) or -1 (unknown/no change)
Definition: Landscape.hpp:105
virtual void load(const QSettings &landscapeIni, const QString &landscapeId)
Load landscape.
virtual float getOpacity(Vec3d azalt) const
can be used to find sunrise or visibility questions on the real-world landscape horizon.
float defaultExtinctionCoefficient
May be given in landscape.ini:[location]display_fog: -1(no change), 0(off), 1(on). Default: -1.
Definition: Landscape.hpp:181
QString description
Read from landscape.ini:[landscape]author.
Definition: Landscape.hpp:163
A shared pointer on a SphericalRegion.
Define the StelTextureSP type.
void setFlagShow(const bool b)
Set whether landscape is displayed (does not concern fog)
Definition: Landscape.hpp:82
This was the original landscape, introduced for decorative purposes.
Definition: Landscape.hpp:208
This uses a single image in fisheye projection.
Definition: Landscape.hpp:287
int cols
horizontal rows. May be given in landscape.ini:[landscape]tesselate_rows. More indicates higher accur...
Definition: Landscape.hpp:173
QString author
Read from landscape.ini:[landscape]name.
Definition: Landscape.hpp:162
virtual void load(const QSettings &landscapeIni, const QString &landscapeId)
Load landscape.
azimuth[degrees] altitude[degrees]
Definition: Landscape.hpp:137
Main class for Stellarium core processing.
Definition: StelCore.hpp:46
void create(const QString name, const QString &maptex, float texturefov, float angleRotateZ)
create a fisheye landscape from basic parameters (no ini file needed).
void loadCommon(const QSettings &landscapeIni, const QString &landscapeId)
Load attributes common to all landscapes.
Vec3f horizonPolygonLineColor
Optional element describing the horizon line.
Definition: Landscape.hpp:189
void create(const QString name, const QString &maptex, const QString &_maptexFog="", const QString &_maptexIllum="", const float _angleRotateZ=0.0f, const float _mapTexTop=90.0f, const float _mapTexBottom=-90.0f, const float _fogTexTop=90.0f, const float _fogTexBottom=-90.0f, const float _illumTexTop=90.0f, const float _illumTexBottom=-90.0f)
create a spherical landscape from basic parameters (no ini file needed).
azimuth[radians] altitude[radians]
Definition: Landscape.hpp:139
QString getDescription() const
Get landscape description.
Definition: Landscape.hpp:98
float defaultTemperature
May be given in landscape.ini:[location]atmospheric_extinction_coefficient. Default -1 (no change)...
Definition: Landscape.hpp:182
LinearFader fogFader
Used to slowly fade in/out landscape painting.
Definition: Landscape.hpp:170
float getDefaultAtmosphericTemperature() const
Return configured atmospheric temperature [degrees Celsius], for refraction computation, or -1000 for "unknown/no change".
Definition: Landscape.hpp:111
float landscapeBrightness
Read from landscape.ini:[landscape]minimal_brightness. Allows minimum visibility that cannot be under...
Definition: Landscape.hpp:166
bool hasLocation() const
Return if the location is valid (a valid location has a valid planetName!)
Definition: Landscape.hpp:103
QString planetName
English planet name.
bool getIsFullyVisible() const
Get whether the landscape is currently fully visible (i.e. opaque).
Definition: Landscape.hpp:128
bool getFlagShowIllumination() const
Get whether illumination is displayed.
Definition: Landscape.hpp:92
float lightScapeBrightness
brightness [0..1] to draw the landscape. Computed by the LandscapeMgr.
Definition: Landscape.hpp:167
This uses a single panorama image in spherical (equirectangular) projection.
Definition: Landscape.hpp:327
Provides functions for performing openGL drawing operations.
Definition: StelPainter.hpp:40
virtual float getOpacity(Vec3d azalt) const
can be used to find sunrise or visibility questions on the real-world landscape horizon.
virtual void load(const QSettings &landscapeIni, const QString &landscapeId)=0
Load landscape.
float getLandscapeMinimalBrightness() const
Return minimal brightness for landscape returns -1 to signal "standard conditions" (use default value...
Definition: Landscape.hpp:117
float angleRotateZOffset
[radians] if pano does not have its left border in the east, rotate in azimuth. Configured in landsca...
Definition: Landscape.hpp:175
QString getName() const
Get landscape name.
Definition: Landscape.hpp:94
LinearFader landFader
was a landscape loaded properly?
Definition: Landscape.hpp:169
int getDefaultFogSetting() const
Return default fog setting (0/1) or -1 (no change)
Definition: Landscape.hpp:107
LinearFader illumFader
Used to slowly fade in/out fog painting.
Definition: Landscape.hpp:171
virtual void load(const QSettings &landscapeIni, const QString &landscapeId)
Load landscape.
SphericalRegionP horizonPolygon
[mbar] May be given in landscape.ini:[location]atmospheric_pressure. Default -1.0 (compute from [loca...
Definition: Landscape.hpp:186
azimuth[degrees] zenithDistance[degrees]
Definition: Landscape.hpp:138
This uses the list of (usually measured) horizon altitudes to define the horizon. ...
Definition: Landscape.hpp:268
azimuth[new_degrees] altitude[new_degrees] (may be found on theodolites)
Definition: Landscape.hpp:141
float defaultPressure
[Celsius] May be given in landscape.ini:[location]atmospheric_temperature. default: -1000...
Definition: Landscape.hpp:183
virtual void load(const QSettings &landscapeIni, const QString &landscapeId)
Load landscape.
virtual float getOpacity(Vec3d azalt) const
Sample landscape texture for transparency/opacity.
azimuth[radians] zenithDistance[radians]
Definition: Landscape.hpp:140
virtual float getOpacity(Vec3d azalt) const
can be used to find sunrise or visibility questions on the real-world landscape horizon.
Definition: Landscape.hpp:133
bool getFlagShowFog() const
Get whether fog is displayed.
Definition: Landscape.hpp:88
void setFlagShowFog(const bool b)
Set whether fog is displayed.
Definition: Landscape.hpp:86
const QString getTexturePath(const QString &basename, const QString &landscapeId) const
search for a texture in landscape directory, else global textures directory
void setFlagShowIllumination(const bool b)
Set whether illumination is displayed.
Definition: Landscape.hpp:90
void setZRotation(float d)
Set an additional z-axis (azimuth) rotation after landscape has been loaded.
Definition: Landscape.hpp:125
QSharedPointer< StelTexture > StelTextureSP
Use shared pointer to simplify memory managment.
float getDefaultAtmosphericPressure() const
Return configured atmospheric pressure [mbar], for refraction computation.
Definition: Landscape.hpp:114
void setBrightness(const float b, const float pollutionBrightness=0.0f)
Set the brightness of the landscape plus brightness of optional add-on night lightscape.
Definition: Landscape.hpp:79
const StelLocation & getLocation() const
Return the associated location (may be empty!)
Definition: Landscape.hpp:101
StelLocation location
[radians] This is a rotation changeable at runtime via setZRotation (called by LandscapeMgr::setZRota...
Definition: Landscape.hpp:178
bool validLandscape
can be used to draw nightscape texture (e.g. city light pollution), if available. Computed by the Lan...
Definition: Landscape.hpp:168
QString getAuthorName() const
Get landscape author name.
Definition: Landscape.hpp:96
void createPolygonalHorizon(const QString &lineFileName, const float polyAngleRotateZ=0.0f, const QString &listMode="azDeg_altDeg")
Create a StelSphericalPolygon that describes a measured horizon line.
float angleRotateZ
vertical columns. May be given in landscape.ini:[landscape]tesselate_cols. More indicates higher accu...
Definition: Landscape.hpp:174
horizonListMode
The list of azimuths (counted from True North towards East) and altitudes can come in various formats...
Definition: Landscape.hpp:135