Stellarium 0.12.1
List of all members | Classes | Public Member Functions
Atmosphere Class Reference

Compute and display the daylight sky color. More...

#include <Atmosphere.hpp>

Public Member Functions

void computeColor (double JD, Vec3d _sunPos, Vec3d moonPos, float moonPhase, StelCore *core, float eclipseFac, float latitude=45.f, float altitude=200.f, float temperature=15.f, float relativeHumidity=40.f)
 Called on every update to recompute colors of the atmosphere. More...
 
void draw (StelCore *core, class StelRenderer *renderer)
 
void update (double deltaTime)
 
void setFadeDuration (float duration)
 Set fade in/out duration in seconds. More...
 
float getFadeDuration ()
 Get fade in/out duration in seconds. More...
 
void setFlagShow (bool b)
 Define whether to display atmosphere. More...
 
bool getFlagShow () const
 Get whether atmosphere is displayed. More...
 
float getRealDisplayIntensityFactor (void) const
 Get the actual atmosphere intensity due to eclipses + fader. More...
 
float getFadeIntensity (void) const
 
float getAverageLuminance (void) const
 Get the average luminance of the atmosphere in cd/m2 If atmosphere is off, the luminance includes the background starlight + light pollution. More...
 
void setLightPollutionLuminance (float f)
 Set the light pollution luminance in cd/m^2. More...
 
float getLightPollutionLuminance () const
 Get the light pollution luminance in cd/m^2. More...
 

Detailed Description

Compute and display the daylight sky color.

The sky brightness is computed with the SkyBright class, the color with the SkyLight. Don't use this class directly but use it through the LandscapeMgr.

Definition at line 40 of file Atmosphere.hpp.

Member Function Documentation

void Atmosphere::computeColor ( double  JD,
Vec3d  _sunPos,
Vec3d  moonPos,
float  moonPhase,
StelCore core,
float  eclipseFac,
float  latitude = 45.f,
float  altitude = 200.f,
float  temperature = 15.f,
float  relativeHumidity = 40.f 
)

Called on every update to recompute colors of the atmosphere.

Must be called at least once after a call to draw(), as vertexGrid is lazily initialized at the first draw call.

float Atmosphere::getAverageLuminance ( void  ) const
inline

Get the average luminance of the atmosphere in cd/m2 If atmosphere is off, the luminance includes the background starlight + light pollution.

Otherwise it includes the atmosphere + background starlight + eclipse factor + light pollution.

Returns
the last computed average luminance of the atmosphere in cd/m2.

Definition at line 77 of file Atmosphere.hpp.

float Atmosphere::getFadeDuration ( )
inline

Get fade in/out duration in seconds.

Definition at line 59 of file Atmosphere.hpp.

bool Atmosphere::getFlagShow ( ) const
inline

Get whether atmosphere is displayed.

Definition at line 64 of file Atmosphere.hpp.

float Atmosphere::getLightPollutionLuminance ( ) const
inline

Get the light pollution luminance in cd/m^2.

Definition at line 82 of file Atmosphere.hpp.

float Atmosphere::getRealDisplayIntensityFactor ( void  ) const
inline

Get the actual atmosphere intensity due to eclipses + fader.

Returns
the display intensity ranging from 0 to 1

Definition at line 68 of file Atmosphere.hpp.

void Atmosphere::setFadeDuration ( float  duration)
inline

Set fade in/out duration in seconds.

Definition at line 57 of file Atmosphere.hpp.

void Atmosphere::setFlagShow ( bool  b)
inline

Define whether to display atmosphere.

Definition at line 62 of file Atmosphere.hpp.

void Atmosphere::setLightPollutionLuminance ( float  f)
inline

Set the light pollution luminance in cd/m^2.

Definition at line 80 of file Atmosphere.hpp.


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