Manage the sky background images, including DSS and deep sky objects images. More...

#include <StelSkyLayerMgr.hpp>

Public Slots
void	setFlagShow (bool b)
	Set whether Sky Background should be displayed. More...

bool	getFlagShow () const
	Get whether Sky Background should be displayed. More...

bool	loadSkyImage (const QString &id, const QString &filename, double ra0, double dec0, double ra1, double dec1, double ra2, double dec2, double ra3, double dec3, double minRes, double maxBright, bool visible)
	Load an image from a file. More...

bool	loadSkyImageAltAz (const QString &id, const QString &filename, double alt0, double azi0, double alt1, double azi1, double alt2, double azi2, double alt3, double azi3, double minRes, double maxBright, bool visible)
	Load an image from a file. More...

void	showLayer (const QString &id, bool b)
	Decide to show or not to show a layer by it's ID. More...

bool	getShowLayer (const QString &id) const
	Get the current shown status of a specified image. More...

QString	insertSkyImage (const QString &uri, const QString &keyHint=QString(), bool show=true)
	Add a new SkyImage from its URI (URL or local file name). More...

void	removeSkyLayer (const QString &key)
	Remove a sky layer from the list. More...

QStringList	getAllKeys () const
	Return the list of all the layer currently loaded. More...

Public Member Functions
virtual void	init ()
	Initialize. More...

virtual void	draw (StelCore core, class StelRenderer renderer)
	Draws sky background. More...

virtual void	update (double)
	Update state which is time dependent. More...

virtual double	getCallOrder (StelModuleActionName actionName) const
	Determines the order in which the various modules are drawn. More...

QString	insertSkyLayer (StelSkyLayerP l, const QString &keyHint=QString(), bool show=true)
	Add a new layer. More...

void	removeSkyLayer (StelSkyLayerP l)
	Remove a layer. More...

QMap< QString, StelSkyLayerP >	getAllSkyLayers () const
	Get the list of all the currently loaded layers. More...

StelSkyLayerP	getSkyLayer (const QString &key) const

Public Member Functions inherited from StelModule
virtual void	deinit ()
	Called before the module will be deleted, and before the renderer is destroyed. More...

virtual bool	drawPartial (StelCore core, class StelRenderer renderer)
	Iterate through the drawing sequence. More...

virtual QString	getModuleVersion () const
	Get the version of the module, default is stellarium main version. More...

virtual QString	getAuthorName () const
	Get the name of the module author. More...

virtual QString	getAuthorEmail () const
	Get the email adress of the module author. More...

virtual void	handleMouseClicks (class QMouseEvent *)
	Handle mouse clicks. More...

virtual void	handleMouseWheel (class QWheelEvent *)
	Handle mouse wheel. More...

virtual bool	handleMouseMoves (int x, int y, Qt::MouseButtons b)
	Handle mouse moves. More...

virtual void	handleKeys (class QKeyEvent *e)
	Handle key events. More...

virtual bool	configureGui (bool show=true)
	Detect or show the configuration GUI elements for the module. More...

Additional Inherited Members
Public Types inherited from StelModule
enum	StelModuleSelectAction { AddToSelection, ReplaceSelection, RemoveFromSelection }
	Enum used when selecting objects to define whether to add to, replace, or remove from the existing selection list. More...

enum	StelModuleActionName { ActionDraw, ActionUpdate, ActionHandleMouseClicks, ActionHandleMouseMoves, ActionHandleKeys }
	Define the possible action for which an order is defined. More...

Detailed Description

Manage the sky background images, including DSS and deep sky objects images.

Definition at line 34 of file StelSkyLayerMgr.hpp.

Member Function Documentation

virtual void StelSkyLayerMgr::draw	(	StelCore *	core,
		class StelRenderer *	renderer
	)

virtual

Draws sky background.

Reimplemented from StelModule.

QStringList StelSkyLayerMgr::getAllKeys ( ) const

inlineslot

Return the list of all the layer currently loaded.

Definition at line 163 of file StelSkyLayerMgr.hpp.

QMap<QString, StelSkyLayerP> StelSkyLayerMgr::getAllSkyLayers ( ) const

Get the list of all the currently loaded layers.

virtual double StelSkyLayerMgr::getCallOrder ( StelModuleActionName actionName ) const

virtual

Determines the order in which the various modules are drawn.

Reimplemented from StelModule.

bool StelSkyLayerMgr::getFlagShow ( void ) const

inlineslot

Get whether Sky Background should be displayed.

Definition at line 79 of file StelSkyLayerMgr.hpp.

bool StelSkyLayerMgr::getShowLayer ( const QString & id ) const

slot

Get the current shown status of a specified image.

Parameters

id	the ID of the image whose status is desired.

Returns

the current shown status of the specified image:

true means the specified image is currently shown.
false means the specified image is currently not shown.

virtual void StelSkyLayerMgr::init ( )

virtual

Initialize.

Implements StelModule.

QString StelSkyLayerMgr::insertSkyImage	(	const QString &	uri,
		const QString &	keyHint = `QString()`,
		bool	show = `true`
	)

slot

Add a new SkyImage from its URI (URL or local file name).

The image is owned by the manager and will be destroyed at the end of the program or when removeSkyImage is called with the same URI

Parameters

uri	the local file or the URL where the JSON image description is located.
keyHint	a hint on which key to use for later referencing the image.
show	defined whether the image should be shown by default.

Returns: the reference key to use when accessing this image later on.

QString StelSkyLayerMgr::insertSkyLayer	(	StelSkyLayerP	l,
		const QString &	keyHint = `QString()`,
		bool	show = `true`
	)

Add a new layer.

Parameters

l	the layer to insert.
keyHint	a hint on which key to use for later referencing the image.
show	defined whether the layer should be shown by default

Returns: the reference key to use when accessing this layer later on.

bool StelSkyLayerMgr::loadSkyImage	(	const QString &	id,
		const QString &	filename,
		double	ra0,
		double	dec0,
		double	ra1,
		double	dec1,
		double	ra2,
		double	dec2,
		double	ra3,
		double	dec3,
		double	minRes,
		double	maxBright,
		bool	visible
	)

slot

Load an image from a file.

This should not be called directly from scripts because it is not thread safe. Instead use the simiarly named function in the core scripting object.

Parameters

id	a string identifier for the image
filename	the name of the image file to load. Will be searched for using StelFileMgr, so partial names are fine.
ra0	right ascention of corner 0 in degrees
dec0	declination of corner 0 in degrees
ra1	right ascention of corner 1 in degrees
dec1	declination of corner 1 in degrees
ra2	right ascention of corner 2 in degrees
dec2	declination of corner 2 in degrees
ra3	right ascention of corner 3 in degrees
dec3	declination of corner 3 in degrees
minRes	the minimum resolution setting for the image
maxBright	the maximum brightness setting for the image
visible	initial visibility setting

bool StelSkyLayerMgr::loadSkyImageAltAz	(	const QString &	id,
		const QString &	filename,
		double	alt0,
		double	azi0,
		double	alt1,
		double	azi1,
		double	alt2,
		double	azi2,
		double	alt3,
		double	azi3,
		double	minRes,
		double	maxBright,
		bool	visible
	)

slot

Load an image from a file.

This should not be called directly from scripts because it is not thread safe. Instead use the similarly named function in the core scripting object.

Parameters

id	a string identifier for the image
filename	the name of the image file to load. Will be searched for using StelFileMgr, so partial names are fine.
alt0	altitude angle of corner 0 in degrees
azi0	azimuth angle of corner 0 in degrees
alt1	altitude angle of corner 1 in degrees
azi1	azimuth angle of corner 1 in degrees
alt2	altitude angle of corner 2 in degrees
azi2	azimuth angle of corner 2 in degrees
alt3	altitude angle of corner 3 in degrees
azi3	azimuth angle of corner 3 in degrees
minRes	the minimum resolution setting for the image
maxBright	the maximum brightness setting for the image
visible	initial visibility setting

void StelSkyLayerMgr::removeSkyLayer ( StelSkyLayerP l )

Remove a layer.

void StelSkyLayerMgr::removeSkyLayer ( const QString & key )

slot

Remove a sky layer from the list.

Note: this is not thread safe, and so should not be used directly from scripts - use the similarly named function in the core scripting API object to delete SkyLayers.

Parameters

key	the reference key (id) generated by insertSkyImage.

void StelSkyLayerMgr::setFlagShow ( bool b )

inlineslot

Set whether Sky Background should be displayed.

Definition at line 77 of file StelSkyLayerMgr.hpp.

void StelSkyLayerMgr::showLayer	(	const QString &	id,
		bool	b
	)

slot

Decide to show or not to show a layer by it's ID.

Parameters

id	the id of the layer whose status is to be changed.
b	the new shown value: true means the specified image will be shown. false means the specified image will not be shown.

virtual void StelSkyLayerMgr::update ( double )

inlinevirtual

Update state which is time dependent.

Implements StelModule.

Definition at line 51 of file StelSkyLayerMgr.hpp.

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

core/StelSkyLayerMgr.hpp

Public Slots

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation