mainpage.doxygen   mainpage.doxygen 
skipping to change at line 31 skipping to change at line 31
@mainpage Stellarium Developers Documentation @mainpage Stellarium Developers Documentation
@section intro_sec Introduction @section intro_sec Introduction
This documentation concerns the inner workings of Stellarium. This documen tation This documentation concerns the inner workings of Stellarium. This documen tation
is targetted at developers of scripts, plugins and the core program. is targetted at developers of scripts, plugins and the core program.
@section architecture_sec Program Architecture @section architecture_sec Program Architecture
The code of Stellarium is split into several main blocks: The code of Stellarium is split into several main blocks: <ul>
<ul>
<li>the main loop and main widget classes StelMainWindow, StelMainGraphicsV <li> the main loop and main widget classes StelMainWindow, StelMainGraphics
iew and StelAppGraphicsScene. Those classes have a single instance which is View and
created at startup by the ::main() function. They perform various tasks su StelAppGraphicsWidget. Those classes have a single instance created at sta
ch as the creation of the main program window and openGL context, the creat rtup by the ::main()
ion of the stellarium core, the creation of the GUI. After initialization, function. They perform tasks such as creating of the main window and rende
they manage user's input event propagation and event loop. There are heavil rer, creating the
y based on %Qt features.</li> stellarium core, creating the GUI. After initialization, they manage user's
<li>the core which provides a number of generic services and features to th input event
e other components. The main class is the StelApp singleton class which is propagation and event loop. They are heavily based on %Qt features. </li>
used everywhere in the code to access other elements. It is the StelApp ins
tance which creates all the main core services and modules at initializatio <li> the core which provides generic services and features to the other com
n. Example services are OpenGL textures management with the StelTextureMgr, ponents. The main
font management with the StelFontMgr, sky images management (images which class is the StelApp singleton which is used everywhere in the code to acce
have a fixed position in the sky) with the StelSkyImageMgr etc.. Two especi ss other elements.
ally important manager classes (the ones with the "Mgr" suffix) are the Ste The StelApp instance creates all the main core services and modules at init
lModuleMgr and StelCore classes: the first one manages the collection of St ialization. Example
elModule instances which are registered in the program (see next point for services are sky layer management (e.g. images which have a fixed position
more info on what a StelModule is). The second one provides performance cri in the sky) with the
tical features for rendering various elements using openGL, or for computin StelSkyLayerMgr, drawing with StelRenderer etc. . Two especially important
g coordinate transformation and other mathematical services.</li> manager classes are
<li>a collection of StelModule instances which display the main elements of the StelModuleMgr and StelCore: the former manages the collection of StelMo
the program such as planets and stars. Each StelModule should be registere dule instances
d to the StelModuleMgr. Because many components of Stellarium derive from t registered in the program (see next point for more info on what a StelModul
he StelModule class, it is possible for the main loop to treat them generic e is). The latter
ally by calling their standard methods such StelModule::update() and StelMo provides performance critical features for computing coordinate transformat
dule::draw() at each program iteration. It also allows other program compon ion and other
ents to access them by name. StelModule can also be loaded dynamically by S mathematical services. </li>
tellarium, which is the standard way of creating @ref plugins.</li>
<li>the Graphical User Interface (StelGui). It is based on styled %Qt widge <li> a collection of StelModule instances which display the main elements o
ts which are rendered directly in the openGL window. Users actions trigger f the program such as
signals which are connected to core and StelModules slots.</li> planets and stars. Each StelModule should be registered to the StelModuleMg
<li>the script engine (StelScriptMgr) allows scripts to calls slots from th r. Because many
e core and StelModules slots.</li> Stellarium components derive from the StelModule class, the main loop is ab
le to treat them
generically by calling their standard methods such StelModule::update() and
StelModule::draw()
at each program iteration. This also allows other program components to acc
ess them by name.
StelModule can also be loaded dynamically by Stellarium, which is the stand
ard way of creating
@ref plugins. </li>
<li> the Graphical User Interface (StelGui). It is based on styled %Qt widg
ets which are
rendered directly in the graphics window. User actions trigger signals conn
ected to core and
StelModules slots. </li>
<li> the script engine (StelScriptMgr) allows scripts to calls slots from t
he core and
StelModule slots. </li>
</ul> </ul>
@image html stellarium-architecture.png @image html stellarium-architecture.png
@image html stellarium-logo.png @image html stellarium-logo.png
*/ */
 End of changes. 1 change blocks. 
35 lines changed or deleted 54 lines changed or added

This html diff was produced by rfcdiff 1.41. The latest version is available from http://tools.ietf.org/tools/rfcdiff/