Home · All Namespaces · All Classes · Functions · Coding Style · Scripting · Plugins · File Structure

StelSkyLayer Class Reference

Abstract class defining the API to implement for all sky layer. More...

#include <StelSkyLayer.hpp>

Inherited by MultiLevelJsonBase.

List of all members.

Signals

void loadingStateChanged (bool b)
void percentLoadedChanged (int percentage)

Public Member Functions

 StelSkyLayer (QObject *parent=NULL)
virtual void draw (StelCore *core, StelPainter &sPainter, float opacity=1.)=0
virtual QString getShortName () const =0
virtual QString getShortServerCredits () const
virtual QString getKeyHint () const
virtual QString getLayerDescriptionHtml () const


Detailed Description

Abstract class defining the API to implement for all sky layer.

A sky layer is a graphical layer containing image or polygons displayed in the sky. The StelSkyImageMgr allows to set the display order for layers, as well as opacity.


Member Function Documentation

virtual void StelSkyLayer::draw ( StelCore core,
StelPainter sPainter,
float  opacity = 1. 
) [pure virtual]

Draws the content of the layer.

Implemented in StelSkyImageTile, and StelSkyPolygon.

virtual QString StelSkyLayer::getShortName (  )  const [pure virtual]

Return the short name to display in the loading bar.

Implemented in MultiLevelJsonBase.

virtual QString StelSkyLayer::getShortServerCredits (  )  const [inline, virtual]

Return the short server name to display in the loading bar.

virtual QString StelSkyLayer::getKeyHint (  )  const [inline, virtual]

Return a hint on which key to use for referencing this layer.

Note that the key effectively used may be different.

virtual QString StelSkyLayer::getLayerDescriptionHtml (  )  const [inline, virtual]

Return a human readable description of the layer with e.g.

links and copyrights.

Reimplemented in StelSkyImageTile.

void StelSkyLayer::loadingStateChanged ( bool  b  )  [signal]

Emitted when loading of data started or stopped.

Parameters:
b true if data loading started, false if finished.

void StelSkyLayer::percentLoadedChanged ( int  percentage  )  [signal]

Emitted when the percentage of loading tiles/tiles to be displayed changed.

Parameters:
percentage the percentage of loaded data.


Generated on Wed Jun 2 13:11:14 2010 for Stellarium by  doxygen 1.5.5