TelescopeControl.hpp

/*
 * Stellarium Telescope Control Plug-in
 * 
 * Copyright (C) 2006 Johannes Gajdosik
 * Copyright (C) 2009-2010 Bogdan Marinov
 * 
 * This module was originally written by Johannes Gajdosik in 2006
 * as a core module of Stellarium. In 2009 it was significantly extended with
 * GUI features and later split as an external plug-in module by Bogdan Marinov.
 *
 * This class used to be called TelescopeMgr before the split.
 *
 * 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 _TELESCOPE_CONTROL_HPP_
#define _TELESCOPE_CONTROL_HPP_

#include "StelFader.hpp"
#include "StelGui.hpp"
#include "StelJsonParser.hpp"
#include "StelObjectModule.hpp"
#include "StelProjectorType.hpp"
#include "StelTextureTypes.hpp"
#include "TelescopeControlGlobals.hpp"
#include "VecMath.hpp"

#include <QFile>
#include <QFont>
#include <QHash>
#include <QMap>
#include <QProcess>
#include <QSettings>
#include <QString>
#include <QStringList>
#include <QTextStream>
#include <QVariant>

class StelObject;
class StelPainter;
class StelProjector;
class TelescopeClient;
class TelescopeDialog;
class SlewDialog;


using namespace TelescopeControlGlobals;

typedef QSharedPointer<TelescopeClient> TelescopeClientP;

class TelescopeControl : public StelObjectModule
{
    Q_OBJECT

public:
    TelescopeControl();
    virtual ~TelescopeControl();
    
    // Methods defined in the StelModule class
    virtual void init();
    virtual void deinit();
    virtual void update(double deltaTime);
    virtual void draw(StelCore * core);
    virtual double getCallOrder(StelModuleActionName actionName) const;
    
    // Methods defined in the StelObjectModule class
    virtual QList<StelObjectP> searchAround(const Vec3d& v, double limitFov, const StelCore* core) const;
    virtual StelObjectP searchByNameI18n(const QString& nameI18n) const;
    virtual StelObjectP searchByName(const QString& name) const;
    virtual StelObjectP searchByID(const QString &id) const { return searchByName(id); }
    virtual QStringList listMatchingObjects(const QString& objPrefix, int maxNbItem=5, bool useStartOfWords=false, bool inEnglish=false) const;
    // empty as its not celestial objects
    virtual QStringList listAllObjects(bool) const { return QStringList(); }
    virtual QString getName() const { return "Telescope Control"; }
    virtual QString getStelObjectType() const;
    virtual bool configureGui(bool show = true);
    
    // Methods specific to TelescopeControl
    void telescopeGoto(int telescopeNr, const Vec3d &j2000Pos, StelObjectP selectObject = Q_NULLPTR);
    
    void deleteAllTelescopes();
    
    const QHash<QString, DeviceModel>& getDeviceModels();
    
    void loadConfiguration();
    void saveConfiguration();
    
    void saveTelescopes();
    void loadTelescopes();
    
    //These are public, but not slots, because they don't use sufficient validation. Scripts shouldn't be able to add/remove telescopes, only to point them.
    bool addTelescopeAtSlot(int slot, ConnectionType connectionType, QString name, QString equinox, QString host = QString("localhost"), int portTCP = DEFAULT_TCP_PORT, int delay = DEFAULT_DELAY, bool connectAtStartup = false, QList<double> circles = QList<double>(), QString serverName = QString(), QString portSerial = QString(), QString rts2Url = QString(), QString rts2Username = QString(), QString rts2Password = QString(), int rts2Refresh = -1);
    bool getTelescopeAtSlot(int slot, ConnectionType& connectionType, QString& name, QString& equinox, QString& host, int& portTCP, int& delay, bool& connectAtStartup, QList<double>& circles, QString& serverName, QString& portSerial, QString& rts2Url, QString& rts2Username, QString& rts2Password, int& rts2Refresh);
    bool removeTelescopeAtSlot(int slot);
    
    bool startTelescopeAtSlot(int slot);
    bool stopTelescopeAtSlot(int slot);
    bool stopAllTelescopes();
    
    bool isExistingClientAtSlot(int slot);
    bool isConnectedClientAtSlot(int slot);

    QHash<int, QString> getConnectedClientsNames();
    
    bool getFlagUseServerExecutables() {return useServerExecutables;}
    void setFlagUseServerExecutables(bool b);
    const QString& getServerExecutablesDirectoryPath();
    bool setServerExecutablesDirectoryPath(const QString& newPath);
    
    bool getFlagUseTelescopeServerLogs () {return useTelescopeServerLogs;}

public slots:
    void setFlagTelescopeReticles(bool b) {reticleFader = b;}
    bool getFlagTelescopeReticles() const {return (bool)reticleFader;}
    
    void setFlagTelescopeLabels(bool b) {labelFader = b;}
    bool getFlagTelescopeLabels() const {return labelFader==true;}

    void setFlagTelescopeCircles(bool b) {circleFader = b;}
    bool getFlagTelescopeCircles() const {return circleFader==true;}
    
    void setReticleColor(const Vec3f &c) {reticleColor = c;}
    const Vec3f& getReticleColor() const {return reticleColor;}
    
    const Vec3f& getLabelColor() const {return labelColor;}
    void setLabelColor(const Vec3f &c) {labelColor = c;}

    void setCircleColor(const Vec3f &c) {circleColor = c;}
    const Vec3f& getCircleColor() const {return circleColor;}
    
    void setFontSize(int fontSize);
    
    void slewTelescopeToSelectedObject(const int idx);

    void slewTelescopeToViewDirection(const int idx);
    
    void setFlagUseTelescopeServerLogs (bool b) {useTelescopeServerLogs = b;}

signals:
    void clientConnected(int slot, QString name);
    void clientDisconnected(int slot);

private slots:
    void translateActionDescriptions();

private:
    void drawPointer(const StelProjectorP& prj, const StelCore* core, StelPainter& sPainter);

    void communicate(void);
    
    LinearFader labelFader;
    LinearFader reticleFader;
    LinearFader circleFader;
    Vec3f reticleColor;
    Vec3f labelColor;
    Vec3f circleColor;  
    
    QFont labelFont;
    
    //Toolbar button to toggle the Slew window
    StelButton* toolbarButton;
    
    StelTextureSP reticleTexture;
    StelTextureSP selectionTexture;
    
    QMap<int, TelescopeClientP> telescopeClients;
    QHash<int, QProcess*> telescopeServerProcess;
    QStringList telescopeServers;
    QVariantMap telescopeDescriptions;
    QHash<QString, DeviceModel> deviceModels;
    
    QHash<ConnectionType, QString> connectionTypeNames;
    
    bool useTelescopeServerLogs;
    QHash<int, QFile*> telescopeServerLogFiles;
    QHash<int, QTextStream*> telescopeServerLogStreams;
    
    bool useServerExecutables;
    QString serverExecutablesDirectoryPath;
    
    //GUI
    TelescopeDialog * telescopeDialog;
    SlewDialog * slewDialog;
    
    bool isValidSlotNumber(int slot);
    bool isValidPort(uint port);
    bool isValidDelay(int delay);
    
    bool startServerAtSlot(int slot, QString serverName, int tcpPort, QString serialPort);
    bool stopServerAtSlot(int slot);

    bool startClientAtSlot(int slot, ConnectionType connectionType, QString name, QString equinox, QString host, int portTCP, int delay, QList<double> circles, QString serverName = QString(), QString portSerial = QString(), QString rts2Url = QString(), QString rts2Username = QString(), QString rts2Password = QString(), int rts2Refresh = -1);
    
    bool stopClientAtSlot(int slot);
    
    void loadTelescopeServerExecutables();
    
    void loadDeviceModels();
    
    bool restoreDeviceModelsListTo(QString deviceModelsListPath);
    
    void addLogAtSlot(int slot);
    void logAtSlot(int slot);
    void removeLogAtSlot(int slot);
    
    static void translations();
    
    QString actionGroupId;
    QString moveToSelectedActionId;
    QString moveToCenterActionId;
};



#include <QObject>
#include "StelPluginInterface.hpp"

class TelescopeControlStelPluginInterface : public QObject, public StelPluginInterface
{
    Q_OBJECT
    Q_PLUGIN_METADATA(IID StelPluginInterface_iid)
    Q_INTERFACES(StelPluginInterface)
public:
    virtual StelModule* getStelModule() const;
    virtual StelPluginInfo getPluginInfo() const;
    virtual QObjectList getExtensionList() const { return QObjectList(); }
};

#endif /*_TELESCOPE_CONTROL_HPP_*/