Stellarium 0.13.2
List of all members | Public Slots | Signals | Public Member Functions | Static Public Member Functions | Properties
StelApp Class Reference

Singleton main Stellarium application class. More...

#include <StelApp.hpp>

Public Slots

void setVisionModeNight (bool)
 Set flag for activating night vision mode. More...
 
bool getVisionModeNight () const
 Get flag for activating night vision mode. More...
 
float getFps () const
 Get the current number of frame per second. More...
 
static double getTotalRunTime ()
 Return the time since when stellarium is running in second. More...
 
void reportFileDownloadFinished (QNetworkReply *reply)
 Report that a download occured. More...
 
void quit ()
 do some cleanup and call QCoreApplication::exit(0) More...
 

Signals

void visionNightModeChanged (bool)
 
void colorSchemeChanged (const QString &)
 
void languageChanged ()
 
void skyCultureChanged (const QString &)
 
void progressBarAdded (const StelProgressController *)
 Called just after a progress bar is added. More...
 
void progressBarRemoved (const StelProgressController *)
 Called just before a progress bar is removed. More...
 
void aboutToQuit ()
 Called just before we exit Qt mainloop. More...
 

Public Member Functions

 StelApp (QObject *parent=NULL)
 Create and initialize the main Stellarium application. More...
 
virtual ~StelApp ()
 Deinitialize and destroy the main Stellarium application. More...
 
void init (QSettings *conf)
 Initialize core and all the modules. More...
 
void deinit ()
 Deinitialize core and all the modules. More...
 
void initPlugIns ()
 Load and initialize external modules (plugins) More...
 
StelModuleMgrgetModuleMgr ()
 Get the module manager to use for accessing any module loaded in the application. More...
 
StelLocaleMgrgetLocaleMgr ()
 Get the locale manager to use for i18n & date/time localization. More...
 
StelSkyCultureMgrgetSkyCultureMgr ()
 Get the sky cultures manager. More...
 
StelTextureMgrgetTextureManager ()
 Get the texture manager to use for loading textures. More...
 
StelLocationMgrgetLocationMgr ()
 Get the Location manager to use for managing stored locations. More...
 
StelObjectMgrgetStelObjectMgr ()
 Get the StelObject manager to use for querying from all stellarium objects. More...
 
StelSkyLayerMgrgetSkyImageMgr ()
 
StelAudioMgrgetStelAudioMgr ()
 Get the audio manager. More...
 
StelActionMgrgetStelActionManager ()
 Get the actions manager to use for managing and editing actions. More...
 
StelVideoMgrgetStelVideoMgr ()
 Get the video manager. More...
 
StelCoregetCore ()
 Get the core of the program. More...
 
QNetworkAccessManager * getNetworkAccessManager ()
 Get the common instance of QNetworkAccessManager used in stellarium. More...
 
void updateI18n ()
 Update translations, font for GUI and sky everywhere in the program. More...
 
void updateSkyCulture ()
 Update and reload sky culture informations everywhere in the program. More...
 
QSettings * getSettings ()
 Return the main configuration options. More...
 
QString getCurrentStelStyle ()
 Return the currently used style. More...
 
void update (double deltaTime)
 Update all object according to the deltaTime in seconds. More...
 
void draw ()
 Draw all registered StelModule in the order defined by the order lists. More...
 
void glWindowHasBeenResized (float x, float y, float w, float h)
 Call this when the size of the GL window has changed. More...
 
float getDevicePixelsPerPixel () const
 Get the ratio between real device pixel and "Device Independent Pixel". More...
 
void setDevicePixelsPerPixel (float dppp)
 
float getGlobalScalingRatio () const
 Get the scaling ratio to apply on all display elements, like GUI, text etc. More...
 
void setGlobalScalingRatio (float r)
 
int getBaseFontSize () const
 Get the size of font. More...
 
void setBaseFontSize (int s)
 
StelGuiBasegetGui () const
 Get the GUI instance implementing the abstract GUI interface. More...
 
void setGui (StelGuiBase *b)
 Tell the StelApp instance which GUI si currently being used. More...
 
StelMainScriptAPIProxygetMainScriptAPIProxy ()
 Get the script API proxy (for signal handling) More...
 
StelScriptMgrgetScriptMgr ()
 Get the script manager. More...
 
StelProgressControlleraddProgressBar ()
 Add a progression indicator to the GUI (if applicable). More...
 
void removeProgressBar (StelProgressController *p)
 
void setViewportEffect (const QString &effectName)
 Define the type of viewport effect to use. More...
 
QString getViewportEffect () const
 Get the type of viewport effect currently used. More...
 

Static Public Member Functions

static StelAppgetInstance ()
 Get the StelApp singleton instance. More...
 
static void initStatic ()
 
static void deinitStatic ()
 

Properties

bool nightMode
 

Detailed Description

Singleton main Stellarium application class.

This is the central class of Stellarium. Only one singleton instance of this class is created and can be accessed from anywhere else. This class is the access point to several "Manager" class which provide application-wide services for managment of font, textures, localization, sky culture, and in theory all other services used by the other part of the program.

The StelApp class is also the one managing the StelModule in a generic manner by calling their update, drawing and other methods when needed.

Author
Fabien Chereau

Definition at line 62 of file StelApp.hpp.

Constructor & Destructor Documentation

StelApp::StelApp ( QObject *  parent = NULL)

Create and initialize the main Stellarium application.

Parameters
parentthe QObject parent The configFile will be search for in the search path by the StelFileMgr, it is therefor possible to specify either just a file name or path within the search path, or use a full path or even a relative path to an existing file
virtual StelApp::~StelApp ( )
virtual

Deinitialize and destroy the main Stellarium application.

Member Function Documentation

void StelApp::aboutToQuit ( )
signal

Called just before we exit Qt mainloop.

StelProgressController* StelApp::addProgressBar ( )

Add a progression indicator to the GUI (if applicable).

Returns
a controller which can be used to indicate the current status. The StelApp instance remains the owner of the controller.
void StelApp::deinit ( )

Deinitialize core and all the modules.

void StelApp::draw ( )

Draw all registered StelModule in the order defined by the order lists.

Returns
the max squared distance in pixels that any object has travelled since the last update.
int StelApp::getBaseFontSize ( ) const
inline

Get the size of font.

Definition at line 170 of file StelApp.hpp.

StelCore* StelApp::getCore ( )
inline

Get the core of the program.

It is the one which provide the projection, navigation and tone converter.

Returns
the StelCore instance of the program

Definition at line 131 of file StelApp.hpp.

QString StelApp::getCurrentStelStyle ( )
inline

Return the currently used style.

Definition at line 146 of file StelApp.hpp.

float StelApp::getDevicePixelsPerPixel ( ) const
inline

Get the ratio between real device pixel and "Device Independent Pixel".

Usually this value is 1, but for a mac with retina screen this will be value 2.

Definition at line 160 of file StelApp.hpp.

float StelApp::getFps ( ) const
inlineslot

Get the current number of frame per second.

Returns
the FPS averaged on the last second

Definition at line 212 of file StelApp.hpp.

float StelApp::getGlobalScalingRatio ( ) const
inline

Get the scaling ratio to apply on all display elements, like GUI, text etc.

When this ratio is 1, all pixel sizes used in Stellarium will look OK on a regular computer screen with 96 pixel per inch (reference for tuning sizes).

Definition at line 166 of file StelApp.hpp.

StelGuiBase* StelApp::getGui ( ) const
inline

Get the GUI instance implementing the abstract GUI interface.

Definition at line 174 of file StelApp.hpp.

static StelApp& StelApp::getInstance ( )
inlinestatic

Get the StelApp singleton instance.

Returns
the StelApp singleton instance

Definition at line 91 of file StelApp.hpp.

StelLocaleMgr& StelApp::getLocaleMgr ( )
inline

Get the locale manager to use for i18n & date/time localization.

Returns
the font manager to use for loading fonts.

Definition at line 99 of file StelApp.hpp.

StelLocationMgr& StelApp::getLocationMgr ( )
inline

Get the Location manager to use for managing stored locations.

Returns
the Location manager to use for managing stored locations

Definition at line 111 of file StelApp.hpp.

StelMainScriptAPIProxy* StelApp::getMainScriptAPIProxy ( )
inline

Get the script API proxy (for signal handling)

Definition at line 181 of file StelApp.hpp.

StelModuleMgr& StelApp::getModuleMgr ( )
inline

Get the module manager to use for accessing any module loaded in the application.

Returns
the module manager.

Definition at line 95 of file StelApp.hpp.

QNetworkAccessManager* StelApp::getNetworkAccessManager ( )
inline

Get the common instance of QNetworkAccessManager used in stellarium.

Definition at line 134 of file StelApp.hpp.

StelScriptMgr& StelApp::getScriptMgr ( )
inline

Get the script manager.

Definition at line 183 of file StelApp.hpp.

QSettings* StelApp::getSettings ( )
inline

Return the main configuration options.

Definition at line 143 of file StelApp.hpp.

StelSkyCultureMgr& StelApp::getSkyCultureMgr ( )
inline

Get the sky cultures manager.

Returns
the sky cultures manager

Definition at line 103 of file StelApp.hpp.

StelActionMgr* StelApp::getStelActionManager ( )
inline

Get the actions manager to use for managing and editing actions.

Definition at line 123 of file StelApp.hpp.

StelAudioMgr* StelApp::getStelAudioMgr ( )
inline

Get the audio manager.

Definition at line 120 of file StelApp.hpp.

StelObjectMgr& StelApp::getStelObjectMgr ( )
inline

Get the StelObject manager to use for querying from all stellarium objects.

Returns
the StelObject manager to use for querying from all stellarium objects .

Definition at line 115 of file StelApp.hpp.

StelVideoMgr* StelApp::getStelVideoMgr ( )
inline

Get the video manager.

Definition at line 126 of file StelApp.hpp.

StelTextureMgr& StelApp::getTextureManager ( )
inline

Get the texture manager to use for loading textures.

Returns
the texture manager to use for loading textures.

Definition at line 107 of file StelApp.hpp.

static double StelApp::getTotalRunTime ( )
staticslot

Return the time since when stellarium is running in second.

QString StelApp::getViewportEffect ( ) const

Get the type of viewport effect currently used.

bool StelApp::getVisionModeNight ( ) const
inlineslot

Get flag for activating night vision mode.

Definition at line 208 of file StelApp.hpp.

void StelApp::glWindowHasBeenResized ( float  x,
float  y,
float  w,
float  h 
)

Call this when the size of the GL window has changed.

void StelApp::init ( QSettings *  conf)

Initialize core and all the modules.

void StelApp::initPlugIns ( )

Load and initialize external modules (plugins)

void StelApp::progressBarAdded ( const StelProgressController )
signal

Called just after a progress bar is added.

void StelApp::progressBarRemoved ( const StelProgressController )
signal

Called just before a progress bar is removed.

void StelApp::quit ( )
slot

do some cleanup and call QCoreApplication::exit(0)

void StelApp::reportFileDownloadFinished ( QNetworkReply *  reply)
slot

Report that a download occured.

This is used for statistics purposes. Connect this slot to QNetworkAccessManager::finished() slot to obtain statistics at the end of the program.

void StelApp::setGui ( StelGuiBase b)
inline

Tell the StelApp instance which GUI si currently being used.

The caller is responsible for destroying the GUI.

Definition at line 177 of file StelApp.hpp.

void StelApp::setViewportEffect ( const QString &  effectName)

Define the type of viewport effect to use.

Parameters
effectNamemust be one of 'none', 'framebufferOnly', 'sphericMirrorDistorter'
void StelApp::setVisionModeNight ( bool  )
slot

Set flag for activating night vision mode.

void StelApp::update ( double  deltaTime)

Update all object according to the deltaTime in seconds.

void StelApp::updateI18n ( )

Update translations, font for GUI and sky everywhere in the program.

void StelApp::updateSkyCulture ( )

Update and reload sky culture informations everywhere in the program.


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