Stellarium 0.15.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 #include <QList>
35 #include <QFont>
36 
37 class QSettings;
38 class StelLocation;
39 class StelCore;
40 class StelPainter;
41 
62 class Landscape
63 {
64 public:
65  typedef struct
66  {
67  QString name;
68  Vec3d featurePoint; // start of the line: mountain peak, building, ...
69  Vec3d labelPoint; // end of the line, where the centered label best fits.
71 
72  Landscape(float _radius = 2.f);
73  virtual ~Landscape();
77  virtual void load(const QSettings& landscapeIni, const QString& landscapeId) = 0;
78  virtual void draw(StelCore* core) = 0;
79  void update(double deltaTime)
80  {
81  landFader.update((int)(deltaTime*1000));
82  fogFader.update((int)(deltaTime*1000));
83  illumFader.update((int)(deltaTime*1000));
84  labelFader.update((int)(deltaTime*1000));
85  }
86 
89  void setBrightness(const float b, const float pollutionBrightness=0.0f) {landscapeBrightness = b; lightScapeBrightness=pollutionBrightness; }
90 
92  float getBrightness() const { return landscapeBrightness; }
98  float getEffectiveLightscapeBrightness() const { return lightScapeBrightness * illumFader.getInterstate(); }
99 
101  void setFlagShow(const bool b) {landFader=b;}
103  bool getFlagShow() const {return (bool)landFader;}
105  float getEffectiveLandFadeValue() { return landFader.getInterstate(); }
107  void setFlagShowFog(const bool b) {fogFader=b;}
109  bool getFlagShowFog() const {return (bool)fogFader;}
111  void setFlagShowIllumination(const bool b) {illumFader=b;}
113  bool getFlagShowIllumination() const {return (bool)illumFader;}
115  void setFlagShowLabels(const bool b) {labelFader=b;}
117  bool getFlagShowLabels() const {return (bool)labelFader;}
119  void setLabelFontSize(const int size){fontSize=size;}
120 
122  QString getName() const {return name;}
124  QString getAuthorName() const {return author;}
126  QString getDescription() const {return description;}
127 
129  const StelLocation& getLocation() const {return location;}
131  bool hasLocation() const {return (!(location.planetName.isEmpty()));}
146 
153  void setZRotation(float d) {angleRotateZOffset = d * M_PI/180.0f;}
154 
156  bool getIsFullyVisible() const {return landFader.getInterstate() >= 0.999f;}
159 
163  // TBD: Maybe change this to azalt[2]<sinMinAltitudeLimit ? (But never called in practice, reimplemented by the subclasses...)
164  virtual float getOpacity(Vec3d azalt) const { Q_ASSERT(0); return (azalt[2]<0 ? 1.0f : 0.0f); }
167  azDeg_altDeg = 0,
173  };
174 
176  void loadLabels(const QString& landscapeId);
177 
178 protected:
182  void loadCommon(const QSettings& landscapeIni, const QString& landscapeId);
183 
185  void drawLabels(StelCore *core, StelPainter *painter);
186 
187 
192  void createPolygonalHorizon(const QString& lineFileName, const float polyAngleRotateZ=0.0f, const QString &listMode="azDeg_altDeg");
193 
198  const QString getTexturePath(const QString& basename, const QString& landscapeId) const;
199  float radius;
200  QString name;
201  QString author;
202  QString description;
203 
212  int rows;
213  int cols;
214  float angleRotateZ;
216 
219 
226 
227  // Optional elements which, if present, describe a horizon polygon. They can be used to render a line or a filled region, esp. in LandscapePolygonal
232  // Optional element: labels for landscape features.
234  QList<LandscapeLabel> landscapeLabels;
235  int fontSize;
237 };
238 
255 {
256 public:
257  LandscapeOldStyle(float radius = 2.f);
258  virtual ~LandscapeOldStyle();
259  virtual void load(const QSettings& landscapeIni, const QString& landscapeId);
260  virtual void draw(StelCore* core);
261  //void create(bool _fullpath, QMap<QString, QString> param); // still not implemented
262  virtual float getOpacity(Vec3d azalt) const;
263 protected:
264  typedef struct
265  {
266  StelTextureSP tex;
267  StelTextureSP tex_illum; // optional light texture.
268  float texCoords[4];
270 
271 private:
272  void drawFog(StelCore* core, StelPainter&) const;
273  // drawLight==true for illumination layer, it then selects only the self-illuminating panels.
274  void drawDecor(StelCore* core, StelPainter&, const bool drawLight=false) const;
275  void drawGround(StelCore* core, StelPainter&) const;
276  QVector<double> groundVertexArr;
277  QVector<float> groundTexCoordArr;
278  StelTextureSP* sideTexs;
279  int nbSideTexs;
280  int nbSide;
281  landscapeTexCoord* sides;
282  StelTextureSP fogTex;
283  StelTextureSP groundTex;
284  QVector<QImage*> sidesImages; // Required for opacity lookup
285  int nbDecorRepeat;
286  float fogAltAngle;
287  float fogAngleShift;
288  float decorAltAngle; // vertical extent of the side panels
289  float decorAngleShift;
290  float groundAngleShift;
291  float groundAngleRotateZ;
292  int drawGroundFirst;
293  bool tanMode; // Whether the angles should be converted using tan instead of sin, i.e., for a cylindrical pano
294  bool calibrated; // if true, the documented altitudes are indeed correct (the original code is buggy!)
295  struct LOSSide
296  {
297  StelVertexArray arr;
298  StelTextureSP tex;
299  bool light; // GZ NEW: true if texture is self-lighting.
300  };
301 
302  QList<LOSSide> precomputedSides;
303 };
304 
315 {
316 public:
317  LandscapePolygonal(float radius = 1.f);
318  virtual ~LandscapePolygonal();
319  virtual void load(const QSettings& landscapeIni, const QString& landscapeId);
320  virtual void draw(StelCore* core);
321  virtual float getOpacity(Vec3d azalt) const;
322 private:
323  // we have inherited: horizonFileName, horizonPolygon, horizonPolygonLineColor
324  Vec3f groundColor;
325 };
326 
334 {
335 public:
336  LandscapeFisheye(float radius = 1.f);
337  virtual ~LandscapeFisheye();
338  virtual void load(const QSettings& landscapeIni, const QString& landscapeId);
339  virtual void draw(StelCore* core);
342  virtual float getOpacity(Vec3d azalt) const;
349  void create(const QString name, const QString& maptex, float texturefov, float angleRotateZ);
350  void create(const QString name, float texturefov, const QString& maptex, const QString &_maptexFog="", const QString& _maptexIllum="", const float angleRotateZ=0.0f);
351 private:
352 
353  StelTextureSP mapTex;
354  StelTextureSP mapTexFog;
355  StelTextureSP mapTexIllum;
357  QImage *mapImage;
359 
360  float texFov;
361 };
362 
374 {
375 public:
376  LandscapeSpherical(float radius = 1.f);
377  virtual ~LandscapeSpherical();
378  virtual void load(const QSettings& landscapeIni, const QString& landscapeId);
379  virtual void draw(StelCore* core);
383  virtual float getOpacity(Vec3d azalt) const;
395  void create(const QString name, const QString& maptex, const QString &_maptexFog="", const QString& _maptexIllum="", const float _angleRotateZ=0.0f,
396  const float _mapTexTop=90.0f, const float _mapTexBottom=-90.0f,
397  const float _fogTexTop=90.0f, const float _fogTexBottom=-90.0f,
398  const float _illumTexTop=90.0f, const float _illumTexBottom=-90.0f);
399 private:
400 
401  StelTextureSP mapTex;
402  StelTextureSP mapTexFog;
403  StelTextureSP mapTexIllum;
405  // 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°,
407  // light pollution may cover -5° (street lamps slightly below) plus parts of or even the whole sky. All have default values to simplify life.
408  float mapTexTop;
409  float mapTexBottom;
410  float fogTexTop;
411  float fogTexBottom;
412  float illumTexTop;
413  float illumTexBottom;
414  QImage *mapImage;
415 };
416 
417 #endif // _LANDSCAPE_HPP_
float getDefaultAtmosphericExtinction() const
Return default atmosperic extinction [mag/airmass], or -1 (no change)
Definition: Landscape.hpp:137
int rows
Used to slowly fade in/out landscape feature labels.
Definition: Landscape.hpp:212
bool getFlagShow() const
Get whether landscape is displayed (does not concern fog)
Definition: Landscape.hpp:103
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:221
float minBrightness
Read from landscape.ini:[landscape]description.
Definition: Landscape.hpp:204
Store and manages the displaying of the Landscape.
Definition: Landscape.hpp:62
int defaultFogSetting
May be given in landscape.ini:[location]light_pollution. Default: -1 (no change). ...
Definition: Landscape.hpp:222
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:133
virtual void load(const QSettings &landscapeIni, const QString &landscapeId)
Load landscape.
virtual float getOpacity(Vec3d azalt) const
Find opacity in a certain direction.
float defaultExtinctionCoefficient
May be given in landscape.ini:[location]display_fog: -1(no change), 0(off), 1(on). Default: -1.
Definition: Landscape.hpp:223
QString description
Read from landscape.ini:[landscape]author.
Definition: Landscape.hpp:202
A shared pointer on a SphericalRegion.
Define the StelTextureSP type.
float getLightscapeBrightness() const
Returns the lightscape brightness.
Definition: Landscape.hpp:94
void setFlagShow(const bool b)
Set whether landscape is displayed (does not concern fog)
Definition: Landscape.hpp:101
This was the original landscape, introduced for decorative purposes.
Definition: Landscape.hpp:254
This uses a single image in fisheye projection.
Definition: Landscape.hpp:333
float sinMinAltitudeLimit
[radians] This is a rotation changeable at runtime via setZRotation (called by LandscapeMgr::setZRota...
Definition: Landscape.hpp:218
int cols
horizontal rows. May be given in landscape.ini:[landscape]tesselate_rows. More indicates higher accur...
Definition: Landscape.hpp:213
float getTargetLightscapeBrightness() const
Returns the lightscape brighness modulated with the fader's target state (i.e. binary on/off) ...
Definition: Landscape.hpp:96
QString author
Read from landscape.ini:[landscape]name.
Definition: Landscape.hpp:201
virtual void load(const QSettings &landscapeIni, const QString &landscapeId)
Load landscape.
Vec3f labelColor
Used for landscape labels (optionally indicating landscape features)
Definition: Landscape.hpp:236
azimuth[degrees] altitude[degrees]
Definition: Landscape.hpp:168
Main class for Stellarium core processing.
Definition: StelCore.hpp:48
void create(const QString name, const QString &maptex, float texturefov, float angleRotateZ)
create a fisheye landscape from basic parameters (no ini file needed).
bool getFlagShowLabels() const
Get whether labels are displayed.
Definition: Landscape.hpp:117
QList< LandscapeLabel > landscapeLabels
for all horizon types, the horizonPolygon line, if specified, will be drawn in this color ...
Definition: Landscape.hpp:234
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:231
void drawLabels(StelCore *core, StelPainter *painter)
Draw optional labels on the landscape.
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:170
QString getDescription() const
Get landscape description.
Definition: Landscape.hpp:126
float defaultTemperature
May be given in landscape.ini:[location]atmospheric_extinction_coefficient. Default -1 (no change)...
Definition: Landscape.hpp:224
LinearFader fogFader
Used to slowly fade in/out landscape painting.
Definition: Landscape.hpp:209
float getDefaultAtmosphericTemperature() const
Return configured atmospheric temperature [degrees Celsius], for refraction computation, or -1000 for "unknown/no change".
Definition: Landscape.hpp:139
float landscapeBrightness
Read from landscape.ini:[landscape]minimal_brightness. Allows minimum visibility that cannot be under...
Definition: Landscape.hpp:205
float getBrightness() const
Returns the current brightness level.
Definition: Landscape.hpp:92
bool hasLocation() const
Return if the location is valid (a valid location has a valid planetName!)
Definition: Landscape.hpp:131
LinearFader labelFader
Used to slowly fade in/out illumination painting.
Definition: Landscape.hpp:211
QString planetName
English planet name.
bool getIsFullyVisible() const
Get whether the landscape is currently fully visible (i.e. opaque).
Definition: Landscape.hpp:156
float getEffectiveLightscapeBrightness() const
Gets the currently effective lightscape brightness (modulated by the fader)
Definition: Landscape.hpp:98
bool getFlagShowIllumination() const
Get whether illumination is displayed.
Definition: Landscape.hpp:113
float lightScapeBrightness
brightness [0..1] to draw the landscape. Computed by the LandscapeMgr.
Definition: Landscape.hpp:206
This uses a single panorama image in spherical (equirectangular) projection.
Definition: Landscape.hpp:373
Provides functions for performing openGL drawing operations.
Definition: StelPainter.hpp:40
void setFlagShowLabels(const bool b)
Set whether labels are displayed.
Definition: Landscape.hpp:115
virtual float getOpacity(Vec3d azalt) const
Find opacity in a certain direction.
float getSinMinAltitudeLimit() const
Get the sine of the limiting altitude (can be used to short-cut drawing below horizon, like star fields). There is no set here, value is only from landscape.ini.
Definition: Landscape.hpp:158
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:145
float angleRotateZOffset
[radians] if pano does not have its left border in the east, rotate in azimuth. Configured in landsca...
Definition: Landscape.hpp:215
QString getName() const
Get landscape name.
Definition: Landscape.hpp:122
LinearFader landFader
was a landscape loaded properly?
Definition: Landscape.hpp:208
int getDefaultFogSetting() const
Return default fog setting (0/1) or -1 (no change)
Definition: Landscape.hpp:135
LinearFader illumFader
Used to slowly fade in/out fog painting.
Definition: Landscape.hpp:210
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:228
azimuth[degrees] zenithDistance[degrees]
Definition: Landscape.hpp:169
This uses the list of (usually measured) horizon altitudes to define the horizon. ...
Definition: Landscape.hpp:314
void loadLabels(const QString &landscapeId)
Load descriptive labels from optional file gazetteer.LANG.utf8.
void setLabelFontSize(const int size)
change font and fontsize for landscape labels
Definition: Landscape.hpp:119
azimuth[new_degrees] altitude[new_degrees] (may be found on theodolites)
Definition: Landscape.hpp:172
float defaultPressure
[Celsius] May be given in landscape.ini:[location]atmospheric_temperature. default: -1000...
Definition: Landscape.hpp:225
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:171
virtual float getOpacity(Vec3d azalt) const
Find opacity in a certain direction.
Definition: Landscape.hpp:164
bool getFlagShowFog() const
Get whether fog is displayed.
Definition: Landscape.hpp:109
void setFlagShowFog(const bool b)
Set whether fog is displayed.
Definition: Landscape.hpp:107
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:111
void setZRotation(float d)
Set an additional z-axis (azimuth) rotation after landscape has been loaded.
Definition: Landscape.hpp:153
QSharedPointer< StelTexture > StelTextureSP
Use shared pointer to simplify memory managment.
float getDefaultAtmosphericPressure() const
Return configured atmospheric pressure [mbar], for refraction computation.
Definition: Landscape.hpp:142
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:89
const StelLocation & getLocation() const
Return the associated location (may be empty!)
Definition: Landscape.hpp:129
StelLocation location
Minimal altitude of landscape cover. Can be used to construct bounding caps, so that e...
Definition: Landscape.hpp:220
bool validLandscape
can be used to draw nightscape texture (e.g. city light pollution), if available. Computed by the Lan...
Definition: Landscape.hpp:207
QString getAuthorName() const
Get landscape author name.
Definition: Landscape.hpp:124
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:214
horizonListMode
The list of azimuths (counted from True North towards East) and altitudes can come in various formats...
Definition: Landscape.hpp:166
float getEffectiveLandFadeValue()
Returns the currently effective land fade value.
Definition: Landscape.hpp:105