Stellarium 0.13.2
StelMainScriptAPI.hpp
1 /*
2  * Stellarium
3  * Copyright (C) 2009 Matthew Gates
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA 02110-1335, USA.
18  */
19 
20 #ifndef _STELMAINSCRIPTAPI_HPP_
21 #define _STELMAINSCRIPTAPI_HPP_
22 
23 #include <QObject>
24 #include <QVariant>
25 #include <QStringList>
26 
27 class QScriptEngine;
28 
35 class StelMainScriptAPI : public QObject
36 {
37  Q_OBJECT
38  Q_PROPERTY(double JDay READ getJDay WRITE setJDay)
39  Q_PROPERTY(double timeSpeed READ getTimeRate WRITE setTimeRate)
40 
41 public:
42  StelMainScriptAPI(QObject *parent = 0);
44 
45 // These functions will be available in scripts
46 public slots:
49  void setJDay(double JD);
52  double getJDay() const;
53 
56  void setMJDay(double MJD);
59  double getMJDay() const;
60 
83  void setDate(const QString& dt, const QString& spec="utc", const bool& enableDeltaT=true);
84 
90  QString getDate(const QString& spec="utc");
91 
95  QString getDeltaT() const;
96 
99  QString getDeltaTAlgorithm() const;
100 
109  void setDeltaTAlgorithm(QString algorithmName);
110 
116  void setTimeRate(double ts);
119  double getTimeRate() const;
120 
124  bool isRealTime();
125 
127  void setRealTime();
128 
134  void selectObjectByName(const QString& name, bool pointer=false);
135 
149  QVariantMap getObjectPosition(const QString& name);
150 
181  QVariantMap getObjectInfo(const QString& name);
182 
212  QVariantMap getSelectedObjectInfo();
213 
221  void clear(const QString& state="natural");
222 
226  double getViewAltitudeAngle();
227 
231  double getViewAzimuthAngle();
232 
236  double getViewRaAngle();
237 
241  double getViewDecAngle();
242 
245  double getViewRaJ2000Angle();
246 
249  double getViewDecJ2000Angle();
250 
256  void moveToAltAzi(const QString& alt, const QString& azi, float duration=1.);
257 
263  void moveToRaDec(const QString& ra, const QString& dec, float duration=1.);
264 
270  void moveToRaDecJ2000(const QString& ra, const QString& dec, float duration=1.);
271 
289  void setObserverLocation(double longitude, double latitude, double altitude, double duration=1., const QString& name="", const QString& planet="");
290 
296  void setObserverLocation(const QString id, float duration=1.);
297 
299  QString getObserverLocation();
300 
311  QVariantMap getObserverLocationInfo();
312 
318  void screenshot(const QString& prefix, bool invert=false, const QString& dir="");
319 
323  void setGuiVisible(bool b);
324 
330  void setMinFps(float m);
331 
334  float getMinFps();
335 
338  void setMaxFps(float m);
339 
342  float getMaxFps();
343 
346  QString getMountMode();
347 
350  void setMountMode(const QString& mode);
351 
354  bool getNightMode();
355 
358  void setNightMode(bool b);
359 
363  QString getProjectionMode();
364 
376  void setProjectionMode(const QString& id);
377 
380  bool getDiskViewport();
381 
384  void setDiskViewport(bool b);
385 
388  QStringList getAllSkyCultureIDs();
389 
393  QString getSkyCulture();
394 
397  void setSkyCulture(const QString& id);
398 
401  QString getSkyCultureName();
402 
405  QString getSkyCultureNameI18n();
406 
409  bool getFlagGravityLabels();
410 
413  void setFlagGravityLabels(bool b);
414 
433  void loadSkyImage(const QString& id, const QString& filename,
434  double ra0, double dec0,
435  double ra1, double dec1,
436  double ra2, double dec2,
437  double ra3, double dec3,
438  double minRes=2.5, double maxBright=14, bool visible=true);
439 
440 
444  void loadSkyImage(const QString& id, const QString& filename,
445  const QString& ra0, const QString& dec0,
446  const QString& ra1, const QString& dec1,
447  const QString& ra2, const QString& dec2,
448  const QString& ra3, const QString& dec3,
449  double minRes=2.5, double maxBright=14, bool visible=true);
450 
465  void loadSkyImage(const QString& id, const QString& filename,
466  double ra, double dec, double angSize, double rotation,
467  double minRes=2.5, double maxBright=14, bool visible=true);
468 
473  void loadSkyImage(const QString& id, const QString& filename,
474  const QString& ra, const QString& dec, double angSize, double rotation,
475  double minRes=2.5, double maxBright=14, bool visible=true);
476 
495  void loadSkyImageAltAz(const QString& id, const QString& filename,
496  double alt0, double azi0,
497  double alt1, double azi1,
498  double alt2, double azi2,
499  double alt3, double azi3,
500  double minRes=2.5, double maxBright=14, bool visible=true);
501 
516  void loadSkyImageAltAz(const QString& id, const QString& filename,
517  double alt, double azi, double angSize, double rotation,
518  double minRes=2.5, double maxBright=14, bool visible=true);
519 
522  void removeSkyImage(const QString& id);
523 
528  void loadSound(const QString& filename, const QString& id);
529 
532  void playSound(const QString& id);
533 
537  void pauseSound(const QString& id);
538 
543  void stopSound(const QString& id);
544 
548  void dropSound(const QString& id);
549 
558  void loadVideo(const QString& filename, const QString& id, float x, float y, bool show, float alpha);
559 
562  void playVideo(const QString& id);
563 
567  void pauseVideo(const QString& id);
568 
573  void stopVideo(const QString& id);
574 
578  void dropVideo(const QString& id);
579 
583  void seekVideo(const QString& id, qint64 ms);
584 
589  void setVideoXY(const QString& id, float x, float y);
590 
594  void setVideoAlpha(const QString& id, float alpha);
595 
600  void resizeVideo(const QString& id, float w, float h);
601 
605  void showVideo(const QString& id, bool show);
606 
609  int getScreenWidth();
612  int getScreenHeight();
613 
616  double getScriptRate();
621  void setScriptRate(double r);
622 
625  void pauseScript();
626 
629  void setSelectedObjectInfo(const QString& level);
630 
632  void exit();
633 
635  void quitStellarium();
636 
639  void debug(const QString& s);
640 
643  void output(const QString& s);
644 
647  QString getAppLanguage();
648 
651  void setAppLanguage(QString langCode);
652 
655  QString getSkyLanguage();
656 
659  void setSkyLanguage(QString langCode);
660 
662  void goHome();
663 
666  void setMilkyWayVisible(bool b);
667 
670  void setMilkyWayIntensity(double i);
671 
674  double getMilkyWayIntensity();
675 
678  void setZodiacalLightVisible(bool b);
679 
682  void setZodiacalLightIntensity(double i);
683 
686  double getZodiacalLightIntensity();
687 
691  double jdFromDateString(const QString& dt, const QString& spec);
692 
693  // Methods wait() and waitFor() was added for documentation.
694  // Details: https://bugs.launchpad.net/stellarium/+bug/1402200
695 
699  void wait(double t) { Q_UNUSED(t) }
700 
710  void waitFor(const QString& dt, const QString& spec="utc") { Q_UNUSED(dt); Q_UNUSED(spec) }
711 
712 signals:
713  void requestLoadSkyImage(const QString& id, const QString& filename,
714  double c1, double c2,
715  double c3, double c4,
716  double c5, double c6,
717  double c7, double c8,
718  double minRes, double maxBright, bool visible);
719  void requestLoadSkyImageAltAz(const QString& id, const QString& filename,
720  double c1, double c2,
721  double c3, double c4,
722  double c5, double c6,
723  double c7, double c8,
724  double minRes, double maxBright, bool visible);
725 
726 
727  void requestRemoveSkyImage(const QString& id);
728 
729  void requestLoadSound(const QString& filename, const QString& id);
730  void requestPlaySound(const QString& id);
731  void requestPauseSound(const QString& id);
732  void requestStopSound(const QString& id);
733  void requestDropSound(const QString& id);
734  void requestLoadVideo(const QString& filename, const QString& id, float x, float y, bool show, float alpha);
735  void requestPlayVideo(const QString& id);
736  void requestPauseVideo(const QString& id);
737  void requestStopVideo(const QString& id);
738  void requestDropVideo(const QString& id);
739  void requestSeekVideo(const QString& id, qint64 ms);
740  void requestSetVideoXY(const QString& id, float x, float y);
741  void requestSetVideoAlpha(const QString& id, float alpha);
742  void requestResizeVideo(const QString& id, float w, float h);
743  void requestShowVideo(const QString& id, bool show);
744 
745  void requestSetNightMode(bool b);
746  void requestSetProjectionMode(QString id);
747  void requestSetSkyCulture(QString id);
748  void requestSetDiskViewport(bool b);
749  void requestExit();
750  void requestSetHomePosition();
751 };
752 
753 #endif // _STELMAINSCRIPTAPI_HPP_
754 
void setMinFps(float m)
Set the minimum frames per second.
double getViewDecAngle()
Get the current viewing direction Declination angle at center of view.
double getMJDay() const
Get the current date in Modified Julian Day.
bool getNightMode()
Get the current status of Night Mode.
QVariantMap getObjectInfo(const QString &name)
Fetch a map with data about an object's position, magnitude and so on.
void selectObjectByName(const QString &name, bool pointer=false)
Select an object by name.
void clear(const QString &state="natural")
Clear the display options, setting a "standard" view.
double jdFromDateString(const QString &dt, const QString &spec)
For use in setDate and waitFor For parameter descriptions see setDate().
void pauseVideo(const QString &id)
Pause a video which is playing.
void moveToAltAzi(const QString &alt, const QString &azi, float duration=1.)
move the current viewing direction to some specified altitude and azimuth angles may be specified in ...
int getScreenHeight()
Get the screen height in pixels.
QString getAppLanguage()
Get the current application language.
void setProjectionMode(const QString &id)
Set the current projection mode.
void setDiskViewport(bool b)
Set the disk viewport.
bool isRealTime()
Get the simulation time and rate state - is it "real time".
void playSound(const QString &id)
Play a sound which has previously been loaded with loadSound.
void moveToRaDec(const QString &ra, const QString &dec, float duration=1.)
move the current viewing direction to some specified right ascension and declination angles may be sp...
QString getDeltaTAlgorithm() const
get the DeltaT equation name for the simulation date and time as a string
double getTimeRate() const
Get simulation time rate.
double getViewDecJ2000Angle()
Get the current viewing direction Declination angle in J2000 frame at center of view.
double getViewRaJ2000Angle()
Get the current viewing direction Right Ascension in J2000 frame at center of view.
QString getProjectionMode()
Get the current projection mode ID string.
void setRealTime()
Set the simulation time to the current system time, and the time rate to 1.
void exit()
Stop the script.
QVariantMap getObserverLocationInfo()
Get the info of the current observer location.
void wait(double t)
Pauses the script for t milliseconds.
int getScreenWidth()
Get the screen width in pixels.
void loadVideo(const QString &filename, const QString &id, float x, float y, bool show, float alpha)
Load a video from a file.
void setMilkyWayVisible(bool b)
Show or hide the Milky Way.
void resizeVideo(const QString &id, float w, float h)
Resize the video widget to the specified width, height.
void setVideoAlpha(const QString &id, float alpha)
Set the alpha value of a video when visible.
void setNightMode(bool b)
Set the status of Night Mode.
void playVideo(const QString &id)
Play a video which has previously been loaded with loadVideo.
void 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=2.5, double maxBright=14, bool visible=true)
Load an image which will have sky coordinates.
void setSelectedObjectInfo(const QString &level)
Set the amount of selected object information to display.
void setDate(const QString &dt, const QString &spec="utc", const bool &enableDeltaT=true)
set the date in ISO format, e.g.
QString getSkyCultureName()
Find out the current sky culture and get it English name.
QString getSkyCultureNameI18n()
Find out the current sky culture and get it localized name.
void dropSound(const QString &id)
Drop a sound from memory.
void removeSkyImage(const QString &id)
Remove a SkyImage.
void setFlagGravityLabels(bool b)
Turn on/off gravity labels.
void setZodiacalLightVisible(bool b)
Show or hide the Zodiacal Light.
void setMountMode(const QString &mode)
Set the mount mode.
double getViewAltitudeAngle()
Get the current viewing direction altitude angle at center of view.
void debug(const QString &s)
print a debugging message to the console
QString getDate(const QString &spec="utc")
get the simulation date and time as a string in ISO format, e.g.
Provide script API for Stellarium global functions.
QVariantMap getSelectedObjectInfo()
Fetch a map with data about an latest selected object's position, magnitude and so on...
void setJDay(double JD)
Set the current date in Julian Day.
void showVideo(const QString &id, bool show)
Set the visibility state of a video.
float getMinFps()
Get the current minimum frames per second.
void setScriptRate(double r)
Set the script execution rate as a multiple of normal execution speed.
void moveToRaDecJ2000(const QString &ra, const QString &dec, float duration=1.)
move the current viewing direction to some specified right ascension and declination in the J2000 fra...
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)
Load an image which will have sky coordinates.
void setMaxFps(float m)
Set the maximum frames per second.
QStringList getAllSkyCultureIDs()
Get a list of Sky Culture IDs.
void setSkyLanguage(QString langCode)
Set the current sky language.
void goHome()
Go to defaults position and direction of view.
void waitFor(const QString &dt, const QString &spec="utc")
Waits until a specified simulation date/time.
void loadSound(const QString &filename, const QString &id)
Load a sound from a file.
void setAppLanguage(QString langCode)
Set the current application language.
void seekVideo(const QString &id, qint64 ms)
Seeks a video to the requested time.
QString getMountMode()
Get the mount mode as a string.
void setGuiVisible(bool b)
Show or hide the GUI (toolbars).
void output(const QString &s)
print an output message from script
void pauseScript()
Pause the currently running script.
bool getDiskViewport()
Get the status of the disk viewport.
void dropVideo(const QString &id)
Drop a video from memory.
QString getDeltaT() const
get the DeltaT for the simulation date and time as a string in HMS format, e.g.
double getMilkyWayIntensity()
Get Milky Way intensity.
double getViewAzimuthAngle()
Get the current viewing direction azimuth angle at center of view.
QString getObserverLocation()
Get the ID of the current observer location.
float getMaxFps()
Get the current maximum frames per second.
QString getSkyLanguage()
Get the current sky language.
void quitStellarium()
Close Stellarium.
void setDeltaTAlgorithm(QString algorithmName)
set equation of the DeltaT for the simulation date and time
double getScriptRate()
Get the script execution rate as a multiple of normal execution speed.
void setMJDay(double MJD)
Set the current date in Modified Julian Day.
void setTimeRate(double ts)
Set time speed in JDay/sec.
void pauseSound(const QString &id)
Pause a sound which is playing.
void screenshot(const QString &prefix, bool invert=false, const QString &dir="")
Save a screenshot.
void setMilkyWayIntensity(double i)
Set Milky Way intensity.
bool getFlagGravityLabels()
Get the current status of the gravity labels option.
void setSkyCulture(const QString &id)
Set the current sky culture.
QString getSkyCulture()
Find out the current sky culture.
double getViewRaAngle()
Get the current viewing direction Right Ascension at center of view.
void setZodiacalLightIntensity(double i)
Set Zodiacal Light intensity.
void stopSound(const QString &id)
Stop a sound from playing.
double getZodiacalLightIntensity()
Get Zodiacal Light intensity.
void setVideoXY(const QString &id, float x, float y)
Sets the position of the video widget.
double getJDay() const
Get the current date in Julian Day.
QVariantMap getObjectPosition(const QString &name)
Fetch a map with data about an object's position, magnitude and so on.
void stopVideo(const QString &id)
Stop a video from playing.
void setObserverLocation(double longitude, double latitude, double altitude, double duration=1., const QString &name="", const QString &planet="")
Set the observer location.