Stellarium 0.12.2
List of all members | Signals | Public Member Functions
StelSkyLayer Class Referenceabstract

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

#include <StelSkyLayer.hpp>

Signals

void loadingStateChanged (bool b)
 Emitted when loading of data started or stopped. More...
 
void percentLoadedChanged (int percentage)
 Emitted when the percentage of loading tiles/tiles to be displayed changed. More...
 

Public Member Functions

 StelSkyLayer (QObject *parent=NULL)
 
virtual void draw (StelCore *core, class StelRenderer *renderer, StelProjectorP projector, float opacity=1.)=0
 Draws the content of the layer. More...
 
virtual QString getShortName () const =0
 Return the short name to display in the loading bar. More...
 
virtual QString getShortServerCredits () const
 Return the short server name to display in the loading bar. More...
 
virtual QString getKeyHint () const
 Return a hint on which key to use for referencing this layer. More...
 
virtual QString getLayerDescriptionHtml () const
 Return a human readable description of the layer with e.g. More...
 
void setFrameType (StelCore::FrameType ft)
 Set the reference frame type. More...
 
StelCore::FrameType getFrameType ()
 Get the reference frame type. More...
 

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 StelSkyLayerMgr allows to set the display order for layers, as well as opacity.

Definition at line 34 of file StelSkyLayer.hpp.

Member Function Documentation

virtual void StelSkyLayer::draw ( StelCore core,
class StelRenderer renderer,
StelProjectorP  projector,
float  opacity = 1. 
)
pure virtual

Draws the content of the layer.

Implemented in StelSkyImageTile, and StelSkyPolygon.

StelCore::FrameType StelSkyLayer::getFrameType ( )
inline

Get the reference frame type.

Definition at line 61 of file StelSkyLayer.hpp.

virtual QString StelSkyLayer::getKeyHint ( ) const
inlinevirtual

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

Note that the key effectively used may be different.

Definition at line 51 of file StelSkyLayer.hpp.

virtual QString StelSkyLayer::getLayerDescriptionHtml ( ) const
inlinevirtual

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

links and copyrights.

Reimplemented in StelSkyImageTile.

Definition at line 55 of file StelSkyLayer.hpp.

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
inlinevirtual

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

Definition at line 47 of file StelSkyLayer.hpp.

void StelSkyLayer::loadingStateChanged ( bool  b)
signal

Emitted when loading of data started or stopped.

Parameters
btrue 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
percentagethe percentage of loaded data.
void StelSkyLayer::setFrameType ( StelCore::FrameType  ft)
inline

Set the reference frame type.

Definition at line 58 of file StelSkyLayer.hpp.


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