Store and manages the displaying of the Landscape. More...

#include <Landscape.hpp>

Inheritance diagram for Landscape:

Collaboration diagram for Landscape:

Classes
struct	LandscapeLabel

Public Types
enum	horizonListMode { azDeg_altDeg = 0, azDeg_zdDeg = 1, azRad_altRad = 2, azRad_zdRad = 3, azGrad_altGrad = 4, azGrad_zdGrad = 5 }
	The list of azimuths (counted from True North towards East) and altitudes can come in various formats. We read the first two elements, which can be of formats: More...

Public Member Functions
	Landscape (float _radius=2.f)

virtual void	load (const QSettings &landscapeIni, const QString &landscapeId)=0
	Load landscape. More...

virtual unsigned int	getMemorySize () const
	Return approximate memory footprint in bytes (required for cache cost estimate in LandscapeMgr) The returned value is only approximate, content of QStrings and other small containers like the horizon polygon are not put in in detail. More...

virtual void	draw (StelCore *core)=0

void	update (double deltaTime)

void	setBrightness (const float b, const float pollutionBrightness=0.0f)
	Set the brightness of the landscape plus brightness of optional add-on night lightscape. More...

float	getBrightness () const
	Returns the current brightness level. More...

float	getLightscapeBrightness () const
	Returns the lightscape brightness. More...

float	getTargetLightscapeBrightness () const
	Returns the lightscape brighness modulated with the fader's target state (i.e. binary on/off) More...

float	getEffectiveLightscapeBrightness () const
	Gets the currently effective lightscape brightness (modulated by the fader) More...

void	setFlagShow (const bool b)
	Set whether landscape is displayed (does not concern fog) More...

bool	getFlagShow () const
	Get whether landscape is displayed (does not concern fog) More...

float	getEffectiveLandFadeValue ()
	Returns the currently effective land fade value. More...

void	setFlagShowFog (const bool b)
	Set whether fog is displayed. More...

bool	getFlagShowFog () const
	Get whether fog is displayed. More...

void	setFlagShowIllumination (const bool b)
	Set whether illumination is displayed. More...

bool	getFlagShowIllumination () const
	Get whether illumination is displayed. More...

void	setFlagShowLabels (const bool b)
	Set whether labels are displayed. More...

bool	getFlagShowLabels () const
	Get whether labels are displayed. More...

void	setLabelFontSize (const int size)
	change font and fontsize for landscape labels More...

QString	getName () const
	Get landscape name. More...

QString	getAuthorName () const
	Get landscape author name. More...

QString	getDescription () const
	Get landscape description. More...

QString	getId () const
	Get landscape id. This is the landscape directory name, used for cache handling. More...

const StelLocation &	getLocation () const
	Return the associated location (may be empty!) More...

bool	hasLocation () const
	Return if the location is valid (a valid location has a valid planetName!) More...

int	getDefaultBortleIndex () const
	Return default Bortle index (light pollution value) or -1 (unknown/no change) More...

int	getDefaultFogSetting () const
	Return default fog setting (0/1) or -1 (no change) More...

float	getDefaultAtmosphericExtinction () const
	Return default atmosperic extinction [mag/airmass], or -1 (no change) More...

float	getDefaultAtmosphericTemperature () const
	Return configured atmospheric temperature [degrees Celsius], for refraction computation, or -1000 for "unknown/no change". More...

float	getDefaultAtmosphericPressure () const
	Return configured atmospheric pressure [mbar], for refraction computation. More...

float	getLandscapeMinimalBrightness () const
	Return minimal brightness for landscape returns -1 to signal "standard conditions" (use default value from config.ini) More...

void	setZRotation (float d)
	Set an additional z-axis (azimuth) rotation after landscape has been loaded. More...

bool	getIsFullyVisible () const
	Get whether the landscape is currently fully visible (i.e. opaque). More...

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. More...

virtual float	getOpacity (Vec3d azalt) const
	Find opacity in a certain direction. More...

void	loadLabels (const QString &landscapeId)
	Load descriptive labels from optional file gazetteer.LANG.utf8. More...

Protected Member Functions
void	loadCommon (const QSettings &landscapeIni, const QString &landscapeId)
	Load attributes common to all landscapes. More...

void	drawLabels (StelCore core, StelPainter painter)
	Draw optional labels on the landscape. More...

void	createPolygonalHorizon (const QString &lineFileName, const float polyAngleRotateZ=0.0f, const QString &listMode="azDeg_altDeg", const bool polygonInverted=false)
	Create a StelSphericalPolygon that describes a measured horizon line. More...

const QString	getTexturePath (const QString &basename, const QString &landscapeId) const
	search for a texture in landscape directory, else global textures directory More...

Protected Attributes
float	radius

QString	name

QString	author
	Read from landscape.ini:[landscape]name. More...

QString	description
	Read from landscape.ini:[landscape]author. More...

QString	id
	Read from landscape.ini:[landscape]description. More...

float	minBrightness
	Set during load. Required for consistent caching. More...

float	landscapeBrightness
	Read from landscape.ini:[landscape]minimal_brightness. Allows minimum visibility that cannot be underpowered. More...

float	lightScapeBrightness
	brightness [0..1] to draw the landscape. Computed by the LandscapeMgr. More...

bool	validLandscape
	can be used to draw nightscape texture (e.g. city light pollution), if available. Computed by the LandscapeMgr. More...

LinearFader	landFader
	was a landscape loaded properly? More...

LinearFader	fogFader
	Used to slowly fade in/out landscape painting. More...

LinearFader	illumFader
	Used to slowly fade in/out fog painting. More...

LinearFader	labelFader
	Used to slowly fade in/out illumination painting. More...

int	rows
	Used to slowly fade in/out landscape feature labels. More...

int	cols
	horizontal rows. May be given in landscape.ini:[landscape]tesselate_rows. More indicates higher accuracy, but is slower. More...

float	angleRotateZ
	vertical columns. May be given in landscape.ini:[landscape]tesselate_cols. More indicates higher accuracy, but is slower. More...

float	angleRotateZOffset
	[radians] if pano does not have its left border in the east, rotate in azimuth. Configured in landscape.ini[landscape]angle_rotatez (or decor_angle_rotatez for old_style landscapes) More...

float	sinMinAltitudeLimit
	[radians] This is a rotation changeable at runtime via setZRotation (called by LandscapeMgr::setZRotation). More...

StelLocation	location
	Minimal altitude of landscape cover. Can be used to construct bounding caps, so that e.g. no stars are drawn below this altitude. Default -0.035, i.e. sin(-2 degrees). More...

int	defaultBortleIndex
	OPTIONAL. If present, can be used to set location. More...

int	defaultFogSetting
	May be given in landscape.ini:[location]light_pollution. Default: -1 (no change). More...

float	defaultExtinctionCoefficient
	May be given in landscape.ini:[location]display_fog: -1(no change), 0(off), 1(on). Default: -1. More...

float	defaultTemperature
	May be given in landscape.ini:[location]atmospheric_extinction_coefficient. Default -1 (no change). More...

float	defaultPressure
	[Celsius] May be given in landscape.ini:[location]atmospheric_temperature. default: -1000.0 (no change) More...

SphericalRegionP	horizonPolygon
	[mbar] May be given in landscape.ini:[location]atmospheric_pressure. Default -1.0 (compute from [location]/altitude), use -2 to indicate "no change". More...

Vec3f	horizonPolygonLineColor
	Optional element describing the horizon line. More...

QList< LandscapeLabel >	landscapeLabels
	for all horizon types, the horizonPolygon line, if specified, will be drawn in this color More...

int	fontSize

Vec3f	labelColor
	Used for landscape labels (optionally indicating landscape features) More...

Detailed Description

Store and manages the displaying of the Landscape.

Don't use this class directly, use the LandscapeMgr. A landscape's most important element is a photo panorama, or at least a polygon that describes the true horizon visible from your observing location. Optional components include:

A fog texture that is displayed with the Fog [F] command (displayed only if atmosphere is on!).
A location. It is possible to auto-move to the location when loading.
Atmospheric conditions: temperature/pressure/extinction coefficients. These influence refraction and extinction.
Light pollution information (Bortle index)
A night texture that gets blended over the dimmed daylight panorama. (All landscapes except Polygonal.)
A polygonal horizon line (required for PolygonalLandscape). If present, defines a measured horizon line, which can be plotted or queried for rise/set predictions.
You can set a minimum brightness level to prevent too dark landscape. There is a global activation setting (config.ini[landscape]flag_minimal_brightness), a global value (config.ini[landscape]minimal_brightness), and, if config.ini[landscape]flag_landscape_sets_minimal_brightness=true, optional individual values given in landscape.ini[landscape]minimal_brightness are used.

We discern:

Parameters

LandscapeId	The directory name of the landscape.
name	The landscape name as specified in the LandscapeIni (may contain spaces, translatable, UTF8, ...)

Definition at line 62 of file Landscape.hpp.

Member Enumeration Documentation

enum Landscape::horizonListMode

The list of azimuths (counted from True North towards East) and altitudes can come in various formats. We read the first two elements, which can be of formats:

Enumerator
azDeg_zdDeg	azimuth[degrees] altitude[degrees]
azRad_altRad	azimuth[degrees] zenithDistance[degrees]
azRad_zdRad	azimuth[radians] altitude[radians]
azGrad_altGrad	azimuth[radians] zenithDistance[radians]
azGrad_zdGrad	azimuth[new_degrees] altitude[new_degrees] (may be found on theodolites)

Definition at line 175 of file Landscape.hpp.

Member Function Documentation

void Landscape::createPolygonalHorizon	(	const QString &	lineFileName,
		const float	polyAngleRotateZ = `0.0f`,
		const QString &	listMode = `"azDeg_altDeg"`,
		const bool	polygonInverted = `false`
	)

protected

Create a StelSphericalPolygon that describes a measured horizon line.

If present, this can be used to draw a horizon line or simplify the functionality to discern if an object is below the horizon.

Parameters

lineFileName	A text file with lines that are either empty or comment lines starting with # or azimuth altitude [degrees]
polyAngleRotateZ	possibility to set some final calibration offset like meridian convergence correction.
listMode	keys which indicate angular units for the angles
polygonInverted	Must be true to use horizons which are on average below mathematical horizon (Solution for bug LP:1554639)

void Landscape::drawLabels	(	StelCore *	core,
		StelPainter *	painter
	)

protected

Draw optional labels on the landscape.

QString Landscape::getAuthorName ( ) const

inline

Get landscape author name.

Definition at line 131 of file Landscape.hpp.

float Landscape::getBrightness ( ) const

inline

Returns the current brightness level.

Definition at line 99 of file Landscape.hpp.

float Landscape::getDefaultAtmosphericExtinction ( ) const

inline

Return default atmosperic extinction [mag/airmass], or -1 (no change)

Definition at line 146 of file Landscape.hpp.

float Landscape::getDefaultAtmosphericPressure ( ) const

inline

Return configured atmospheric pressure [mbar], for refraction computation.

returns -1 to signal "standard conditions" [compute from altitude], or -2 for "unknown/invalid/no change"

Definition at line 151 of file Landscape.hpp.

float Landscape::getDefaultAtmosphericTemperature ( ) const

inline

Return configured atmospheric temperature [degrees Celsius], for refraction computation, or -1000 for "unknown/no change".

Definition at line 148 of file Landscape.hpp.

int Landscape::getDefaultBortleIndex ( ) const

inline

Return default Bortle index (light pollution value) or -1 (unknown/no change)

Definition at line 142 of file Landscape.hpp.

int Landscape::getDefaultFogSetting ( ) const

inline

Return default fog setting (0/1) or -1 (no change)

Definition at line 144 of file Landscape.hpp.

QString Landscape::getDescription ( ) const

inline

Get landscape description.

Definition at line 133 of file Landscape.hpp.

float Landscape::getEffectiveLandFadeValue ( )

inline

Returns the currently effective land fade value.

Definition at line 112 of file Landscape.hpp.

float Landscape::getEffectiveLightscapeBrightness ( ) const

inline

Gets the currently effective lightscape brightness (modulated by the fader)

Definition at line 105 of file Landscape.hpp.

bool Landscape::getFlagShow ( ) const

inline

Get whether landscape is displayed (does not concern fog)

Definition at line 110 of file Landscape.hpp.

bool Landscape::getFlagShowFog ( ) const

inline

Get whether fog is displayed.

Definition at line 116 of file Landscape.hpp.

bool Landscape::getFlagShowIllumination ( ) const

inline

Get whether illumination is displayed.

Definition at line 120 of file Landscape.hpp.

bool Landscape::getFlagShowLabels ( ) const

inline

Get whether labels are displayed.

Definition at line 124 of file Landscape.hpp.

QString Landscape::getId ( ) const

inline

Get landscape id. This is the landscape directory name, used for cache handling.

Definition at line 135 of file Landscape.hpp.

bool Landscape::getIsFullyVisible ( ) const

inline

Get whether the landscape is currently fully visible (i.e. opaque).

Definition at line 165 of file Landscape.hpp.

float Landscape::getLandscapeMinimalBrightness ( ) const

inline

Return minimal brightness for landscape returns -1 to signal "standard conditions" (use default value from config.ini)

Definition at line 154 of file Landscape.hpp.

float Landscape::getLightscapeBrightness ( ) const

inline

Returns the lightscape brightness.

Definition at line 101 of file Landscape.hpp.

const StelLocation& Landscape::getLocation ( ) const

inline

Return the associated location (may be empty!)

Definition at line 138 of file Landscape.hpp.

virtual unsigned int Landscape::getMemorySize ( ) const

inlinevirtual

Return approximate memory footprint in bytes (required for cache cost estimate in LandscapeMgr) The returned value is only approximate, content of QStrings and other small containers like the horizon polygon are not put in in detail.

However, texture image sizes must be computed in subclasses. The value returned is a sum of RAM and texture memory requirements.

Reimplemented in LandscapeSpherical, LandscapeFisheye, LandscapePolygonal, and LandscapeOldStyle.

Definition at line 83 of file Landscape.hpp.

QString Landscape::getName ( ) const

inline

Get landscape name.

Definition at line 129 of file Landscape.hpp.

virtual float Landscape::getOpacity ( Vec3d azalt ) const

inlinevirtual

Find opacity in a certain direction.

(New in V0.13 series) can be used to find sunrise or visibility questions on the real-world landscape horizon. Default implementation indicates the horizon equals math horizon.

Reimplemented in LandscapeSpherical, LandscapeFisheye, LandscapePolygonal, and LandscapeOldStyle.

Definition at line 173 of file Landscape.hpp.

float Landscape::getSinMinAltitudeLimit ( ) const

inline

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 at line 167 of file Landscape.hpp.

float Landscape::getTargetLightscapeBrightness ( ) const

inline

Returns the lightscape brighness modulated with the fader's target state (i.e. binary on/off)

Definition at line 103 of file Landscape.hpp.

const QString Landscape::getTexturePath	(	const QString &	basename,
		const QString &	landscapeId
	)		const

protected

search for a texture in landscape directory, else global textures directory

Parameters

basename	The name of a texture file, e.g. "fog.png"
landscapeId	The landscape ID (directory name) to which the texture belongs

Exceptions

misc	possibility of throwing "file not found" exceptions

bool Landscape::hasLocation ( ) const

inline

Return if the location is valid (a valid location has a valid planetName!)

Definition at line 140 of file Landscape.hpp.

virtual void Landscape::load	(	const QSettings &	landscapeIni,
		const QString &	landscapeId
	)

pure virtual

Load landscape.

Parameters

landscapeIni	A reference to an existing QSettings object which describes the landscape
landscapeId	The name of the directory for the landscape files (e.g. "ocean")

Implemented in LandscapeSpherical, LandscapeFisheye, LandscapePolygonal, and LandscapeOldStyle.

void Landscape::loadCommon	(	const QSettings &	landscapeIni,
		const QString &	landscapeId
	)

protected

Load attributes common to all landscapes.

Parameters

landscapeIni	A reference to an existing QSettings object which describes the landscape
landscapeId	The name of the directory for the landscape files (e.g. "ocean")

void Landscape::loadLabels ( const QString & landscapeId )

Load descriptive labels from optional file gazetteer.LANG.utf8.

void Landscape::setBrightness	(	const float	b,
		const float	pollutionBrightness = `0.0f`
	)

inline

Set the brightness of the landscape plus brightness of optional add-on night lightscape.

This is called in each draw().

Definition at line 96 of file Landscape.hpp.

void Landscape::setFlagShow ( const bool b )

inline

Set whether landscape is displayed (does not concern fog)

Definition at line 108 of file Landscape.hpp.

void Landscape::setFlagShowFog ( const bool b )

inline

Set whether fog is displayed.

Definition at line 114 of file Landscape.hpp.

void Landscape::setFlagShowIllumination ( const bool b )

inline

Set whether illumination is displayed.

Definition at line 118 of file Landscape.hpp.

void Landscape::setFlagShowLabels ( const bool b )

inline

Set whether labels are displayed.

Definition at line 122 of file Landscape.hpp.

void Landscape::setLabelFontSize ( const int size )

inline

change font and fontsize for landscape labels

Definition at line 126 of file Landscape.hpp.

void Landscape::setZRotation ( float d )

inline

Set an additional z-axis (azimuth) rotation after landscape has been loaded.

This is intended for special uses such as when the landscape consists of a vehicle which might change orientation over time (e.g. a ship). It is called e.g. by the LandscapeMgr. Contrary to that, the purpose of the azimuth rotation (landscape/[decor_]angle_rotatez) in landscape.ini is to orient the pano.

Parameters

d	the rotation angle in degrees.

Definition at line 162 of file Landscape.hpp.

Member Data Documentation

float Landscape::angleRotateZ

protected

vertical columns. May be given in landscape.ini:[landscape]tesselate_cols. More indicates higher accuracy, but is slower.

Definition at line 226 of file Landscape.hpp.

float Landscape::angleRotateZOffset

protected

[radians] if pano does not have its left border in the east, rotate in azimuth. Configured in landscape.ini[landscape]angle_rotatez (or decor_angle_rotatez for old_style landscapes)

Definition at line 227 of file Landscape.hpp.

QString Landscape::author

protected

Read from landscape.ini:[landscape]name.

Definition at line 212 of file Landscape.hpp.

int Landscape::cols

protected

horizontal rows. May be given in landscape.ini:[landscape]tesselate_rows. More indicates higher accuracy, but is slower.

Definition at line 225 of file Landscape.hpp.

int Landscape::defaultBortleIndex

protected

OPTIONAL. If present, can be used to set location.

Definition at line 233 of file Landscape.hpp.

float Landscape::defaultExtinctionCoefficient

protected

May be given in landscape.ini:[location]display_fog: -1(no change), 0(off), 1(on). Default: -1.

Definition at line 235 of file Landscape.hpp.

int Landscape::defaultFogSetting

protected

May be given in landscape.ini:[location]light_pollution. Default: -1 (no change).

Definition at line 234 of file Landscape.hpp.

float Landscape::defaultPressure

protected

[Celsius] May be given in landscape.ini:[location]atmospheric_temperature. default: -1000.0 (no change)

Definition at line 237 of file Landscape.hpp.

float Landscape::defaultTemperature

protected

May be given in landscape.ini:[location]atmospheric_extinction_coefficient. Default -1 (no change).

Definition at line 236 of file Landscape.hpp.

QString Landscape::description

protected

Read from landscape.ini:[landscape]author.

Definition at line 213 of file Landscape.hpp.

LinearFader Landscape::fogFader

protected

Used to slowly fade in/out landscape painting.

Definition at line 221 of file Landscape.hpp.

SphericalRegionP Landscape::horizonPolygon

protected

[mbar] May be given in landscape.ini:[location]atmospheric_pressure. Default -1.0 (compute from [location]/altitude), use -2 to indicate "no change".

Definition at line 240 of file Landscape.hpp.

Vec3f Landscape::horizonPolygonLineColor

protected

Optional element describing the horizon line.

Data shall be read from the file given as landscape.ini[landscape]polygonal_horizon_list For LandscapePolygonal, this is the only horizon data item.

Definition at line 243 of file Landscape.hpp.

QString Landscape::id

protected

Read from landscape.ini:[landscape]description.

Definition at line 214 of file Landscape.hpp.

LinearFader Landscape::illumFader

protected

Used to slowly fade in/out fog painting.

Definition at line 222 of file Landscape.hpp.

Vec3f Landscape::labelColor

protected

Used for landscape labels (optionally indicating landscape features)

Definition at line 248 of file Landscape.hpp.

LinearFader Landscape::labelFader

protected

Used to slowly fade in/out illumination painting.

Definition at line 223 of file Landscape.hpp.

LinearFader Landscape::landFader

protected

was a landscape loaded properly?

Definition at line 220 of file Landscape.hpp.

float Landscape::landscapeBrightness

protected

Read from landscape.ini:[landscape]minimal_brightness. Allows minimum visibility that cannot be underpowered.

Definition at line 217 of file Landscape.hpp.

QList<LandscapeLabel> Landscape::landscapeLabels

protected

for all horizon types, the horizonPolygon line, if specified, will be drawn in this color

specified in landscape.ini[landscape]horizon_line_color. Negative red (default) indicated "don't draw".

Definition at line 246 of file Landscape.hpp.

float Landscape::lightScapeBrightness

protected

brightness [0..1] to draw the landscape. Computed by the LandscapeMgr.

Definition at line 218 of file Landscape.hpp.

StelLocation Landscape::location

protected

Minimal altitude of landscape cover. Can be used to construct bounding caps, so that e.g. no stars are drawn below this altitude. Default -0.035, i.e. sin(-2 degrees).

Definition at line 232 of file Landscape.hpp.

float Landscape::minBrightness

protected

Set during load. Required for consistent caching.

Definition at line 216 of file Landscape.hpp.

int Landscape::rows

protected

Used to slowly fade in/out landscape feature labels.

Definition at line 224 of file Landscape.hpp.

float Landscape::sinMinAltitudeLimit

protected

[radians] This is a rotation changeable at runtime via setZRotation (called by LandscapeMgr::setZRotation).

Not in landscape.ini: Used in special cases where the horizon may rotate, e.g. on a ship.

Definition at line 230 of file Landscape.hpp.

bool Landscape::validLandscape

protected

can be used to draw nightscape texture (e.g. city light pollution), if available. Computed by the LandscapeMgr.

Definition at line 219 of file Landscape.hpp.

The documentation for this class was generated from the following file:

/home/aw/devel/stellarium/0.15/src/core/modules/Landscape.hpp

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Member Data Documentation