Stellarium  0.16.0
List of all members | Classes | Public Slots | Signals | Public Member Functions | Properties
StelSkyLayerMgr Class Reference

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

#include <StelSkyLayerMgr.hpp>

+ Inheritance diagram for StelSkyLayerMgr:
+ Collaboration diagram for StelSkyLayerMgr:

Public Slots

void setFlagShow (bool b)
 Set whether Sky Background should be displayed. More...
 
bool loadSkyImage (const QString &id, const QString &filename, double long0, double lat0, double long1, double lat1, double long2, double lat2, double long3, double lat3, double minRes, double maxBright, bool visible, StelCore::FrameType frameType=StelCore::FrameJ2000)
 Load an image from a file into a quad described with 4 corner coordinates. 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 into AzAltimuthal coordinates. More...
 
void showLayer (const QString &id, bool b)
 Decide to show or not to show a layer by its 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...
 

Signals

void flagShowChanged (bool b)
 

Public Member Functions

virtual void init ()
 Initialize. More...
 
virtual void draw (StelCore *core)
 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
 
bool getFlagShow () const
 Get whether Sky Background should be displayed. More...
 
- Public Member Functions inherited from StelModule
virtual void deinit ()
 Called before the module will be delete, and before the openGL context is suppressed. 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 handlePinch (qreal scale, bool started)
 Handle pinch gesture events. More...
 
virtual bool configureGui (bool show=true)
 Detect or show the configuration GUI elements for the module. More...
 

Properties

bool flagShow
 

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...
 
- Protected Member Functions inherited from StelModule
class StelActionaddAction (const QString &id, const QString &groupId, const QString &text, QObject *target, const char *slot, const QString &shortcut="", const QString &altShortcut="")
 convenience methods to add an action (call to slot) to the StelActionMgr object. More...
 
class StelActionaddAction (const QString &id, const QString &groupId, const QString &text, const char *slot, const QString &shortcut="", const QString &altShortcut="")
 convenience methods to add an action (call to own slot) to the StelActionMgr object. More...
 

Detailed Description

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

Drawn after Milky Way, but before Zodiacal Light. It is not intended to be used to "overdraw" images into the foreground without a concept of surface magnitude.

Definition at line 36 of file StelSkyLayerMgr.hpp.

Member Function Documentation

virtual void StelSkyLayerMgr::draw ( StelCore core)
virtual

Draws sky background.

Reimplemented from StelModule.

QStringList StelSkyLayerMgr::getAllKeys ( ) const
inlineslot

Return the list of all the layer currently loaded.

Definition at line 171 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
inline

Get whether Sky Background should be displayed.

Definition at line 77 of file StelSkyLayerMgr.hpp.

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

Get the current shown status of a specified image.

Parameters
idthe 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
urithe local file or the URL where the JSON image description is located.
keyHinta hint on which key to use for later referencing the image.
showdefined 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
lthe layer to insert.
keyHinta hint on which key to use for later referencing the image.
showdefined 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  long0,
double  lat0,
double  long1,
double  lat1,
double  long2,
double  lat2,
double  long3,
double  lat3,
double  minRes,
double  maxBright,
bool  visible,
StelCore::FrameType  frameType = StelCore::FrameJ2000 
)
slot

Load an image from a file into a quad described with 4 corner coordinates.

The corners are always given in counterclockwise from top-left, also for azaltimuthal images. 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
ida string identifier for the image
filenamethe name of the image file to load. Will be searched for using StelFileMgr, so partial names are fine.
lon0right ascension/longitude/azimuth of top-left corner 0 in degrees
lat0declination/latitude/altitude of corner 0 in degrees
lon1right ascension/longitude/azimuth of bottom-left corner 1 in degrees
lat1declination/latitude/altitude of corner 1 in degrees
lon2right ascension/longitude/azimuth of bottom-right corner 2 in degrees
lat2declination/latitude/altitude of corner 2 in degrees
lon3right ascension/longitude/azimuth of top-right corner 3 in degrees
lat3declination/latitude/altitude of corner 3 in degrees
minResthe minimum resolution setting for the image
maxBrightthe maximum brightness setting for the image
visibleinitial visibility setting
frameTypeCoordinate frame type
Note
Last argument has been added 2017-03. Use loadSkyImage(... , StelCore::FrameJ2000) for the previous behaviour!
For frameType=AzAlt, azimuth currently is counted from South towards East.
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 into AzAltimuthal coordinates.

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
ida string identifier for the image
filenamethe name of the image file to load. Will be searched for using StelFileMgr, so partial names are fine.
alt0altitude angle of corner 0 in degrees
azi0azimuth angle of corner 0 in degrees
alt1altitude angle of corner 1 in degrees
azi1azimuth angle of corner 1 in degrees
alt2altitude angle of corner 2 in degrees
azi2azimuth angle of corner 2 in degrees
alt3altitude angle of corner 3 in degrees
azi3azimuth angle of corner 3 in degrees
minResthe minimum resolution setting for the image
maxBrightthe maximum brightness setting for the image
visibleinitial visibility setting
Deprecated:
since 2017-03 (inconsistent parameter order)! Use loadSkyImage(...., StelCore::FrameAzAlt) instead!
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
keythe reference key (id) generated by insertSkyImage.
void StelSkyLayerMgr::setFlagShow ( bool  b)
inlineslot

Set whether Sky Background should be displayed.

Definition at line 83 of file StelSkyLayerMgr.hpp.

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

Decide to show or not to show a layer by its ID.

Parameters
idthe id of the layer whose status is to be changed.
bthe 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 54 of file StelSkyLayerMgr.hpp.


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