kstars.h

Go to the documentation of this file.

/***************************************************************************
                          kstars.h  -  K Desktop Planetarium
                             -------------------
    begin                : Mon Feb  5 01:11:45 PST 2001
    copyright            : (C) 2001 by Jason Harris
    email                : jharris@30doradus.org
 ***************************************************************************/
/***************************************************************************
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef KSTARS_H_
#define KSTARS_H_

#include <QtDBus/QtDBus>
#include <kxmlguiwindow.h>
#include <QtDeclarative/QDeclarativeView>

#include <config-kstars.h>

#include "tools/observinglist.h"
#include "oal/equipmentwriter.h"
#include "oal/observeradd.h"

class WIUserSettings;
// forward declaration is enough. We only need pointers
class QPalette;
class KActionMenu;

class dms;
class KStarsData;
class SkyMap;
class GeoLocation;
class FindDialog;
class TimeStepBox;
class ImageExporter;

class GUIManager;
class DriverManager;

class AltVsTime;
class WUTDialog;
class WIView;
class WILPSettings;
class WIEquipSettings;
class ObsConditions;
class AstroCalc;
class SkyCalendar;
class ScriptBuilder;
class PlanetViewer;
class JMoonTool;
class MoonPhaseTool;
class FlagManager;
class ObservingList;
class EquipmentWriter;
class ObserverAdd;
class Execute;
class ExportImageDialog;
class PrintingWizard;

class OpsCatalog;
class OpsGuides;
class OpsSolarSystem;
class OpsSatellites;
class OpsSupernovae;
class OpsColors;
class OpsAdvanced;
class OpsINDI;
class OpsEkos;
class EkosManager;
#ifdef HAVE_XPLANET
class OpsXplanet;
#endif

// KStars is now a singleton class. Use KStars::createInstance() to
// create an instance and KStars::Instance() to get a pointer to the
// instance
// asimha, 9th May 2009

class KStars : public KXmlGuiWindow
{
    Q_OBJECT
    Q_CLASSINFO("D-Bus Interface", "org.kde.kstars")

private:
    explicit KStars( bool doSplash, bool startClockRunning = true, const QString &startDateString = QString() );

    static KStars *pinstance; // Pointer to an instance of KStars

public:
    static KStars *createInstance( bool doSplash, bool clockrunning = true, const QString &startDateString = QString() );

    inline static KStars *Instance() { return pinstance; }

    virtual ~KStars();

    inline KStarsData* data() const { return kstarsData; }

    inline SkyMap* map() const { return skymap; }

    inline ObservingList* observingList() const { return obsList; }

    inline EkosManager *ekosManager() const { return ekosmenu; }

    Execute* getExecute();

    void addColorMenuItem( const QString &name, const QString &actionName );

    void removeColorMenuItem( const QString &actionName );

    void applyConfig( bool doApplyFocus = true );

    inline FlagManager* getFlagManager() const { return fm; }

    inline PrintingWizard* getPrintingWizard() const { return printingWizard; }

    void showImgExportDialog();

    void syncFOVActions();

    void hideAllFovExceptFirst();

    void selectNextFov();

    void selectPreviousFov();

    void showWISettingsUI();

    void showWI(ObsConditions *obs);

public Q_SLOTS:
    Q_SCRIPTABLE Q_NOREPLY void setRaDec( double ra, double dec );

    Q_SCRIPTABLE Q_NOREPLY void setAltAz(double alt, double az);

    Q_SCRIPTABLE Q_NOREPLY void lookTowards( const QString &direction );

    Q_SCRIPTABLE Q_NOREPLY void addLabel( const QString &name );

    Q_SCRIPTABLE Q_NOREPLY void removeLabel( const QString &name );

    Q_SCRIPTABLE Q_NOREPLY void addTrail( const QString &name );

    Q_SCRIPTABLE Q_NOREPLY void removeTrail( const QString &name );

    Q_SCRIPTABLE Q_NOREPLY void zoomIn();

    Q_SCRIPTABLE Q_NOREPLY void zoomOut();

    Q_SCRIPTABLE Q_NOREPLY void defaultZoom();

    Q_SCRIPTABLE Q_NOREPLY void zoom(double z);

    Q_SCRIPTABLE Q_NOREPLY void setLocalTime(int yr, int mth, int day, int hr, int min, int sec);

    Q_SCRIPTABLE Q_NOREPLY void waitFor( double t );

    Q_SCRIPTABLE Q_NOREPLY void waitForKey( const QString &k );

    Q_SCRIPTABLE Q_NOREPLY void setTracking( bool track );

    Q_SCRIPTABLE Q_NOREPLY void changeViewOption( const QString &option, const QString &value );

    QString getOption( const QString &name );

    Q_SCRIPTABLE Q_NOREPLY void readConfig();

    Q_SCRIPTABLE Q_NOREPLY void writeConfig();

    Q_SCRIPTABLE Q_NOREPLY void popupMessage( int x, int y, const QString &message );

    Q_SCRIPTABLE Q_NOREPLY void drawLine( int x1, int y1, int x2, int y2, int speed );

    Q_SCRIPTABLE Q_NOREPLY void setGeoLocation( const QString &city, const QString &province, const QString &country );

    Q_SCRIPTABLE Q_NOREPLY void setColor( const QString &colorName, const QString &value );

    Q_SCRIPTABLE Q_NOREPLY void loadColorScheme( const QString &name );

    Q_SCRIPTABLE Q_NOREPLY void exportImage( const QString &filename, int width = -1, int height = -1, bool includeLegend = false );

    Q_SCRIPTABLE QString getDSSURL( const QString &objectName );

    Q_SCRIPTABLE QString getDSSURL( double RA_J2000, double Dec_J2000, float width = 15, float height = 15 );

    Q_SCRIPTABLE QString getObjectDataXML( const QString &objectName );

    Q_SCRIPTABLE Q_NOREPLY void setApproxFOV( double FOV_Degrees );

    Q_SCRIPTABLE QString getSkyMapDimensions();

    Q_SCRIPTABLE QString getObservingWishListObjectNames();

    Q_SCRIPTABLE QString getObservingSessionPlanObjectNames();

    Q_SCRIPTABLE Q_NOREPLY void printImage( bool usePrintDialog, bool useChartColors );

    // TODO INDI Scripting to be supported in KDE 4.1
    #if 0

    Q_SCRIPTABLE Q_NOREPLY void startINDI (const QString &deviceName, bool useLocal);

    Q_SCRIPTABLE Q_NOREPLY void setINDIDevice (const QString &deviceName);

    Q_SCRIPTABLE Q_NOREPLY void shutdownINDI (const QString &driverName);

    Q_SCRIPTABLE Q_NOREPLY void switchINDI(bool turnOn);

    Q_SCRIPTABLE Q_NOREPLY void setINDIPort(const QString &port);

    Q_SCRIPTABLE Q_NOREPLY void setINDITargetCoord(double RA, double DEC);

    Q_SCRIPTABLE Q_NOREPLY void setINDITargetName(const QString &objectName);

    Q_SCRIPTABLE Q_NOREPLY void setINDIAction(const QString &action);

    Q_SCRIPTABLE Q_NOREPLY void waitForINDIAction(const QString &action);

    Q_SCRIPTABLE Q_NOREPLY void setINDIFocusSpeed(unsigned int speed);

    Q_SCRIPTABLE Q_NOREPLY void startINDIFocus(int focusDir);

    Q_SCRIPTABLE Q_NOREPLY void setINDIGeoLocation(double longitude, double latitude);

    Q_SCRIPTABLE Q_NOREPLY void setINDIFocusTimeout(int timeout);

    Q_SCRIPTABLE Q_NOREPLY void startINDIExposure(int timeout);

    Q_SCRIPTABLE Q_NOREPLY void setINDIUTC(const QString &UTCDateTime);

    Q_SCRIPTABLE Q_NOREPLY void setINDIScopeAction(const QString &action);

    Q_SCRIPTABLE Q_NOREPLY void setINDIFrameType(const QString &type);

    Q_SCRIPTABLE Q_NOREPLY void setINDIFilterNum(int filter_num);

    Q_SCRIPTABLE Q_NOREPLY void setINDICCDTemp(int temp);

    #endif

    void updateTime( const bool automaticDSTchange = true );

    void slotSetTimeToNow();

    void slotApplyConfigChanges();

    void slotApplyWIConfigChanges();

    void slotZoomChanged();

    void slotSetZoom();

    void slotTrack();

    void slotGeoLocator();

    void clearCachedFindDialog();

    void slotClearAllTrails();

    void slotShowPositionBar(SkyPoint*);

    void slotFlagManager();

private slots:
    void slotSetTime();

    void slotToggleTimer();
    
    void slotStepForward();
    
    void slotStepBackward();

    void slotFind();

    void slotWizard();

    void slotDownload();

    void slotCalculator();

    void slotAVT();

    void slotWUT();

    void slotWISettings();

    void slotShowWIView(int status);

    void slotCalendar();

    void slotGlossary();

    void slotScriptBuilder();

    void slotSolarSystem();

    void slotJMoonTool();

    void slotMoonPhaseTool();

    void slotTelescopeWizard();

    void slotINDIDriver();

    void slotINDIPanel();

    void slotEkos();

    void slotViewOps();

    void datainitFinished();

    void slotOpenFITS();

    void slotExportImage();

    void slotRunScript();

    void slotPrint();

    void slotPrintingWizard();

    void slotTipOfDay();

    void slotManualFocus();

    void slotPointFocus();

    void slotColorScheme();

    void slotTargetSymbol(bool flag);

    void slotFOVEdit();

    void slotCoordSys();

    void slotMapProjection();

    void slotObsList();

    void slotViewToolBar();

    void slotShowGUIItem( bool );

    void slotFullScreen();

    void slotAboutToQuit();

    void slotEquipmentWriter();

    void slotObserverAdd();

    void slotExecute();

    void slotUpdateComets();

    void slotUpdateAsteroids();

    void slotUpdateSupernovae();

private:
    void repopulateFOV();

    void initActions();

    void initStatusBar();

    void initFocus();

    void buildGUI();

    KStarsData *kstarsData;
    SkyMap *skymap;

    TimeStepBox *TimeStep;

    KActionMenu *colorActionMenu, *fovActionMenu;

    FindDialog *findDialog;
    ExportImageDialog *imgExportDialog;
    ImageExporter *imageExporter;

    //FIXME: move to KStarsData
    ObservingList *obsList;
    EquipmentWriter *eWriter;
    ObserverAdd *oAdd;
    Execute *execute;
    AltVsTime *avt;
    WUTDialog *wut;
    WIView *wi;
    WILPSettings *wiLPSettings;
    WIEquipSettings *wiEquipSettings;
    ObsConditions *wiObsConditions;
    QDockWidget *wiDock;
    SkyCalendar *skycal;
    ScriptBuilder *sb;
    PlanetViewer *pv;
    JMoonTool *jmt;
    MoonPhaseTool *mpt;
    FlagManager *fm;
    AstroCalc *astrocalc;
    PrintingWizard *printingWizard;

    EkosManager *ekosmenu;

    QActionGroup *projectionGroup, *cschemeGroup;

    bool DialogIsObsolete;
    bool StartClockRunning;
    QString StartDateString;

    QPalette OriginalPalette, DarkPalette;

    OpsCatalog *opcatalog;
    OpsGuides *opguides;
    OpsSolarSystem *opsolsys;
    OpsSatellites *opssatellites;
    OpsSupernovae *opssupernovae;
    OpsColors *opcolors;
    OpsAdvanced *opadvanced;
    OpsINDI *opsindi;
    OpsEkos *opsekos;
#ifdef HAVE_XPLANET
    OpsXplanet  *opsxplanet;
#endif
};

#endif