StelSkyLayer Class Reference

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

#include <StelSkyLayer.hpp>

List of all members.

Signals
void	loadingStateChanged (bool b)
	Emitted when loading of data started or stopped.
void	percentLoadedChanged (int percentage)
	Emitted when the percentage of loading tiles/tiles to be displayed changed.
Public Member Functions
	StelSkyLayer (QObject *parent=NULL)
virtual void	draw (StelCore *core, StelPainter &sPainter, float opacity=1.)=0
	Draws the content of the layer.
virtual QString	getShortName () const =0
	Return the short name to display in the loading bar.
virtual QString	getShortServerCredits () const
	Return the short server name to display in the loading bar.
virtual QString	getKeyHint () const
	Return a hint on which key to use for referencing this layer.
virtual QString	getLayerDescriptionHtml () const
	Return a human readable description of the layer with e.g.
void	setFrameType (StelCore::FrameType ft)
	Set the reference frame type.
StelCore::FrameType	getFrameType ()
	Get the reference frame type.

---

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.

StelCore::FrameType StelSkyLayer::getFrameType

(

)

[inline]

Get the reference frame type.

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.

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.

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.

void StelSkyLayer::setFrameType

(

StelCore::FrameType

ft

)

[inline]

Set the reference frame type.