Landscape Class Reference

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

#include <Landscape.hpp>

List of all members.

Classes
struct	landscapeTexCoord
Public Member Functions
	Landscape (float _radius=2.f)
virtual void	load (const QSettings &landscapeIni, const QString &landscapeId)=0
virtual void	draw (StelCore *core)=0
void	update (double deltaTime)
void	setBrightness (const float b)
	Set the brightness of the landscape.
void	setFlagShow (const bool b)
	Set whether landscape is displayed (does not concern fog).
bool	getFlagShow () const
	Get whether landscape is displayed (does not concern fog).
void	setFlagShowFog (const bool b)
	Set whether fog is displayed.
bool	getFlagShowFog () const
	Get whether fog is displayed.
QString	getName () const
	Get landscape name.
QString	getAuthorName () const
	Get landscape author name.
QString	getDescription () const
	Get landscape description.
const StelLocation &	getLocation () const
	Return the associated location or NULL.
int	getDefaultBortleIndex () const
	Return default Bortle index (light pollution value) or -1 (unknown/no change).
int	getDefaultFogSetting () const
	Return default fog setting (0/1) or -1 (no change).
float	getDefaultAtmosphericExtinction () const
	Return default atmosperic extinction, mag/airmass, or -1 (no change).
float	getDefaultAtmosphericTemperature () const
	Return default atmospheric temperature, for refraction computation, or -1000 for "unknown/no change".
float	getDefaultAtmosphericPressure () const
	Return default atmospheric temperature, for refraction computation.
void	setZRotation (float d)
	Set the z-axis rotation (offset from original value when rotated.
Protected Member Functions
void	loadCommon (const QSettings &landscapeIni, const QString &landscapeId)
	Load attributes common to all landscapes.
const QString	getTexturePath (const QString &basename, const QString &landscapeId)
	search for a texture in landscape directory, else global textures directory
Protected Attributes
float	radius
QString	name
float	skyBrightness
float	nightBrightness
bool	validLandscape
LinearFader	landFader
LinearFader	fogFader
QString	author
QString	description
int	rows
int	cols
int	defaultBortleIndex
int	defaultFogSetting
double	defaultExtinctionCoefficient
double	defaultTemperature
double	defaultPressure
StelLocation	location
float	angleRotateZ
float	angleRotateZOffset

---

Detailed Description

Store and manages the displaying of the Landscape.

Don't use this class direcly, use the LandscapeMgr.

---

Member Function Documentation

QString Landscape::getAuthorName

(

)

const [inline]

Get landscape author name.

float Landscape::getDefaultAtmosphericExtinction

(

)

const [inline]

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

float Landscape::getDefaultAtmosphericPressure

(

)

const [inline]

Return default atmospheric temperature, for refraction computation.

returns -1 to signal "standard conditions", or -2 for "unknown/invalid/no change"

float Landscape::getDefaultAtmosphericTemperature

(

)

const [inline]

Return default atmospheric temperature, for refraction computation, or -1000 for "unknown/no change".

int Landscape::getDefaultBortleIndex

(

)

const [inline]

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

int Landscape::getDefaultFogSetting

(

)

const [inline]

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

QString Landscape::getDescription

(

)

const [inline]

Get landscape description.

bool Landscape::getFlagShow

(

)

const [inline]

Get whether landscape is displayed (does not concern fog).

bool Landscape::getFlagShowFog

(

)

const [inline]

Get whether fog is displayed.

const StelLocation& Landscape::getLocation

(

)

const [inline]

Return the associated location or NULL.

QString Landscape::getName

(

)

const [inline]

Get landscape name.

const QString Landscape::getTexturePath	(	const QString &	basename,
		const QString &	landscapeId
	)			[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

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

Load attributes common to all landscapes.

Parameters:

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

void Landscape::setBrightness

(

const float

b

)

[inline]

Set the brightness of the landscape.

void Landscape::setFlagShow

(

const bool

b

)

[inline]

Set whether landscape is displayed (does not concern fog).

void Landscape::setFlagShowFog

(

const bool

b

)

[inline]

Set whether fog is displayed.

void Landscape::setZRotation

(

float

d

)

[inline]

Set the z-axis rotation (offset from original value when rotated.