Stellarium 0.14.0
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  float getBrightness() const { return landscapeBrightness; }
88  float getEffectiveLightscapeBrightness() const { return lightScapeBrightness * illumFader.getInterstate(); }
89 
91  void setFlagShow(const bool b) {landFader=b;}
93  bool getFlagShow() const {return (bool)landFader;}
95  float getEffectiveLandFadeValue() { return landFader.getInterstate(); }
97  void setFlagShowFog(const bool b) {fogFader=b;}
99  bool getFlagShowFog() const {return (bool)fogFader;}
101  void setFlagShowIllumination(const bool b) {illumFader=b;}
103  bool getFlagShowIllumination() const {return (bool)illumFader;}
105  QString getName() const {return name;}
107  QString getAuthorName() const {return author;}
109  QString getDescription() const {return description;}
110 
112  const StelLocation& getLocation() const {return location;}
114  bool hasLocation() const {return (!(location.planetName.isEmpty()));}
129 
136  void setZRotation(float d) {angleRotateZOffset = d * M_PI/180.0f;}
137 
139  bool getIsFullyVisible() const {return landFader.getInterstate() >= 0.999f;}
140 
141  // GZ: NEW FUNCTION:
144  virtual float getOpacity(Vec3d azalt) const {return (azalt[2]<0 ? 1.0f : 0.0f); }
147  azDeg_altDeg = 0,
153  };
154 
155 protected:
159  void loadCommon(const QSettings& landscapeIni, const QString& landscapeId);
164  void createPolygonalHorizon(const QString& lineFileName, const float polyAngleRotateZ=0.0f, const QString &listMode="azDeg_altDeg");
165 
170  const QString getTexturePath(const QString& basename, const QString& landscapeId) const;
171  float radius;
172  QString name;
173  QString author;
174  QString description;
175 
183  int rows;
184  int cols;
185  float angleRotateZ;
187 
195 
196  // Optional elements which, if present, describe a horizon polygon. They can be used to render a line or a filled region, esp. in LandscapePolygonal
201 };
203 
220 {
221 public:
222  LandscapeOldStyle(float radius = 2.f);
223  virtual ~LandscapeOldStyle();
224  virtual void load(const QSettings& landscapeIni, const QString& landscapeId);
225  virtual void draw(StelCore* core);
226  //void create(bool _fullpath, QMap<QString, QString> param); // still not implemented
227  virtual float getOpacity(Vec3d azalt) const;
228 protected:
229  typedef struct
230  {
231  StelTextureSP tex;
232  StelTextureSP tex_illum; // optional light texture.
233  float texCoords[4];
235 
236 private:
237  void drawFog(StelCore* core, StelPainter&) const;
238  // drawLight==true for illumination layer, it then selects only the self-illuminating panels.
239  void drawDecor(StelCore* core, StelPainter&, const bool drawLight=false) const;
240  void drawGround(StelCore* core, StelPainter&) const;
241  QVector<double> groundVertexArr;
242  QVector<float> groundTexCoordArr;
243  StelTextureSP* sideTexs;
244  int nbSideTexs;
245  int nbSide;
246  landscapeTexCoord* sides;
247  StelTextureSP fogTex;
248  StelTextureSP groundTex;
249  QVector<QImage*> sidesImages; // Required for opacity lookup
250  int nbDecorRepeat;
251  float fogAltAngle;
252  float fogAngleShift;
253  float decorAltAngle; // vertical extent of the side panels
254  float decorAngleShift;
255  float groundAngleShift;
256  float groundAngleRotateZ;
257  int drawGroundFirst;
258  bool tanMode; // Whether the angles should be converted using tan instead of sin, i.e., for a cylindrical pano
259  bool calibrated; // if true, the documented altitudes are indeed correct (the original code is buggy!)
260  struct LOSSide
261  {
262  StelVertexArray arr;
263  StelTextureSP tex;
264  bool light; // GZ NEW: true if texture is self-lighting.
265  };
266 
267  QList<LOSSide> precomputedSides;
268 };
269 
280 {
281 public:
282  LandscapePolygonal(float radius = 1.f);
283  virtual ~LandscapePolygonal();
284  virtual void load(const QSettings& landscapeIni, const QString& landscapeId);
285  virtual void draw(StelCore* core);
286  virtual float getOpacity(Vec3d azalt) const;
287 private:
288  // we have inherited: horizonFileName, horizonPolygon, horizonPolygonLineColor
289  Vec3f groundColor;
290 };
291 
299 {
300 public:
301  LandscapeFisheye(float radius = 1.f);
302  virtual ~LandscapeFisheye();
303  virtual void load(const QSettings& landscapeIni, const QString& landscapeId);
304  virtual void draw(StelCore* core);
307  virtual float getOpacity(Vec3d azalt) const;
314  void create(const QString name, const QString& maptex, float texturefov, float angleRotateZ);
315  void create(const QString name, float texturefov, const QString& maptex, const QString &_maptexFog="", const QString& _maptexIllum="", const float angleRotateZ=0.0f);
316 private:
317 
318  StelTextureSP mapTex;
319  StelTextureSP mapTexFog;
320  StelTextureSP mapTexIllum;
322  QImage *mapImage;
324 
325  float texFov;
326 };
327 
339 {
340 public:
341  LandscapeSpherical(float radius = 1.f);
342  virtual ~LandscapeSpherical();
343  virtual void load(const QSettings& landscapeIni, const QString& landscapeId);
344  virtual void draw(StelCore* core);
348  virtual float getOpacity(Vec3d azalt) const;
360  void create(const QString name, const QString& maptex, const QString &_maptexFog="", const QString& _maptexIllum="", const float _angleRotateZ=0.0f,
361  const float _mapTexTop=90.0f, const float _mapTexBottom=-90.0f,
362  const float _fogTexTop=90.0f, const float _fogTexBottom=-90.0f,
363  const float _illumTexTop=90.0f, const float _illumTexBottom=-90.0f);
364 private:
365 
366  StelTextureSP mapTex;
367  StelTextureSP mapTexFog;
368  StelTextureSP mapTexIllum;
370  // 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°,
372  // light pollution may cover -5° (street lamps slightly below) plus parts of or even the whole sky. All have default values to simplify life.
373  float mapTexTop;
374  float mapTexBottom;
375  float fogTexTop;
376  float fogTexBottom;
377  float illumTexTop;
378  float illumTexBottom;
379  QImage *mapImage;
380 };
381 
382 #endif // _LANDSCAPE_HPP_
float getDefaultAtmosphericExtinction() const
Return default atmosperic extinction [mag/airmass], or -1 (no change)
Definition: Landscape.hpp:120
int rows
Used to slowly fade in/out illumination painting.
Definition: Landscape.hpp:183
bool getFlagShow() const
Get whether landscape is displayed (does not concern fog)
Definition: Landscape.hpp:93
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:190
float minBrightness
Read from landscape.ini:[landscape]description.
Definition: Landscape.hpp:176
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:191
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:116
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:192
QString description
Read from landscape.ini:[landscape]author.
Definition: Landscape.hpp:174
A shared pointer on a SphericalRegion.
Define the StelTextureSP type.
float getLightscapeBrightness() const
Returns the lightscape brightness.
Definition: Landscape.hpp:84
void setFlagShow(const bool b)
Set whether landscape is displayed (does not concern fog)
Definition: Landscape.hpp:91
This was the original landscape, introduced for decorative purposes.
Definition: Landscape.hpp:219
This uses a single image in fisheye projection.
Definition: Landscape.hpp:298
int cols
horizontal rows. May be given in landscape.ini:[landscape]tesselate_rows. More indicates higher accur...
Definition: Landscape.hpp:184
float getTargetLightscapeBrightness() const
Returns the lightscape brighness modulated with the fader's target state (i.e. binary on/off) ...
Definition: Landscape.hpp:86
QString author
Read from landscape.ini:[landscape]name.
Definition: Landscape.hpp:173
virtual void load(const QSettings &landscapeIni, const QString &landscapeId)
Load landscape.
azimuth[degrees] altitude[degrees]
Definition: Landscape.hpp:148
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:200
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:150
QString getDescription() const
Get landscape description.
Definition: Landscape.hpp:109
float defaultTemperature
May be given in landscape.ini:[location]atmospheric_extinction_coefficient. Default -1 (no change)...
Definition: Landscape.hpp:193
LinearFader fogFader
Used to slowly fade in/out landscape painting.
Definition: Landscape.hpp:181
float getDefaultAtmosphericTemperature() const
Return configured atmospheric temperature [degrees Celsius], for refraction computation, or -1000 for "unknown/no change".
Definition: Landscape.hpp:122
float landscapeBrightness
Read from landscape.ini:[landscape]minimal_brightness. Allows minimum visibility that cannot be under...
Definition: Landscape.hpp:177
float getBrightness() const
Returns the current brightness level.
Definition: Landscape.hpp:82
bool hasLocation() const
Return if the location is valid (a valid location has a valid planetName!)
Definition: Landscape.hpp:114
QString planetName
English planet name.
bool getIsFullyVisible() const
Get whether the landscape is currently fully visible (i.e. opaque).
Definition: Landscape.hpp:139
float getEffectiveLightscapeBrightness() const
Gets the currently effective lightscape brightness (modulated by the fader)
Definition: Landscape.hpp:88
bool getFlagShowIllumination() const
Get whether illumination is displayed.
Definition: Landscape.hpp:103
float lightScapeBrightness
brightness [0..1] to draw the landscape. Computed by the LandscapeMgr.
Definition: Landscape.hpp:178
This uses a single panorama image in spherical (equirectangular) projection.
Definition: Landscape.hpp:338
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:128
float angleRotateZOffset
[radians] if pano does not have its left border in the east, rotate in azimuth. Configured in landsca...
Definition: Landscape.hpp:186
QString getName() const
Get landscape name.
Definition: Landscape.hpp:105
LinearFader landFader
was a landscape loaded properly?
Definition: Landscape.hpp:180
int getDefaultFogSetting() const
Return default fog setting (0/1) or -1 (no change)
Definition: Landscape.hpp:118
LinearFader illumFader
Used to slowly fade in/out fog painting.
Definition: Landscape.hpp:182
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:197
azimuth[degrees] zenithDistance[degrees]
Definition: Landscape.hpp:149
This uses the list of (usually measured) horizon altitudes to define the horizon. ...
Definition: Landscape.hpp:279
azimuth[new_degrees] altitude[new_degrees] (may be found on theodolites)
Definition: Landscape.hpp:152
float defaultPressure
[Celsius] May be given in landscape.ini:[location]atmospheric_temperature. default: -1000...
Definition: Landscape.hpp:194
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:151
virtual float getOpacity(Vec3d azalt) const
can be used to find sunrise or visibility questions on the real-world landscape horizon.
Definition: Landscape.hpp:144
bool getFlagShowFog() const
Get whether fog is displayed.
Definition: Landscape.hpp:99
void setFlagShowFog(const bool b)
Set whether fog is displayed.
Definition: Landscape.hpp:97
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:101
void setZRotation(float d)
Set an additional z-axis (azimuth) rotation after landscape has been loaded.
Definition: Landscape.hpp:136
QSharedPointer< StelTexture > StelTextureSP
Use shared pointer to simplify memory managment.
float getDefaultAtmosphericPressure() const
Return configured atmospheric pressure [mbar], for refraction computation.
Definition: Landscape.hpp:125
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:112
StelLocation location
[radians] This is a rotation changeable at runtime via setZRotation (called by LandscapeMgr::setZRota...
Definition: Landscape.hpp:189
bool validLandscape
can be used to draw nightscape texture (e.g. city light pollution), if available. Computed by the Lan...
Definition: Landscape.hpp:179
QString getAuthorName() const
Get landscape author name.
Definition: Landscape.hpp:107
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:185
horizonListMode
The list of azimuths (counted from True North towards East) and altitudes can come in various formats...
Definition: Landscape.hpp:146
float getEffectiveLandFadeValue()
Returns the currently effective land fade value.
Definition: Landscape.hpp:95