StelMainScriptAPI.hpp

/*
 * Stellarium
 * Copyright (C) 2009 Matthew Gates
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA  02110-1335, USA.
 */

#ifndef _STELMAINSCRIPTAPI_HPP_
#define _STELMAINSCRIPTAPI_HPP_

#include <QObject>
#include <QVariant>
#include <QStringList>
#include "StelObject.hpp"
#include "StelCore.hpp"

class QScriptEngine;

class StelMainScriptAPI : public QObject
{
    Q_OBJECT
    Q_PROPERTY(double JDay READ getJDay WRITE setJDay)
    Q_PROPERTY(double timeSpeed READ getTimeRate WRITE setTimeRate)

public:
    StelMainScriptAPI(QObject *parent = Q_NULLPTR);
    ~StelMainScriptAPI();

// These functions will be available in scripts
public slots:
    void setJDay(double JD);
    double getJDay() const;

    void setMJDay(double MJD);
    double getMJDay() const;

    // TODO: This calls for implementing "sol" days (planets's solar days)!
    //  GZ JDfix for 0.14: I estimate 99.7% of users will want to set UT-based dates here. We could use an awkward name like dateIsUTbased=true to keep default value true.
    //void setDate(const QString& dt, const QString& spec="utc", const bool& enableDeltaT=true);
    void setDate(const QString& dateStr, const QString& spec="utc", const bool& dateIsDT=false);

    QString getDate(const QString& spec="utc");

    QString getDeltaT() const;

    QString getDeltaTAlgorithm() const;

    void setDeltaTAlgorithm(QString algorithmName);

    void setTimeRate(double ts);
    double getTimeRate() const;

    bool isRealTime();

    void setRealTime();

    void selectObjectByName(const QString& name, bool pointer=false);

    QVariantMap getObjectPosition(const QString& name);

    QVariantMap getObjectInfo(const QString& name);

    QVariantMap getSelectedObjectInfo();

    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();

    QVariantMap getObserverLocationInfo();

    void screenshot(const QString& prefix, bool invert=false, const QString& dir="", const bool overwrite=false);

    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);

    void setSphericMirror(bool b);

    void setViewportOffset(const float x, const float y);

    void setViewportStretch(const float stretch);

    QStringList getAllSkyCultureIDs();

    QString getSkyCulture();

    void setSkyCulture(const QString& id);

    QString getSkyCultureName();

    QString getSkyCultureNameI18n();

    bool getFlagGravityLabels();

    void setFlagGravityLabels(bool b);

    void loadSkyImage(const QString& id, const QString& filename,
                      double lon0, double lat0,
                      double lon1, double lat1,
                      double lon2, double lat2,
                      double lon3, double lat3,
                      double minRes=2.5, double maxBright=14, bool visible=true, const QString &frame="EqJ2000");


    void loadSkyImage(const QString& id, const QString& filename,
                      const QString& lon0, const QString& lat0,
                      const QString& lon1, const QString& lat1,
                      const QString& lon2, const QString& lat2,
                      const QString& lon3, const QString& lat3,
                      double minRes=2.5, double maxBright=14, bool visible=true, const QString& frame="EqJ2000");

    void loadSkyImage(const QString& id, const QString& filename,
                      double lon, double lat, double angSize, double rotation,
                      double minRes=2.5, double maxBright=14, bool visible=true, const QString& frame="EqJ2000");

    void loadSkyImage(const QString& id, const QString& filename,
                      const QString& lon, const QString& lat, double angSize, double rotation,
                      double minRes=2.5, double maxBright=14, bool visible=true, const QString& frame="EqJ2000");

    void loadSkyImageAltAz(const QString& id, const QString& filename,
                      double azi0, double alt0,
                      double azi1, double alt1,
                      double azi2, double alt2,
                      double azi3, double alt3,
                      double minRes=2.5, double maxBright=14, bool visible=true);

    void loadSkyImageAltAz(const QString& id, const QString& filename,
                      double alt, double azi, double angSize, double rotation,
                      double minRes=2.5, double maxBright=14, bool visible=true);

    void removeSkyImage(const QString& id);

    QVariantMap getScreenXYFromAltAzi(const QString& alt, const QString& azi);

    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);

    qint64 getSoundPosition(const QString& id);

    qint64 getSoundDuration(const QString& id);


    void loadVideo(const QString& filename, const QString& id, float x, float y, bool show=true, float alpha=1.0f);

    void playVideo(const QString& id, bool keepVisibleAtEnd=false);

    void playVideoPopout(const QString& id, float fromX, float fromY, float atCenterX, float atCenterY, float finalSizeX, float finalSizeY, float popupDuration, bool frozenInTransition);

    void pauseVideo(const QString& id);

    void stopVideo(const QString& id);

    void dropVideo(const QString& id);

    void seekVideo(const QString& id, qint64 ms, bool pause=false);

    void setVideoXY(const QString& id, float x, float y, bool relative=false);

    void setVideoAlpha(const QString& id, float alpha);

        void resizeVideo(const QString& id, float w, float h);

    void showVideo(const QString& id, bool show=true);

    qint64 getVideoDuration(const QString& id);

    qint64 getVideoPosition(const QString& id);

    int getScreenWidth();
    int getScreenHeight();

    double getScriptRate();
    void setScriptRate(double r);

    void pauseScript();

    void setSelectedObjectInfo(const QString& level);

    void exit();

    void quitStellarium();

    QStringList getPropertyList() const;

    static void debug(const QString& s);

    void output(const QString& s) const;

    QString mapToString(const QVariantMap &map) const;

    void resetOutput(void) const;

    void saveOutputAs(const QString &filename);

    QString getAppLanguage() const;

    void setAppLanguage(QString langCode);

    QString getSkyLanguage() const;

    void setSkyLanguage(QString langCode);

    void goHome();

    void setMilkyWayVisible(bool b);

    void setMilkyWayIntensity(double i);

    double getMilkyWayIntensity() const;

    void setZodiacalLightVisible(bool b);

    void setZodiacalLightIntensity(double i);

    double getZodiacalLightIntensity() const;

    int getBortleScaleIndex() const;

    void setBortleScaleIndex(int index);

    void setDSSMode(bool b);
    bool isDSSModeEnabled() const;

    double jdFromDateString(const QString& dt, const QString& spec);

    // Methods wait() and waitFor() were added for documentation.
    // Details: https://bugs.launchpad.net/stellarium/+bug/1402200
    // re-implemented for 0.15.1 to avoid a busy-loop.
    void wait(double t);

    void waitFor(const QString& dt, const QString& spec="utc");


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, const StelCore::FrameType frameType);
    void requestLoadSkyImageAltAz(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 requestLoadVideo(const QString& filename, const QString& id, float x, float y, bool show, float alpha);
    void requestPlayVideo(const QString& id, const bool keepVisibleAtEnd);
    void requestPlayVideoPopout(const QString& id, float fromX, float fromY, float atCenterX, float atCenterY, float finalSizeX, float finalSizeY, float popupDuration, bool frozenInTransition);
    void requestPauseVideo(const QString& id);
    void requestStopVideo(const QString& id);
    void requestDropVideo(const QString& id);
    void requestSeekVideo(const QString& id, qint64 ms, bool pause=false);
    void requestSetVideoXY(const QString& id, float x, float y, bool relative=false);
    void requestSetVideoAlpha(const QString& id, float alpha);
    void requestResizeVideo(const QString& id, float w, float h);
    void requestShowVideo(const QString& id, bool show);
    
    void requestSetNightMode(bool b);
    void requestSetProjectionMode(QString id);
    void requestSetSkyCulture(QString id);
    void requestSetDiskViewport(bool b);
    void requestExit();
    void requestSetHomePosition();
};

#endif // _STELMAINSCRIPTAPI_HPP_