![]() |
Home · All Namespaces · All Classes · Functions · Coding Style · Plugins · File Structure |
#include <StelSkyImageMgr.hpp>
Inherits StelModule.
Public Slots | |
void | setFlagShow (bool b) |
bool | getFlagShow () const |
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) |
void | showImage (const QString &id, bool b) |
bool | getShowImage (const QString &id) |
QString | insertSkyImage (const QString &uri, bool show=true) |
void | removeSkyImage (const QString &key) |
QStringList | getAllKeys () const |
Public Member Functions | |
virtual void | init () |
virtual void | draw (StelCore *core) |
virtual void | update (double deltaTime) |
virtual void | updateI18n () |
virtual double | getCallOrder (StelModuleActionName actionName) const |
QString | insertSkyImage (StelSkyImageTile *img, bool show=true, bool externallyOwned=true) |
void | removeSkyImage (StelSkyImageTile *img) |
Classes | |
class | StelSkyImageMgrElem |
virtual void StelSkyImageMgr::init | ( | ) | [virtual] |
virtual void StelSkyImageMgr::draw | ( | StelCore * | core | ) | [virtual] |
virtual void StelSkyImageMgr::update | ( | double | deltaTime | ) | [inline, virtual] |
virtual void StelSkyImageMgr::updateI18n | ( | ) | [inline, virtual] |
virtual double StelSkyImageMgr::getCallOrder | ( | StelModuleActionName | actionName | ) | const [virtual] |
QString StelSkyImageMgr::insertSkyImage | ( | StelSkyImageTile * | img, | |
bool | show = true , |
|||
bool | externallyOwned = true | |||
) |
Add a new sky image tile in the list of background images TODO: document params, specifially, what does externallyOwned really mean?
void StelSkyImageMgr::removeSkyImage | ( | StelSkyImageTile * | img | ) |
Remove a sky image tile from the list of background images.
void StelSkyImageMgr::setFlagShow | ( | bool | b | ) | [inline, slot] |
Set whether Sky Background should be displayed.
bool StelSkyImageMgr::getFlagShow | ( | ) | const [inline, slot] |
Get whether Sky Background should be displayed.
bool StelSkyImageMgr::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.
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 | declenation of corner 0 in degrees | |
ra1 | right ascention of corner 1 in degrees | |
dec1 | declenation of corner 1 in degrees | |
ra2 | right ascention of corner 2 in degrees | |
dec2 | declenation of corner 2 in degrees | |
ra3 | right ascention of corner 3 in degrees | |
dec3 | declenation 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 StelSkyImageMgr::showImage | ( | const QString & | id, | |
bool | b | |||
) | [slot] |
Decide to show or not to show an image by it's ID.
id | the id of the image whose status is to be changed | |
b | the new shown value:
|
bool StelSkyImageMgr::getShowImage | ( | const QString & | id | ) | [slot] |
Get the current shown status of a specified image.
id | the ID of the image whose status is desired |
QString StelSkyImageMgr::insertSkyImage | ( | const QString & | uri, | |
bool | show = true | |||
) | [slot] |
Add a new image 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.
uri | the local file or the URL where the JSON image description is located | |
show | defined whether the image should be shown by default |
void StelSkyImageMgr::removeSkyImage | ( | const QString & | key | ) | [slot] |
Remove a sky image tile from the list of background images 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 SkyImages.
key | the reference key (id) generated by insertSkyImage |
QStringList StelSkyImageMgr::getAllKeys | ( | ) | const [inline, slot] |
Return the list of all the sky images currently loaded.