![]() |
Home · All Namespaces · All Classes · Functions · Coding Style · Scripting · Plugins · File Structure |
Provide script API for Stellarium global functions. More...
#include <StelMainScriptAPI.hpp>
Public Slots | |
void | setJDay (double JD) |
double | getJDay () const |
void | setDate (const QString &dt, const QString &spec="utc") |
QString | getDate (const QString &spec="utc") |
void | setTimeRate (double ts) |
double | getTimeRate () const |
bool | isRealTime () |
void | setRealTime () |
void | selectObjectByName (const QString &name, bool pointer=false) |
QVariantMap | getObjectPosition (const QString &name) |
void | clear (const QString &state="natural") |
double | getViewAltitudeAngle () |
double | getViewAzimuthAngle () |
double | getViewRaAngle () |
double | getViewDecAngle () |
double | getViewRaJ2000Angle () |
double | getViewDecJ2000Angle () |
void | moveToAltAzi (const QString &alt, const QString &azi, float duration=1.) |
void | moveToRaDec (const QString &ra, const QString &dec, float duration=1.) |
void | moveToRaDecJ2000 (const QString &ra, const QString &dec, float duration=1.) |
void | setObserverLocation (double longitude, double latitude, double altitude, double duration=1., const QString &name="", const QString &planet="") |
void | setObserverLocation (const QString id, float duration=1.) |
QString | getObserverLocation () |
void | screenshot (const QString &prefix, bool invert=false, const QString &dir="") |
void | setGuiVisible (bool b) |
void | setMinFps (float m) |
float | getMinFps () |
void | setMaxFps (float m) |
float | getMaxFps () |
QString | getMountMode () |
void | setMountMode (const QString &mode) |
bool | getNightMode () |
void | setNightMode (bool b) |
QString | getProjectionMode () |
void | setProjectionMode (const QString &id) |
bool | getDiskViewport () |
void | setDiskViewport (bool b) |
QStringList | getAllSkyCultureIDs () |
QString | getSkyCulture () |
void | setSkyCulture (const QString &id) |
bool | getFlagGravityLabels () |
void | setFlagGravityLabels (bool b) |
void | 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=2.5, double maxBright=14, bool visible=true) |
void | loadSkyImage (const QString &id, const QString &filename, const QString &ra0, const QString &dec0, const QString &ra1, const QString &dec1, const QString &ra2, const QString &dec2, const QString &ra3, const QString &dec3, double minRes=2.5, double maxBright=14, bool visible=true) |
void | loadSkyImage (const QString &id, const QString &filename, double ra, double dec, double angSize, double rotation, double minRes=2.5, double maxBright=14, bool visible=true) |
void | loadSkyImage (const QString &id, const QString &filename, const QString &ra, const QString &dec, double angSize, double rotation, double minRes=2.5, double maxBright=14, bool visible=true) |
void | removeSkyImage (const QString &id) |
void | loadSound (const QString &filename, const QString &id) |
void | playSound (const QString &id) |
void | pauseSound (const QString &id) |
void | stopSound (const QString &id) |
void | dropSound (const QString &id) |
int | getScreenWidth () |
int | getScreenHeight () |
double | getScriptRate () |
void | setScriptRate (double r) |
void | setSelectedObjectInfo (const QString &level) |
void | exit () |
void | quitStellarium () |
void | debug (const QString &s) |
QString | getAppLanguage () |
void | setAppLanguage (QString langCode) |
QString | getSkyLanguage () |
void | setSkyLanguage (QString langCode) |
double | jdFromDateString (const QString &dt, const QString &spec) |
Signals | |
void | requestLoadSkyImage (const QString &id, const QString &filename, double c1, double c2, double c3, double c4, double c5, double c6, double c7, double c8, double minRes, double maxBright, bool visible) |
void | requestRemoveSkyImage (const QString &id) |
void | requestLoadSound (const QString &filename, const QString &id) |
void | requestPlaySound (const QString &id) |
void | requestPauseSound (const QString &id) |
void | requestStopSound (const QString &id) |
void | requestDropSound (const QString &id) |
void | requestSetNightMode (bool b) |
void | requestSetProjectionMode (QString id) |
void | requestSetSkyCulture (QString id) |
void | requestSetDiskViewport (bool b) |
void | requestExit () |
Public Member Functions | |
StelMainScriptAPI (QObject *parent=0) | |
Properties | |
double | JDay |
double | timeSpeed |
Provide script API for Stellarium global functions.
Public slots in this class may be used in Stellarium scripts, and are accessed as member function to the "core" scripting object. Module-specific functions, such as setting and clearing of display flags (e.g. LandscapeMgr::setFlagAtmosphere) can be accessed directly via the scripting object with the class name, e.g. by using the scripting command: LandscapeMgr.setFlagAtmosphere(true);
void StelMainScriptAPI::clear | ( | const QString & | state = "natural" |
) | [slot] |
Clear the display options, setting a "standard" view.
Preset states:
state | the name of a preset state. |
void StelMainScriptAPI::debug | ( | const QString & | s | ) | [slot] |
print a debugging message to the console
s | the message to be displayed on the console. |
void StelMainScriptAPI::dropSound | ( | const QString & | id | ) | [slot] |
Drop a sound from memory.
You should do this before the end of your script.
id | the identifier used when loadSound was called |
QStringList StelMainScriptAPI::getAllSkyCultureIDs | ( | ) | [slot] |
Get a list of Sky Culture IDs.
QString StelMainScriptAPI::getAppLanguage | ( | ) | [slot] |
Get the current application language.
QString StelMainScriptAPI::getDate | ( | const QString & | spec = "utc" |
) | [slot] |
get the simulation date and time as a string in ISO format, e.g.
"2008-03-24T13:21:01"
spec | if "utc", the returned string's timezone is UTC, else it is local time. |
bool StelMainScriptAPI::getDiskViewport | ( | ) | [slot] |
Get the status of the disk viewport.
bool StelMainScriptAPI::getFlagGravityLabels | ( | ) | [slot] |
Get the current status of the gravity labels option.
double StelMainScriptAPI::getJDay | ( | ) | const [slot] |
Get the current date in Julian Day.
float StelMainScriptAPI::getMaxFps | ( | ) | [slot] |
Get the current maximum frames per second.
float StelMainScriptAPI::getMinFps | ( | ) | [slot] |
Get the current minimum frames per second.
QString StelMainScriptAPI::getMountMode | ( | ) | [slot] |
Get the mount mode as a string.
bool StelMainScriptAPI::getNightMode | ( | ) | [slot] |
Get the current status of Night Mode.
QVariantMap StelMainScriptAPI::getObjectPosition | ( | const QString & | name | ) | [slot] |
Fetch a map with data about an object's position, magnitude and so on.
name | is the English name of the object for which data will be returned. |
QString StelMainScriptAPI::getProjectionMode | ( | ) | [slot] |
Get the current projection mode ID string.
int StelMainScriptAPI::getScreenHeight | ( | ) | [slot] |
Get the screen height in pixels.
int StelMainScriptAPI::getScreenWidth | ( | ) | [slot] |
Get the screen width in pixels.
double StelMainScriptAPI::getScriptRate | ( | ) | [slot] |
Get the script execution rate as a multiple of normal execution speed.
QString StelMainScriptAPI::getSkyCulture | ( | ) | [slot] |
Find out the current sky culture.
QString StelMainScriptAPI::getSkyLanguage | ( | ) | [slot] |
Get the current sky language.
double StelMainScriptAPI::getTimeRate | ( | ) | const [slot] |
Get simulation time rate.
double StelMainScriptAPI::getViewAltitudeAngle | ( | ) | [slot] |
Get the current viewing direction altitude angle at center of view.
double StelMainScriptAPI::getViewAzimuthAngle | ( | ) | [slot] |
Get the current viewing direction azimuth angle at center of view.
double StelMainScriptAPI::getViewDecAngle | ( | ) | [slot] |
Get the current viewing direction Declination angle at center of view.
double StelMainScriptAPI::getViewDecJ2000Angle | ( | ) | [slot] |
Get the current viewing direction Declination angle in J2000 frame at center of view.
double StelMainScriptAPI::getViewRaAngle | ( | ) | [slot] |
Get the current viewing direction Right Ascension at center of view.
double StelMainScriptAPI::getViewRaJ2000Angle | ( | ) | [slot] |
Get the current viewing direction Right Ascension in J2000 frame at center of view.
bool StelMainScriptAPI::isRealTime | ( | ) | [slot] |
Get the simulation time and rate state - is it "real time".
double StelMainScriptAPI::jdFromDateString | ( | const QString & | dt, | |
const QString & | spec | |||
) | [slot] |
For use in setDate and waitFor For parameter descriptions see setDate().
void StelMainScriptAPI::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 = 2.5 , |
|||
double | maxBright = 14 , |
|||
bool | visible = true | |||
) | [slot] |
Load an image which will have sky coordinates.
id | a string ID to be used when referring to this image (e.g. when changing the displayed status or deleting it. | |
filename | the file name of the image. If a relative path is specified, "scripts/" will be prefixed before the image is searched for using StelFileMgr. | |
ra0 | The right ascension of the first corner of the image in degrees | |
dec0 | The declenation of the first corner of the image in degrees | |
ra1 | The right ascension of the second corner of the image in degrees | |
dec1 | The declenation of the second corner of the image in degrees | |
ra2 | The right ascension of the third corner of the image in degrees | |
dec2 | The declenation of the third corner of the image in degrees | |
ra3 | The right ascension of the fourth corner of the image in degrees | |
dec3 | The declenation of the fourth corner of the image in degrees | |
minRes | The minimum resolution setting for the image | |
maxBright | The maximum brightness setting for the image | |
visible | The initial visibility of the image |
void StelMainScriptAPI::loadSkyImage | ( | const QString & | id, | |
const QString & | filename, | |||
const QString & | ra0, | |||
const QString & | dec0, | |||
const QString & | ra1, | |||
const QString & | dec1, | |||
const QString & | ra2, | |||
const QString & | dec2, | |||
const QString & | ra3, | |||
const QString & | dec3, | |||
double | minRes = 2.5 , |
|||
double | maxBright = 14 , |
|||
bool | visible = true | |||
) | [slot] |
Convenience function which allows the user to provide RA and DEC angles as strings (e.g.
"12d 14m 8s" or "5h 26m 8s" - formats accepted by StelUtils::getDecAngle()).
void StelMainScriptAPI::loadSkyImage | ( | const QString & | id, | |
const QString & | filename, | |||
double | ra, | |||
double | dec, | |||
double | angSize, | |||
double | rotation, | |||
double | minRes = 2.5 , |
|||
double | maxBright = 14 , |
|||
bool | visible = true | |||
) | [slot] |
Convenience function which allows loading of a sky image based on a central coordinate, angular size and rotation.
id | a string ID to be used when referring to this image (e.g. when changing the displayed status or deleting it. | |
filename | the file name of the image. If a relative path is specified, "scripts/" will be prefixed before the image is searched for using StelFileMgr. | |
ra | The right ascension of the center of the image in J2000 frame degrees | |
dec | The declenation of the center of the image in J2000 frame degrees | |
angSize | The angular size of the image in arc minutes | |
rotation | The clockwise rotation angle of the image in degrees | |
minRes | The minimum resolution setting for the image | |
maxBright | The maximum brightness setting for the image | |
visible | The initial visibility of the image |
void StelMainScriptAPI::loadSkyImage | ( | const QString & | id, | |
const QString & | filename, | |||
const QString & | ra, | |||
const QString & | dec, | |||
double | angSize, | |||
double | rotation, | |||
double | minRes = 2.5 , |
|||
double | maxBright = 14 , |
|||
bool | visible = true | |||
) | [slot] |
Convenience function which allows loading of a sky image based on a central coordinate, angular size and rotation.
Parameters are the same as the version of this function which takes double values for the ra and dec, except here text expressions of angles may be used.
void StelMainScriptAPI::loadSound | ( | const QString & | filename, | |
const QString & | id | |||
) | [slot] |
Load a sound from a file.
filename | the name of the file to load. | |
id | the identifier which will be used to refer to the sound when calling playSound, pauseSound, stopSound and dropSound. |
void StelMainScriptAPI::moveToAltAzi | ( | const QString & | alt, | |
const QString & | azi, | |||
float | duration = 1. | |||
) | [slot] |
move the current viewing direction to some specified altitude and azimuth angles may be specified in a format recognised by StelUtils::getDecAngle()
alt | the altitude angle | |
azi | the azimuth angle | |
duration | the duration of the movement in seconds |
void StelMainScriptAPI::moveToRaDec | ( | const QString & | ra, | |
const QString & | dec, | |||
float | duration = 1. | |||
) | [slot] |
move the current viewing direction to some specified right ascension and declination angles may be specified in a format recognised by StelUtils::getDecAngle()
ra | the right ascension angle | |
dec | the declination angle | |
duration | the duration of the movement in seconds |
void StelMainScriptAPI::moveToRaDecJ2000 | ( | const QString & | ra, | |
const QString & | dec, | |||
float | duration = 1. | |||
) | [slot] |
move the current viewing direction to some specified right ascension and declination in the J2000 frame angles may be specified in a format recognised by StelUtils::getDecAngle()
ra | the right ascension angle | |
dec | the declination angle | |
duration | the duration of the movement in seconds |
void StelMainScriptAPI::pauseSound | ( | const QString & | id | ) | [slot] |
Pause a sound which is playing.
Subsequent playSound calls will resume playing from the position in the file when it was paused.
id | the identifier used when loadSound was called |
void StelMainScriptAPI::playSound | ( | const QString & | id | ) | [slot] |
Play a sound which has previously been loaded with loadSound.
id | the identifier used when loadSound was called |
void StelMainScriptAPI::removeSkyImage | ( | const QString & | id | ) | [slot] |
Remove a SkyImage.
id | the ID of the image to remove. |
void StelMainScriptAPI::screenshot | ( | const QString & | prefix, | |
bool | invert = false , |
|||
const QString & | dir = "" | |||
) | [slot] |
Save a screenshot.
prefix | the prefix for the file name to use | |
dir | the path of the directory to save the screenshot in. If none is specified, the default screenshot directory will be used. | |
invert | whether colors have to be inverted in the output image |
void StelMainScriptAPI::selectObjectByName | ( | const QString & | name, | |
bool | pointer = false | |||
) | [slot] |
Select an object by name.
name | the name of the object to select (english) If the name is "", any currently selected objects will be de-selected. | |
pointer | whether or not to have the selection pointer enabled |
void StelMainScriptAPI::setAppLanguage | ( | QString | langCode | ) | [slot] |
Set the current application language.
langCode | two letter language code, e.g. "en", or "de". |
void StelMainScriptAPI::setDate | ( | const QString & | dt, | |
const QString & | spec = "utc" | |||
) | [slot] |
set the date in ISO format, e.g.
"2008-03-24T13:21:01"
dt | the date string to use. Formats:
| |
spec | "local" or "utc" - only has an effect when the ISO date type is used. |
void StelMainScriptAPI::setDiskViewport | ( | bool | b | ) | [slot] |
Set the disk viewport.
b | if true, sets the disk viewport on, else sets it off |
void StelMainScriptAPI::setFlagGravityLabels | ( | bool | b | ) | [slot] |
Turn on/off gravity labels.
b | if true, turn on gravity labels, else turn them off |
void StelMainScriptAPI::setGuiVisible | ( | bool | b | ) | [slot] |
Show or hide the GUI (toolbars).
Note this only applies to GUI plugins which provide the public slot "setGuiVisible(bool)".
b | if true, show the GUI, if false, hide the GUI. |
void StelMainScriptAPI::setJDay | ( | double | JD | ) | [slot] |
Set the current date in Julian Day.
JD | the Julian Date |
void StelMainScriptAPI::setMaxFps | ( | float | m | ) | [slot] |
Set the maximum frames per second.
m | the new maximum fps setting. |
void StelMainScriptAPI::setMinFps | ( | float | m | ) | [slot] |
Set the minimum frames per second.
Usually this minimum will be switched to after there are no user events for some seconds to save power. However, if can be useful to set this to a high value to improve playing smoothness in scripts.
m | the new minimum fps setting. |
void StelMainScriptAPI::setMountMode | ( | const QString & | mode | ) | [slot] |
Set the mount mode.
mode | should be "equatorial" or "azimuthal" |
void StelMainScriptAPI::setNightMode | ( | bool | b | ) | [slot] |
Set the status of Night Mode.
b | if true, set Night Mode, else set Normal Mode |
void StelMainScriptAPI::setObserverLocation | ( | const QString | id, | |
float | duration = 1. | |||
) | [slot] |
Set the location by the name of the location.
id | the location ID as it would be found in the database of locations - do a search in the Location window to see what where is. e.g. "York, UnitedKingdom". | |
duration | the number of seconds to take to move location. |
void StelMainScriptAPI::setObserverLocation | ( | double | longitude, | |
double | latitude, | |||
double | altitude, | |||
double | duration = 1. , |
|||
const QString & | name = "" , |
|||
const QString & | planet = "" | |||
) | [slot] |
Set the observer location.
longitude | the longitude in degrees. E is +ve. values out of the range -180 .. 180 mean that the longitude will not be set | |
latitude | the longitude in degrees. N is +ve. values out of the range -180 .. 180 mean that the latitude will not be set | |
altitude | the new altitude in meters. values less than -1000 mean the altitude will not be set. | |
duration | the time for the transition from the old to the new location. | |
name | A name for the location (which will appear in the status bar. | |
planet | the English name of the new planet. If the planet name is not known (e.g. ""), the planet will not be set. |
void StelMainScriptAPI::setProjectionMode | ( | const QString & | id | ) | [slot] |
Set the current projection mode.
id | the name of the projection mode to use, e.g. "Perspective" and so on. valid values of id are:
|
void StelMainScriptAPI::setScriptRate | ( | double | r | ) | [slot] |
Set the script execution rate as a multiple of normal execution speed.
r | the multiple of the normal script execution speed, i.e. if 5 is passed the script will execute 5 times faster than it would if the script rate was 1. |
void StelMainScriptAPI::setSelectedObjectInfo | ( | const QString & | level | ) | [slot] |
Set the amount of selected object information to display.
level | can be "AllInfo", "ShortInfo", "None" |
void StelMainScriptAPI::setSkyCulture | ( | const QString & | id | ) | [slot] |
Set the current sky culture.
id | the ID of the sky culture to set, e.g. western or inuit etc. |
void StelMainScriptAPI::setSkyLanguage | ( | QString | langCode | ) | [slot] |
Set the current sky language.
langCode | two letter language code, e.g. "en", or "de". |
void StelMainScriptAPI::setTimeRate | ( | double | ts | ) | [slot] |
Set time speed in JDay/sec.
ts | the new rate of passage of time as a multiple of real time. For example if ts is 1, time will pass at the normal rate. If ts == 10 then simulation time will pass at 10 times the normal rate. If ts is negative, simulation time will go backwards. |
void StelMainScriptAPI::stopSound | ( | const QString & | id | ) | [slot] |
Stop a sound from playing.
This resets the position in the sound to the start so that subsequent playSound calls will start from the beginning.
id | the identifier used when loadSound was called |