scriptglobal.h

Go to the documentation of this file.

/********************************************************************************************
**    iLand - an individual based forest landscape and disturbance model
**    http://iland-model.org
**    Copyright (C) 2009-  Werner Rammer, Rupert Seidl
**
**    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 3 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, see <http://www.gnu.org/licenses/>.
********************************************************************************************/
 
#ifndef SCRIPTGLOBAL_H
#define SCRIPTGLOBAL_H
 
#include <QObject>
#include <QVariant>
#include <QJSValue>
 
 
// Scripting Interface for MapGrid
class MapGrid; // forward
class MapGridWrapper: public QObject
{
    Q_OBJECT
    Q_PROPERTY(int valid READ isValid)
    Q_PROPERTY(QString name READ name)
public:
    MapGridWrapper(QObject *parent=nullptr);
    ~MapGridWrapper();
    static void addToScriptEngine(QJSEngine &engine);
    MapGrid *map() const { return mMap; } 
    bool isValid() const; 
    QString name() const;
    //
 
public slots:
    // query
    double area(int id); 
    // actions
    void load(QString file_name);
    void saveAsImage(QString file);
    void paint(double min_value, double max_value);
    // active modifications of the map
    void clear(); 
    void clearProjectArea(); 
    void createStand(int stand_id, QString paint_function, bool wrap_around);
 
    double copyPolygonFromRect(QJSValue source, int id_in, int id, double destx, double desty, double x1, double y1, double x2, double y2);
 
    void createMapIndex(); 
 
private:
    MapGrid *mMap;
    bool mCreated;
 
};
 
class Model;
class ScriptResourceUnit; // forward
class ScriptGlobal : public QObject
{
    Q_OBJECT
    // read only properties
    Q_PROPERTY(int year READ year)
    Q_PROPERTY(int resourceUnitCount READ resourceUnitCount)
    Q_PROPERTY(QString currentDir WRITE setCurrentDir READ currentDir)
    Q_PROPERTY(double worldX READ worldX)
    Q_PROPERTY(double worldY READ worldY)
    Q_PROPERTY(bool qt5 READ qt5)
    Q_PROPERTY(int msec READ msec)
    Q_PROPERTY(QJSValue viewOptions READ viewOptions WRITE setViewOptions)
 
 
public:
    ScriptGlobal(QObject *parent=nullptr);
    static void setupGlobalScripting();
    // properties accesible by scripts
    bool qt5() const {return true; } 
    int msec() const; 
    int year() const; 
    int resourceUnitCount() const; 
    QString currentDir() const { return mCurrentDir; } 
    void setCurrentDir(QString newDir) { mCurrentDir = newDir; } 
    double worldX(); 
    double worldY(); 
 
    // general functions
    static void loadScript(const QString &fileName);
    static QString executeScript(QString cmd);
    static QString executeJSFunction(QString function);
    static QObject *scriptOutput; 
    static QString formattedErrorMessage(const QJSValue &error_value, const QString &sourcecode);
 
    // view options
    /* View options:
     * * type: {...}
     * * species: bool
     * * shade: bool
     *
    */
    QJSValue viewOptions(); 
    void setViewOptions(QJSValue opts); 
 
    // static functions
    static QJSValue valueFromJs(const QJSValue &js_value, const QString &key, const QString default_value=QLatin1Literal(""), const QString &errorMessage=QLatin1Literal(""));
    static QString JStoString(QJSValue value);
 
public slots:
    // system stuff
    QVariant setting(QString key); 
    void set(QString key, QString value); 
    void print(QString message); 
    void alert(QString message); 
    void include(QString filename); 
    // file stuff
    QString defaultDirectory(QString dir); 
    QString path(QString filename); 
    QString loadTextFile(QString fileName); 
    void saveTextFile(QString fileName, QString content); 
    bool fileExists(QString fileName); 
    void systemCmd(QString command); 
    // add trees
    int addSingleTrees(const int resourceIndex, QString content); 
    int addTrees(const int resourceIndex, QString content); 
    int addTreesOnMap(const int standID, QString content); 
    // add saplings
    int addSaplingsOnMap(MapGridWrapper *map, const int mapID, QString species, int px_per_hectare, double height, int age);
    int addSaplings(int standId, double x, double y, double width, double height, QString species, double treeheight, int age);
    void removeSaplings(int standId, double x, double y, double width, double height);
    // enable/disable outputs
    bool startOutput(QString table_name); 
    bool stopOutput(QString table_name); 
    // debug outputs
    void debugOutputFilter(QList<int> ru_indices); 
    bool saveDebugOutputs(bool do_clear); 
    // miscellaneous stuff
    void setViewport(double x, double y, double scale_px_per_m); 
    bool screenshot(QString file_name); 
    void repaint(); 
    bool gridToFile(QString grid_type, QString file_name); 
 
    QJSValue grid(QString type);
    QJSValue speciesShareGrid(QString species);
    QJSValue resourceUnitGrid(QString expression);
 
    QJSValue resourceUnit(int index);
 
 
    // DOES NOT FULLY WORK
    bool seedMapToFile(QString species, QString file_name); 
    void wait(int milliseconds); 
    // vegetation snapshots
    bool saveModelSnapshot(QString file_name);
    bool loadModelSnapshot(QString file_name);
    bool saveStandSnapshot(int stand_id, QString file_name);
    bool loadStandSnapshot(int stand_id, QString file_name);
    bool saveStandCarbon(int stand_id, QList<int> ru_ids, bool rid_mode=true);
    bool loadStandCarbon();
    // agent-based-model of forest management
    void reloadABE();
 
    // UI interface
    void setUIshortcuts(QJSValue shortcuts); 
 
    void test_tree_mortality(double thresh, int years, double p_death);
private:
    void throwError(const QString &errormessage);
    QString mCurrentDir;
    Model *mModel;
    QJSValue mRUValue;
    ScriptResourceUnit *mSRU;
};
 
class ScriptObjectFactory: public QObject
{
    Q_OBJECT
public:
    ScriptObjectFactory(QObject *parent=nullptr);
public slots:
    QJSValue newCSVFile(QString filename); 
    QJSValue newClimateConverter(); 
    QJSValue newMap(); 
    QJSValue newDBHDistribution(); 
    QJSValue newGrid(); 
    QJSValue newSpatialAnalysis(); 
    int stats() {return mObjCreated;} 
private:
    int mObjCreated;
 
};
 
#endif // SCRIPTGLOBAL_H