kstars/kstars/kstars.h

   1 /***************************************************************************
   2                           kstars.h  -  K Desktop Planetarium
   3                              -------------------
   4     begin                : Mon Feb  5 01:11:45 PST 2001
   5     copyright            : (C) 2001 by Jason Harris
   6     email                : jharris@30doradus.org
   7  ***************************************************************************/
   8 /***************************************************************************
   9  *                                                                         *
  10  *   This program is free software; you can redistribute it and/or modify  *
  11  *   it under the terms of the GNU General Public License as published by  *
  12  *   the Free Software Foundation; either version 2 of the License, or     *
  13  *   (at your option) any later version.                                   *
  14  *                                                                         *
  15  ***************************************************************************/
  16
  17 #ifndef KSTARS_H
  18 #define KSTARS_H
  19
  20 #ifdef HAVE_CONFIG_H
  21 #include <config.h>
  22 #endif
  23
  24 #include <dcopclient.h>
  25 #include <kapplication.h>
  26 #include <kmainwindow.h>
  27 #include <qwidget.h>
  28
  29 #include "kstarsinterface.h"
  30 #include "observinglist.h"
  31
  32 // forward declaration is enough. We only need pointers
  33 class QPalette;
  34 class QVBoxLayout;
  35 class KActionMenu;
  36 class KDialogBase;
  37 class KKey;
  38 class KToolBar;
  39
  40 class dms;
  41 class KSNewStuff;
  42 class KStarsData;
  43 class KStarsSplash;
  44 class SkyMap;
  45 class GeoLocation;
  46 class FindDialog;
  47 class LocationDialog;
  48 class TimeDialog;
  49 class ViewOpsDialog;
  50 class InfoBoxes;
  51 class ToggleAction;
  52 class TimeStepBox;
  53
  54 //class AstroCalc;
  55 class INDIMenu;
  56 class INDIDriver;
  57 class imagesequence;
  58
  59 /**@class KStars
  60         *This is the main window for KStars.  It is derived from KMainWindow.
  61         *In addition to the GUI elements, the class contains the program clock,
  62         *KStarsData, and SkyMap objects.
  63         *It also contains functions for the DCOP interface.
  64         *@short KStars base class
  65         *@author Jason Harris
  66         *@version 1.0
  67         */
  68
  69 class KStars : public KMainWindow, virtual public KStarsInterface
  70 {
  71
  72   Q_OBJECT
  73   public:
  74         /**Constructor.
  75                 *@param kstarsData the KStars Data object
  76                 */
  77                 KStars( KStarsData* kstarsData );
  78
  79         /**Constructor.
  80                 *@param doSplash should the splash panel be displayed during
  81                 *initialization.
  82                 *@param startClockRunning should the clock be running on startup?
  83                 */
  84                 KStars( bool doSplash, bool startClockRunning = true, const QString &startDateString = "" );
  85
  86         /**Destructor.  Synchs config file.  Deletes objects.
  87                 */
  88                 ~KStars();
  89
  90         /**@return pointer to KStarsData object which contains application data.
  91                 */
  92                 KStarsData* data();
  93
  94         /**@return pointer to the local sidereal time.
  95                 */
  96                 dms* LST();
  97
  98         /**@return pointer to SkyMap object which is the sky display widget.
  99                 */
 100                 SkyMap* map();
 101
 102         ObservingList* observingList();
 103
 104         /**@return pointer to GeoLocation object which is the current geographic location.
 105                 */
 106                 GeoLocation* geo();
 107
 108         /**@return pointer to InfoBoxes object.
 109                 */
 110                 InfoBoxes* infoBoxes();
 111
 112         /**@returns pointer to the INDI driver
 113                 */
 114                 INDIDriver* getINDIDriver(void) { return indidriver; }
 115
 116         /**@returns pointer to the INDI menu
 117                 */
 118                 INDIMenu* getINDIMenu(void) { return indimenu; }
 119
 120         /** Establish the INDI system. No GUI
 121                 */
 122                 void establishINDI();
 123
 124         /**Add an item to the color-scheme action manu
 125                 *@param name The name to use in the menu
 126                 *@param actionName The internal name for the action (derived from filename)
 127                 */
 128                 void addColorMenuItem( QString name, QString actionName );
 129
 130                 void removeColorMenuItem( QString actionName );
 131
 132         /**DCOP interface function.  Set focus to given Ra/Dec coordinates */
 133                 ASYNC setRaDec( double ra, double dec );
 134
 135         /**DCOP interface function.  Set focus to given Alt/Az coordinates. */
 136                 ASYNC setAltAz(double alt, double az);
 137
 138         /**DCOP interface function.
 139                 *Point in the direction described by the string argument.  */
 140                 ASYNC lookTowards( const QString direction );
 141
 142         /**DCOP interface function.  Zoom in. */
 143                 ASYNC zoomIn(void) { slotZoomIn(); };
 144
 145         /**DCOP interface function.  Zoom out. */
 146                 ASYNC zoomOut(void){ slotZoomOut(); };
 147
 148         /**DCOP interface function.  Default Zoom. */
 149                 ASYNC defaultZoom(void) { slotDefaultZoom(); }
 150
 151         /**DCOP interface function.  Set ZoomLevel manually. */
 152                 ASYNC zoom(double);
 153
 154         /**DCOP interface function.  Set local time and date. */
 155                 ASYNC setLocalTime(int yr, int mth, int day, int hr, int min, int sec);
 156
 157         /**DCOP interface function.  Pause for t seconds. */
 158                 ASYNC waitFor( double t );
 159
 160         /**DCOP interface function.  Pause until Key k is pressed. */
 161                 ASYNC waitForKey( const QString k );
 162
 163         /**DCOP interface function.  Toggle tracking. */
 164                 ASYNC setTracking( bool track );
 165
 166         /**DCOP interface function.  modify option. */
 167                 ASYNC changeViewOption( const QString option, const QString value );
 168
 169         /**DCOP interface function.  Show text message in a popup window. */
 170                 ASYNC popupMessage( int x, int y, const QString message );
 171
 172         /**DCOP interface function.  Draw a line on the sky. */
 173                 ASYNC drawLine( int x1, int y1, int x2, int y2, int speed );
 174
 175         /**DCOP interface function.  Set the geographic location. */
 176                 ASYNC setGeoLocation( const QString city, const QString province, const QString country );
 177
 178         /**DCOP interface function.  Set a color. */
 179                 ASYNC setColor( const QString colorName, const QString value );
 180
 181         /**DCOP interface function.  Load a color scheme. */
 182                 ASYNC loadColorScheme( const QString name );
 183
 184         /**DCOP interface function.  Export the sky image to a file. */
 185                 ASYNC exportImage( const QString filename, int width, int height );
 186
 187         /**DCOP interface function.  Print the sky image. */
 188                 ASYNC printImage( bool usePrintDialog, bool useChartColors );
 189
 190         /**DCOP interface function.  Establish an INDI driver. */
 191                 ASYNC startINDI (QString driverName, bool useLocal);
 192
 193         /**DCOP interface function. Shutdown an INDI driver. */
 194                 ASYNC shutdownINDI (QString driverName);
 195
 196         /**DCOP interface function.  Turn INDI driver on/off. */
 197                 ASYNC switchINDI(QString driverName, bool turnOn);
 198
 199         /**DCOP interface function.  Set INDI connection port. */
 200                 ASYNC setINDIPort(QString driverName, QString port);
 201
 202         /**DCOP interface function.  Set INDI target RA/DEC. */
 203                 ASYNC setINDITargetCoord(QString driverName, double RA, double DEC);
 204
 205         /**DCOP interface function.  Set INDI target RA/DEC. */
 206                 ASYNC setINDITargetName(QString driverName, QString objectName);
 207
 208         /**DCOP interface function.  Set INDI target by name lookup. */
 209                 ASYNC setINDIAction(QString driverName, QString action);
 210
 211         /**DCOP interface function.  Set INDI target by name lookup. */
 212                 ASYNC waitForINDIAction(QString driverName, QString action);
 213
 214         /**DCOP interface function.  Set INDI focus speed. */
 215                 ASYNC setINDIFocusSpeed(QString driverName, QString action);
 216
 217         /**DCOP interface function.  Set INDI focus direction and focus. */
 218                 ASYNC startINDIFocus(QString driverName, int focusDir);
 219
 220         /**DCOP interface function.  Set INDI geographical information. */
 221                 ASYNC setINDIGeoLocation(QString driverName, double longitude, double latitude);
 222
 223         /**DCOP interface function.  Sets focus operation timeout. */
 224                 ASYNC setINDIFocusTimeout(QString driverName, int timeout);
 225
 226         /**DCOP interface function.  Start camera exposure with a timeout. */
 227                 ASYNC startINDIExposure(QString driverName, int timeout);
 228
 229         /**DCOP interface function.  Set INDI UTC date and time. */
 230                 ASYNC setINDIUTC(QString driverName, QString UTCDateTime);
 231
 232         /**DCOP interface function. Set INDI Telescope action. */
 233                 ASYNC setINDIScopeAction(QString deviceName, QString action);
 234
 235         /**DCOP interface function. Set CCD camera frame type. */
 236                 ASYNC setINDIFrameType(QString deviceName, QString type);
 237
 238         /**DCOP interface function. Set CCD target temperature. */
 239                 ASYNC setINDIFilterNum(QString deviceName, int filter_num);
 240
 241         /**DCOP interface function. Set CCD target temperature. */
 242                 ASYNC setINDICCDTemp(QString deviceName, int temp);
 243
 244         public slots:
 245                 /**
 246                         *Update time-dependent data and (possibly) repaint the sky map.
 247                         */
 248                 void updateTime( const bool automaticDSTchange = true );
 249
 250                 /**
 251                         *Apply new settings and redraw skymap
 252                         */
 253                 void slotApplySettings( void );
 254
 255                 /**
 256                         *Zoom in
 257                         */
 258                 void slotZoomIn();
 259
 260                 /**
 261                         *Zoom out
 262                         */
 263                 void slotZoomOut();
 264
 265                 void slotDefaultZoom();
 266                 void slotSetZoom();
 267
 268         /**
 269                 *action slot: Toggle whether kstars is tracking current position
 270                 */
 271                 void slotTrack();
 272
 273         /**
 274                 *action slot: open dialog for selecting a new geographic location
 275                 */
 276                 void slotGeoLocator();
 277
 278                 /* Delete FindDialog because ObjNames list has changed in KStarsData due to
 279                 *reloading star data. So list in FindDialog must be new filled with current data.
 280                 */
 281                 void clearCachedFindDialog();
 282
 283                 void resumeDCOP( void ) { kapp->dcopClient()->resume(); }
 284
 285                 void slotClearAllTrails();
 286
 287         private slots:
 288                 /**
 289                         *action slot: synch kstars clock to system time
 290                         */
 291                 void slotSetTimeToNow();
 292
 293                 /**
 294                         *action slot: open a dialog for setting the time and date
 295                         */
 296                 void slotSetTime();
 297
 298                 /**
 299                         *action slot: toggle whether kstars clock is running or not
 300                         */
 301                 void slotToggleTimer();
 302
 303                 /**
 304                         *action slot: open dialog for finding a named object
 305                         */
 306                 void slotFind();
 307
 308                 /**
 309                  * action slot: open KStars setup wizard
 310                  */
 311                 void slotWizard();
 312
 313                 /**
 314                  * action slot: open KNewStuff window to download extra data.
 315                  */
 316                 void slotDownload();
 317
 318                 /**
 319                  * action slot: open KStars calculator to compute astronomical
 320                  * ephemeris
 321                  */
 322
 323                 void slotCalculator();
 324
 325                 /**
 326                  * action slot: open KStars AAVSO Light Curve Generator
 327                  */
 328
 329                 void slotLCGenerator();
 330
 331                 /**
 332                 * action slot: open Elevation vs. Time tool
 333                 */
 334
 335                 void slotAVT();
 336
 337                 /**
 338                  * action slot: open What's up tonight dialog
 339                  */
 340                  void slotWUT();
 341
 342                 /**
 343                  * action slot: open ScriptBuilder dialog
 344                  */
 345                 void slotScriptBuilder();
 346
 347                 /**
 348                  * action slot: open Solar system viewer
 349                  */
 350                 void slotSolarSystem();
 351
 352                 /**
 353                  * action slot: open Jupiter Moons tool
 354                  */
 355                 void slotJMoonTool();
 356
 357                 /**
 358                  * action slot: open Telescope wizard
 359                  */
 360                 void slotTelescopeWizard();
 361
 362                 /**
 363                  * action slot: open Image Sequence dialog
 364                  */
 365                 void slotImageSequence();
 366
 367                  /**
 368                  * action slot: open INDI driver panel
 369                  */
 370                 void slotINDIDriver();
 371
 372                  /**
 373                  * action slot: open INDI control panel
 374                  */
 375                 void slotINDIPanel();
 376
 377                 /**
 378                  * action slot: open INDI configuration dialog
 379                  */
 380                 void slotINDIConf();
 381
 382                 /**
 383                         *action slot: open dialog for setting the view options
 384                         */
 385                 void slotViewOps();
 386
 387                 /** finish setting up after the kstarsData has finished
 388                  */
 389                 void datainitFinished(bool worked);
 390
 391                 /**Open new KStars window. */
 392                 void newWindow();
 393
 394                 /**Close KStars window. */
 395                 void closeWindow();
 396
 397                 /** Open FITS image. */
 398                 void slotOpenFITS();
 399
 400                 /**Action slot to save the sky image to a file.*/
 401                 void slotExportImage();
 402
 403                 /**Action slot to select a DCOP script and run it.*/
 404                 void slotRunScript();
 405
 406                 /**Action slot to print skymap. */
 407                 void slotPrint();
 408
 409                 /**Action slot to show tip-of-the-day window. */
 410                 void slotTipOfDay();
 411
 412                 /**Action slot to set focus coordinates manually (opens FocusDialog). */
 413                 void slotManualFocus();
 414
 415                 /**Meta-slot to point the focus at special points (zenith, N, S, E, W).
 416                         *Uses the name of the Action which sent the Signal to identify the
 417                         *desired direction.  */
 418                 void slotPointFocus();
 419
 420                 /**Meta-slot to set the color scheme according to the name of the
 421                         *Action which sent the activating signal.  */
 422                 void slotColorScheme();
 423
 424                 /**Select the Target symbol (a.k.a. field-of-view indicator) */
 425                 void slotTargetSymbol();
 426
 427                 void slotFOVEdit();
 428
 429                 /**Toggle between Equatorial and Ecliptic coordinte systems */
 430                 void slotCoordSys();
 431
 432   /** Toggle display of the observing list */
 433                 void slotObsList();
 434
 435                 /**Meta-slot to handle display toggles for all of the viewtoolbar buttons.
 436                         *uses the name of the sender to identify the item to change.  */
 437                 void slotViewToolBar();
 438
 439                 /**Meta-slot to handle toggling display of GUI elements (toolbars and infoboxes)
 440                         *uses name of the sender action to identify the widget to hide/show.  */
 441                 void slotShowGUIItem( bool );
 442
 443                 /**Re-assign the input focus to the SkyMap widget.
 444                         */
 445                 void mapGetsFocus();
 446
 447                 /**Toggle to and from full screen mode */
 448                 void slotFullScreen();
 449
 450         private:
 451                 /**
 452                         *Initialize Menu bar.
 453                         */
 454                 void initActions();
 455
 456                 void initFOV();
 457
 458                 /**
 459                         *Initialize Status bar.
 460                         */
 461                 void initStatusBar();
 462
 463                 SkyMap *skymap;
 464
 465                 QWidget *centralWidget;
 466                 QVBoxLayout *topLayout;
 467
 468                 KToolBar *viewToolBar;
 469                 TimeStepBox *TimeStep;
 470
 471                 ToggleAction *actCoordSys;
 472                 ToggleAction *actObsList;
 473                 KActionMenu *colorActionMenu, *fovActionMenu;
 474
 475                 KDialogBase *AAVSODialog;
 476                 FindDialog *findDialog;
 477                 KSNewStuff *kns;
 478
 479                 INDIMenu *indimenu;
 480                 INDIDriver *indidriver;
 481                 imagesequence *indiseq;  /* We need imgsequence here because it runs in batch mode */
 482
 483                 int idSpinBox;
 484                 bool DialogIsObsolete;
 485                 bool StartClockRunning;
 486                 QString StartDateString;
 487
 488                 QPalette OriginalPalette, DarkPalette;
 489
 490                 class privatedata;
 491                 friend class privatedata;
 492                 privatedata *pd;
 493         ObservingList *obsList;
 494 };
 495
 496 class KStars::privatedata {
 497         public:
 498                 KStars *ks;
 499                 KStarsSplash *splash;
 500                 KStarsData *kstarsData;
 501
 502                 privatedata(KStars *parent) : ks(parent), splash(0), kstarsData(0) {};
 503                 void buildGUI();
 504
 505                 ~privatedata();
 506 };
 507
 508 #endif