Core.hh 37.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
/*===========================================================================*\
 *                                                                           *
 *                              OpenFlipper                                  *
 *      Copyright (C) 2001-2009 by Computer Graphics Group, RWTH Aachen      *
 *                           www.openflipper.org                             *
 *                                                                           *
 *---------------------------------------------------------------------------*
 *  This file is part of OpenFlipper.                                        *
 *                                                                           *
 *  OpenFlipper is free software: you can redistribute it and/or modify      *
 *  it under the terms of the GNU Lesser General Public License as           *
 *  published by the Free Software Foundation, either version 3 of           *
 *  the License, or (at your option) any later version with the              *
 *  following exceptions:                                                    *
 *                                                                           *
 *  If other files instantiate templates or use macros                       *
 *  or inline functions from this file, or you compile this file and         *
 *  link it with other files to produce an executable, this file does        *
 *  not by itself cause the resulting executable to be covered by the        *
 *  GNU Lesser General Public License. This exception does not however       *
 *  invalidate any other reasons why the executable file might be            *
 *  covered by the GNU Lesser General Public License.                        *
 *                                                                           *
 *  OpenFlipper 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 Lesser General Public License for more details.                      *
 *                                                                           *
 *  You should have received a copy of the GNU LesserGeneral Public          *
 *  License along with OpenFlipper. If not,                                  *
 *  see <http://www.gnu.org/licenses/>.                                      *
 *                                                                           *
\*===========================================================================*/

/*===========================================================================*\
 *                                                                           *
 *   $Revision$                                                         *
 *   $Author$                                                      *
 *   $Date$                   *
 *                                                                           *
\*===========================================================================*/
Jan Möbius's avatar
 
Jan Möbius committed
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62




//=============================================================================
//
//  CLASS Core
//
//=============================================================================

/**
 * \file Core.hh
 * This File contains the header of the frameworks system core
*/

#ifndef MVIEWWIDGET_HH
#define MVIEWWIDGET_HH


//== INCLUDES =================================================================

63
#include <OpenFlipper/widgets/glWidget/QtBaseViewer.hh>
Jan Möbius's avatar
 
Jan Möbius committed
64 65 66 67 68 69 70 71 72 73

// QT INCLUDES
#include <qvariant.h>
#include <qmainwindow.h>
#include <QToolBox>
#include <QStackedWidget>
#include <QSplashScreen>

#include <QDockWidget>
#include <QVector>
74
#include <QProgressDialog>
Jan Möbius's avatar
 
Jan Möbius committed
75 76 77 78 79 80 81 82 83 84 85 86

#include <QtScript/QScriptEngine>
#include <QtScript/QtScript>

#include "OpenFlipper/INIFile/INIFile.hh"

#include "OpenFlipper/Logging/Logging.hh"
#include "OpenFlipper/Scripting/Scripting.hh"

// Prototypes for scripting
#include "OpenFlipper/Scripting/scriptPrototypes/prototypeVec3d.hh"
#include "OpenFlipper/Scripting/scriptPrototypes/prototypeMatrix4x4.hh"
87
#include "OpenFlipper/Scripting/scriptPrototypes/prototypeDataType.hh"
Jan Möbius's avatar
 
Jan Möbius committed
88 89
#include <OpenFlipper/Scripting/scriptWrappers/vec3dWrapper.hh>
#include <OpenFlipper/Scripting/scriptWrappers/matrix4x4Wrapper.hh>
90
#include <OpenFlipper/Scripting/scriptWrappers/DataTypeWrapper.hh>
Jan Möbius's avatar
 
Jan Möbius committed
91 92 93 94 95
// #include <OpenFlipper/Scripting/scriptWrappers/ObjectIdWrapper.hh>

// Required Interface definition ( Some variables were defined there )
#include "OpenFlipper/BasePlugin/BaseInterface.hh"
#include "OpenFlipper/BasePlugin/FileInterface.hh"
96
#include "OpenFlipper/BasePlugin/TypeInterface.hh"
Jan Möbius's avatar
 
Jan Möbius committed
97 98 99 100 101
#include "OpenFlipper/BasePlugin/MenuInterface.hh"
#include "OpenFlipper/BasePlugin/ContextMenuInterface.hh"

#include <OpenFlipper/widgets/coreWidget/CoreWidget.hh>

102 103 104
// Process manager widget
#include <OpenFlipper/widgets/processManagerWidget/processManagerWidget.hh>

Jan Möbius's avatar
 
Jan Möbius committed
105 106
#include <OpenFlipper/common/GlobalOptions.hh>

Dirk Wilden's avatar
Dirk Wilden committed
107 108
#include <OpenFlipper/Core/PluginInfo.hh>

109
#include <ACG/Scenegraph/CoordsysNode.hh>
110
#include <ACG/Scenegraph/GridNode.hh>
111

112 113
#include <OpenFlipper/threads/JobInfo.hh>

Jan Möbius's avatar
 
Jan Möbius committed
114 115 116
//== CLASS DEFINITION =========================================================

struct fileTypes {
Dirk Wilden's avatar
Dirk Wilden committed
117
  QString name;
Jan Möbius's avatar
 
Jan Möbius committed
118 119 120 121
  DataType type;
  QString loadFilters;
  QString saveFilters;
  FileInterface* plugin;
Dirk Wilden's avatar
Dirk Wilden committed
122
  QObject* object;
123
  bool saveMultipleObjects;
Jan Möbius's avatar
 
Jan Möbius committed
124 125
};

126 127 128 129 130 131
struct dataTypes {
  QString name;
  DataType type;
  TypeInterface* plugin;
};

Jan Möbius's avatar
 
Jan Möbius committed
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
/** Core Widget of the Application
 */
class Core : public QObject
{
  Q_OBJECT

public:

  /// constructor
  Core();

  void init();

  /// destructor
  ~Core();

  /// Synchronise two viewers
  bool add_sync_host(const QString& _name);


private slots:

  /// Handle Mouse events when in Identifier mode
  void slotMouseEventIdentify( QMouseEvent* _event );

protected:

    //===========================================================================
    /** @name Signals send to Plugins
    * @{ */
   //===========================================================================
signals:
Jan Möbius's avatar
Jan Möbius committed
164
   /// Signal send to plugins when whole scene is cleared
Jan Möbius's avatar
Jan Möbius committed
165
   void allCleared();
166

Jan Möbius's avatar
 
Jan Möbius committed
167
   /// When this Signal is emitted all Plugins are informed that the object list changed
168
   void signalObjectUpdated(int);
Jan Möbius's avatar
 
Jan Möbius committed
169

Dirk Wilden's avatar
Dirk Wilden committed
170 171 172
   /// When this Signal is emitted all Plugins are informed that some type of update was performed on an object
   void signalObjectUpdated(int, const UpdateType);
   
Jan Möbius's avatar
 
Jan Möbius committed
173 174 175 176 177 178 179 180 181
   /// When this Signal is emitted when a Wheel Event occures
   void PluginWheelEvent(QWheelEvent * , const std::string & );

   /// When this Signal is emitted when a Mouse Event occures
   void PluginMouseEvent(QMouseEvent* );

   /// Emitted when an identify event occurs
   void PluginMouseEventIdentify( QMouseEvent* );

182 183
   /// This signal is emitted if the object has been changed (source/target)
   void objectSelectionChanged( int );
184

185 186
   /// This signal is emitted if one of the viewers updated its view
   void pluginViewChanged();
Jan Möbius's avatar
 
Jan Möbius committed
187

Dirk Wilden's avatar
Dirk Wilden committed
188 189 190
   /// The texture with the given name and filename has been added
   void addTexture( QString, QString , uint, int );

Jan Möbius's avatar
 
Jan Möbius committed
191 192 193
   /// The texture with the given name and filename has been added
   void addTexture( QString, QString , uint );

194 195 196
   /// The texture with the given name and filename has been added
   void addMultiTexture( QString _textureGroup , QString _name , QString _filename , int _id , int& _textureId );

Jan Möbius's avatar
 
Jan Möbius committed
197 198 199 200 201 202 203 204 205
   /// Tell the plugins to update the given texture
   void updateTexture( QString , int );

   /// Update all textures in the plugins
   void updateAllTextures( );

   /// This Signal is send to the plugins if a texture has been updated
   void updatedTextures( QString , int );

Dirk Wilden's avatar
Dirk Wilden committed
206 207 208
   /// A texture mode should be changed
   void setTextureMode(QString _textureName ,QString _mode, int _id);

Jan Möbius's avatar
 
Jan Möbius committed
209 210 211
   /// A texture mode should be changed
   void setTextureMode(QString _textureName ,QString _mode);

Dirk Wilden's avatar
Dirk Wilden committed
212 213 214
   /// Switch Texture Plugins to a given Mode
   void switchTexture( QString, int );

Jan Möbius's avatar
 
Jan Möbius committed
215 216 217
   /// Switch Texture Plugins to a given Mode
   void switchTexture( QString );

218 219 220 221 222 223
   /// Change the image for a given texture
   void textureChangeImage( QString _textureName , QImage& _image );

   /// Change the image for a given texture
   void textureChangeImage( QString _textureName , QImage& _image , int _id );

224 225 226 227 228
   ///fetch texture image
   void textureGetImage( QString _textureName , QImage& _image );

   ///fetch texture image
   void textureGetImage( QString _textureName , QImage& _image , int _id );
229 230 231 232 233 234 235

   /// get the texture index
   void textureIndex( QString _textureName, int _id, int& _index);
   
   /// get the texture name
   void textureName( int _id, int _textureIndex, QString& _textureName);

236 237 238 239 240 241
   ///get current texture
   void getCurrentTexture( int _id, QString& _textureName );

   /// get a multi-texture's sub textures
   void getSubTextures( int _id, QString _multiTextureName, QStringList& _subTextures );

Jan Möbius's avatar
 
Jan Möbius committed
242 243 244 245 246 247 248 249 250 251 252 253
   /// If an ini File is opened, this signal is send to Plugins capable of handling ini files
   void iniLoad( INIFile&, int );

   /// This signal is used to tell the plugins to save the data of _id to the given file
   void iniSave( INIFile& _ini ,int _id );

   /// This signal is used to tell the plugins to save their current status
   void iniSaveOptions(  INIFile& _ini );

   /// This signal is used to tell the plugins to load their new status
   void iniLoadOptions(  INIFile& _ini );

254 255 256
   /// This signal is used to tell the plugins to load their new status after objects are loaded
   void iniLoadOptionsLast(  INIFile& _ini );

257 258 259
   /// This signal is emitted before the core deletes its data and exits
   void saveOnExit( INIFile& _ini );

Jan Möbius's avatar
 
Jan Möbius committed
260 261 262 263 264 265
   /// Tell plugins to create a backup
   void createBackup( int _id , QString _name , int nextBackupId_);

   /// Tell the plugins that a file has been opened ( -> Database)
   void openedFile( int _id );

Dirk Wilden's avatar
Dirk Wilden committed
266 267 268
   /// Tell the plugins that an empty object has been added
   void emptyObjectAdded( int _id);

Jan Möbius's avatar
 
Jan Möbius committed
269 270 271
   /// Called after all plugins are loaded
   void pluginsInitialized();

272 273 274
   /// Tell plugins that the visibility of an object has changed
   void visibilityChanged(int _id);

Jan Möbius's avatar
Jan Möbius committed
275 276 277
   /// Tell plugins that object properties such as object names have been changed
   void objectPropertiesChanged( int _id );

278 279 280
   /// Called after an object has been deleted
   void objectDeleted( int );

Jan Möbius's avatar
 
Jan Möbius committed
281 282 283 284 285 286 287 288 289 290 291
   /** @} */

   //===========================================================================
    /** @name Slots called by the plugins
    * @{ */
   //===========================================================================
   private slots :

      /** Called by the plugins if they changed something in the object list (deleted, added,...)
       * @param _identifier Id of the object
       */
Dirk Wilden's avatar
Dirk Wilden committed
292
      void slotObjectUpdated(int _identifier, const UpdateType _type = UPDATE_ALL);
Jan Möbius's avatar
 
Jan Möbius committed
293

294
      /// Called when a plugin changes the visibility of an object
295
      void slotVisibilityChanged(int _id);
296

Jan Möbius's avatar
Jan Möbius committed
297 298 299
      /// Called by plugins if object properties like names have changed
      void slotObjectPropertiesChanged( int _id );

Jan Möbius's avatar
 
Jan Möbius committed
300
      /// Called by Plugins if they changed the active object
301
      void slotObjectSelectionChanged( int _id);
Jan Möbius's avatar
 
Jan Möbius committed
302 303 304 305 306 307 308

      /// Add a new picking mode to the examiner_widget_
      void slotAddPickMode( const std::string _mode );

      /// Add a new and invisible picking mode to the examiner_widget_
      void slotAddHiddenPickMode( const std::string _mode );

Dirk Wilden's avatar
Dirk Wilden committed
309 310 311
      /// Called by a plugin if it creates a texture
      void slotAddTexture( QString _textureName , QString _filename , uint _dimension , int _id );

Jan Möbius's avatar
 
Jan Möbius committed
312 313 314
      /// Called by a plugin if it creates a texture
      void slotAddTexture( QString _textureName , QString _filename , uint _dimension );

315 316 317
      /// Called by a plugin if it creates a multitexture
      void slotMultiTextureAdded( QString _textureGroup , QString _name , QString _filename , int _id , int& _textureId );

Jan Möbius's avatar
 
Jan Möbius committed
318 319 320 321 322 323 324 325 326
      /// Tell the plugins to update the given texture
      void slotUpdateTexture( QString _name , int _identifier);

      /// Update all textures in the plugins
      void slotUpdateAllTextures( );

      /// A Texture has been updated
      void slotTextureUpdated( QString _textureName , int _identifier );

Dirk Wilden's avatar
Dirk Wilden committed
327 328 329
      /// A texture mode should be changed
      void slotSetTextureMode(QString _textureName ,QString _mode, int _id);

Jan Möbius's avatar
 
Jan Möbius committed
330 331 332
      /// A texture mode should be changed
      void slotSetTextureMode(QString _textureName ,QString _mode);

Dirk Wilden's avatar
Dirk Wilden committed
333 334 335
      /// Tells Plugins to switch to the given Texture
      void slotSwitchTexture( QString _textureName, int _id );

Jan Möbius's avatar
 
Jan Möbius committed
336 337 338
      /// Tells Plugins to switch to the given Texture
      void slotSwitchTexture( QString _textureName );

339 340 341 342 343 344
      ///Called by plugins if texture image should be changed
      void slotTextureChangeImage( QString _textureName , QImage& _image );

      ///Called by plugins if texture image should be changed
      void slotTextureChangeImage( QString _textureName , QImage& _image , int _id );

345 346 347 348 349 350
      ///Called by plugins if texture image should be fetched
      void slotTextureGetImage( QString _textureName , QImage& _image );

      ///Called by plugins if texture image should be fetched
      void slotTextureGetImage( QString _textureName , QImage& _image , int _id );
      
351 352 353 354 355 356
      ///Called by plugins if texture index should be fetched
      void slotTextureIndex( QString _textureName, int _id, int& _index);
      
      ///Called by plugins if texture name should be fetched
      void slotTextureName( int _id, int _textureIndex, QString& _textureName);
      
357 358 359 360 361 362
      ///Called by plugins if current texture should be retrieved
      void slotGetCurrentTexture( int _id, QString& _textureName );

      ///Called by plugins if a multi-texture's sub textures should be fetched
      void slotGetSubTextures( int _id, QString _multiTextureName, QStringList& _subTextures );

Jan Möbius's avatar
 
Jan Möbius committed
363 364 365 366 367 368
      /// Called if a backup is requested by the plugins
      void backupRequest( int _id , QString _name );

      /// A plugin wants to load a given file
      void slotLoad(QString _filename, DataType _type, int& _id);

Dirk Wilden's avatar
Dirk Wilden committed
369 370 371
      /// the load widget wants to load a given file
      void slotLoad(QString _filename, int _pluginID);
      
Jan Möbius's avatar
 
Jan Möbius committed
372 373 374 375 376 377
      /// Called when a file has been opened
      void slotObjectOpened ( int _id );

      /// Called when an empty object has been Added
      void slotEmptyObjectAdded ( int _id );

Jan Möbius's avatar
Jan Möbius committed
378 379 380 381 382 383 384
      /** \brief Called when a plugin requests a list of file-filters
      *
      * This function collects all available load filters from the file Plugins.
      * It is normally called via the Load/Save interface ( LoadSaveInterface ).
      *
      * @param _list Returns a list of all available file load filters
      */ 
Jan Möbius's avatar
 
Jan Möbius committed
385 386
      void slotGetAllFilters ( QStringList& _list);

387 388 389
      /// Called when a plugin wants to delete an object
      void slotDeleteObject( int _id );

390 391 392
      /// Called when a plugin wants to delete all objects
      void slotDeleteAllObjects( );

Dirk Wilden's avatar
Dirk Wilden committed
393 394 395
      /// Get a Pointer to the Plugin with given _name (if it is loaded)
//       void slotGetPlugin(QString _name, QObject* & _plugin );

Jan Möbius's avatar
 
Jan Möbius committed
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
   /** @} */

    //===========================================================================
    /** @name scriptable slots
    * @{ */
   //===========================================================================
public slots:

    /// Called when a  plugin requests an update in the viewer
    void updateView();

    /// Clear all data objects
    void clearAll();

    /// exit the current application
    void exitApplication();

413 414 415
    /// set fullscreen mode
    void fullscreen( bool _state );

Jan Möbius's avatar
Jan Möbius committed
416 417
    /// Change the logging window state
    void loggerState(int _state);
Jan Möbius's avatar
 
Jan Möbius committed
418

419 420
    /// Show or hide toolbox
    void showToolbox( bool _state );
Jan Möbius's avatar
 
Jan Möbius committed
421

422 423
    /// Switch the multiView Mode
    void multiViewMode( int _mode );
Jan Möbius's avatar
 
Jan Möbius committed
424

425 426 427 428 429 430
    /// Enable or disable framerate restriction
    void restrictFrameRate( bool _enable );

    /// set the maximal framerate ( automatically enables framerate restriction )
    void setMaxFrameRate( int _rate );

431 432
    /// set the baseFilename for snapshots (a counter is automatically increased when
    /// snapshot() is called)
Jan Möbius's avatar
Jan Möbius committed
433
    void snapshotBaseFileName(const QString& _fname, unsigned int _viewerId = 0);
434

435 436 437 438
    /** Trigger a snapshot and increase the snapshot counter.
      Save snapshot to file determined by snapshotBaseFileName() and
      the current snapshot counter. The \a back buffer will be saved.
    */
Jan Möbius's avatar
Jan Möbius committed
439
    void snapshot(unsigned int _viewerId = 0);
440

Dirk Wilden's avatar
Dirk Wilden committed
441 442 443 444 445 446
    /// Take a snapshot from the whole app
    void applicationSnapshot();

    /// Set the baseName for the application snapshot
    void applicationSnapshotName(QString _name);

Dirk Wilden's avatar
Dirk Wilden committed
447 448 449
    /// Take a snapshot from all viewers
    void viewerSnapshot();

Dirk Wilden's avatar
 
Dirk Wilden committed
450
    /// resize the examinerViewer
451 452 453 454
    void resizeViewers(int _width, int _height );

    /// resize the whole Application
    void resizeApplication(int _width, int _height );
Dirk Wilden's avatar
 
Dirk Wilden committed
455

Dirk Wilden's avatar
Dirk Wilden committed
456 457 458
    /// write the current versions of all plugins to ini file
    void writeVersionNumbers(QString _filename);

Jan Möbius's avatar
Dennis:  
Jan Möbius committed
459 460 461
    /// return the list of available object that has the given selection and type
    QList<int> objectList (QString _selection, QStringList _types);

462 463 464 465 466 467
   //===========================================================================
    /** @name Scripting functions for controlling view modes
    * @{ */
   //===========================================================================

public slots:
468
    /** \brief Scripting function to set toolboxes in a view mode
469

470
      @param _modeName Name of the View Mode
471 472
      @param _toolboxList ; seperated list of toolboxes in the view mode
    */
473 474 475 476 477 478 479 480
    void addViewModeToolboxes(QString _modeName, QString _toolboxList);
    
    /** \brief Scripting function to set toolbars in a view mode
    
    @param _modeName Name of the View Mode
    @param _toolboxList ; seperated list of toolbars in the view mode
    */
    void addViewModeToolbars(QString _modeName, QString _toolbarList);
Jan Möbius's avatar
Marlin:  
Jan Möbius committed
481 482 483 484 485 486 487
    
    /** \brief Scripting function to set context menus in a view mode
    
    @param _modeName Name of the View Mode
    @param _toolboxList ; seperated list of context menus in the view mode
    */
    void addViewModeContextMenus(QString _modeName, QString _contextMenuList);
488

Jan Möbius's avatar
 
Jan Möbius committed
489 490 491 492 493 494
    /** @} */

   //===========================================================================
    /** @name Basic functions
    * @{ */
   //===========================================================================
495
private slots:
Jan Möbius's avatar
Jan Möbius committed
496 497 498 499 500
  /** \brief Load a new Object ( this may also be an ini or ofs file )
   *
   * This function tries to get the type of data to be loaded from the filename 
   * and then load the file.
   *
Jan Möbius's avatar
 
Jan Möbius committed
501 502 503 504 505
   *  @param _filename Filename of the data
   *  @return id of object otherwise -1
   */
  int loadObject ( QString _filename );

506 507 508 509 510
  /** Do a reset of the scenegraph (bounding box update,...)
   *
   * @param _resetTrackBall Should the rotation center of the trackball be reset to the scene center?
   */
  void resetScenegraph( bool _resetTrackBall );
Jan Möbius's avatar
 
Jan Möbius committed
511 512 513

 public :

Jan Möbius's avatar
Jan Möbius committed
514 515 516 517 518 519
  /** \brief Load an object from the commandline on application start
  *
  * This function is called before the event queue is executed. The filename and parameters
  * are stored. After the event queue is started, all files in this list will be opened.
  * This is necessary as the event queue has to run to schedule the events emitted 
  * during open operations.
520 521 522 523
  *
  * @param _filename filename of the file to be opened. If it does not contain a full path,
  *                  the current path will be prepended.
  * @param _asPolyMesh Load as a polymesh ( yes/no)
Jan Möbius's avatar
Jan Möbius committed
524
  */
525
  void commandLineOpen(const char* _filename, bool _asPolyMesh );
Jan Möbius's avatar
 
Jan Möbius committed
526

527 528 529 530 531 532 533 534 535 536
  /** \brief Load a script from the commandline on application start
  *
  * This function is called before the event queue is executed. The filename 
  * is stored. After the event queue is started, all files in this list will be opened.
  * This is necessary as the event queue has to run to schedule the events emitted 
  * during open operations.
  *
  * @param _filename filename of the script to be opened. If it does not contain a full path,
  *                  the current path will be prepended.
  */
Jan Möbius's avatar
 
Jan Möbius committed
537 538
  void commandLineScript(const char* _filename );

539 540
  private slots:

Jan Möbius's avatar
Jan Möbius committed
541
  /** \brief Executed after loading core completly to load files from commandline
542
  *
Jan Möbius's avatar
Jan Möbius committed
543 544 545
  * This slot is automatically called after application startup. All files from the commandline
  * will be loaded by this slot. This is required as the core and the event queue need to be running
  * to emit the required signals to the plugins.
546
  */
Jan Möbius's avatar
Jan Möbius committed
547
  void slotExecuteAfterStartup();
548 549

  private:
Jan Möbius's avatar
Jan Möbius committed
550
    /// Vector storing filenames from commandline to be opened after application startup (objects)
551
    std::vector< std::pair < std::string , bool >  > commandLineFileNames_;
Jan Möbius's avatar
Jan Möbius committed
552 553
    
    /// Vector storing filenames from commandline to be opened after application startup (script files)
554
    std::vector< std::string > commandLineScriptNames_;
555 556 557

  public:

Jan Möbius's avatar
 
Jan Möbius committed
558 559 560 561 562
  /** Add an empty Object of the given Type
  * @return id of the new object or -1 if unsupported
  */
  int addEmptyObject( DataType _type );

Jan Möbius's avatar
Jan Möbius committed
563 564 565 566 567
  /** \brief Load object of the given Type with given filename
   *
   * This function should not be used anymore. \n
   * The extension is now used to check for the plugin handling the given types.
   *
Jan Möbius's avatar
 
Jan Möbius committed
568 569 570 571
   * @return id of the new object or -1 if unsupported
   */
  int loadObject( DataType _type, QString _filename);

572
  /** @} */
Jan Möbius's avatar
 
Jan Möbius committed
573

574
  //===========================================================================
Jan Möbius's avatar
Jan Möbius committed
575 576 577 578 579 580 581 582 583 584
  /** @name  Video Stream creation
  * @{ */
  //===========================================================================
  private slots:
    /// Slot called everytime the view is updated
    void viewUpdated();

    /// Function called for every frame when capturing video
    void captureVideo();

Dirk Wilden's avatar
Dirk Wilden committed
585 586
  public slots:

Jan Möbius's avatar
Jan Möbius committed
587
    /// Start video capturing
Dirk Wilden's avatar
Dirk Wilden committed
588
    void startVideoCapture(QString _baseName, int _fps, bool _captureViewers);
Jan Möbius's avatar
Jan Möbius committed
589 590

    /// Stop video capturing
Dirk Wilden's avatar
Dirk Wilden committed
591
    void stopVideoCapture();
Jan Möbius's avatar
Jan Möbius committed
592 593 594 595 596

  private:
    QTimer videoTimer_;
    QTime  lastVideoTime_;

Dirk Wilden's avatar
Dirk Wilden committed
597 598
    int captureType_;

599 600
    bool capture_;

601 602 603
    int lastWidth_;
    int lastHeight_;

Jan Möbius's avatar
Jan Möbius committed
604 605
  /** @} */
  //===========================================================================
606 607 608 609 610 611 612 613 614 615
    /** @name Load / Save slots
    * @{ */
  //===========================================================================

  public slots:

    /** Save object with given id
      * @param _id id of the object
      */
    bool saveObject( int _id, QString _filename );
Dirk Wilden's avatar
Dirk Wilden committed
616 617
    
    void saveObject( int _id, QString _filename, int _pluginID );
618 619
    
    void saveObjects( IdList _ids, QString _filename, int _pluginID );
620

621 622 623 624 625 626
    /** Show dialog for saving an object to a new location
      * @param _id id of the object
      * @param _filename current filename of the object
      */
    bool saveObjectTo( int _id, QString _filename );

627 628
    bool saveObjectsTo( IdList _ids, QString _filename );
      
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645
    /// Slot for saving objects from Menu
    void saveAllObjects();

    /// Slot for saving objects to a new location
    void saveAllObjectsTo();

    /// Save current status to a settings file
    void saveSettings();

    /// Open Load Widget
    void loadObject();

    /// Load status from file
    void loadSettings();

    /// Load status from file
    void loadSettings(QString _filename);
Jan Möbius's avatar
 
Jan Möbius committed
646

647 648 649
    /// Get object id from filename
    int getObjectId(QString _filename);

Jan Möbius's avatar
 
Jan Möbius committed
650 651 652 653 654 655 656 657 658 659 660 661 662 663
  /** @} */

  //===========================================================================
    /** @name Basic slots
    * @{ */
  //===========================================================================
   private slots :

      /// Gets called by examiner widget when mouse is moved in picking mode
      void slotMouseEvent( QMouseEvent* _event );

      /// Gets called by examiner widget when Wheel is moved in picking mode
      void slotWheelEvent( QWheelEvent * _event, const std::string & _mode);

664 665 666 667
      /** \brief Open the add Empty dialog
      *
      * This slot shows the addEmpty dialog which is used to add empty objects of supported dataTypes
      */
Jan Möbius's avatar
 
Jan Möbius committed
668 669
      void slotAddEmptyObjectMenu();

670
      /// Slot adding empty object of a given type
Jan Möbius's avatar
 
Jan Möbius committed
671 672
      void slotAddEmptyObject( DataType _type , int& _id );

673 674 675
      /// Slot copying an object
      void slotCopyObject( int _oldId , int& _newId );

Jan Möbius's avatar
 
Jan Möbius committed
676 677 678 679 680
      /// Exit Application
      void slotExit();

      /// Open Recent file
      void slotRecentOpen(QAction* _action);
Jan Möbius's avatar
Jan Möbius committed
681

Jan Möbius's avatar
Jan Möbius committed
682
   public slots:
Jan Möbius's avatar
Jan Möbius committed
683

Jan Möbius's avatar
Jan Möbius committed
684 685
    /// Add a Toolbox from a plugin or from scripting
     void addToolbox(QString _name ,QWidget* _widget);
Jan Möbius's avatar
 
Jan Möbius committed
686 687 688 689 690 691 692 693 694 695

   private :

   //===========================================================================
    /** @name Scenegraph
    * @{ */
   //===========================================================================

   private:
      /// Scenegraphs root node
Dirk Wilden's avatar
Dirk Wilden committed
696
      SeparatorNode* root_node_scenegraph_;
697 698 699
      
      /// Seperator node for global nodes
      SeparatorNode* root_node_scenegraph_global_;
Dirk Wilden's avatar
Dirk Wilden committed
700

Jan Möbius's avatar
Jan Möbius committed
701 702 703 704 705 706 707 708 709
      /// Separator Node holding all core scenegraph nodes
      SeparatorNode* core_nodes_;
      
      
      ///Toplevel Nodes for data objects
      SeparatorNode* dataSeparatorNode_;
      
      /// Root Node for data objects
      SeparatorNode*  dataRootNode_;
Jan Möbius's avatar
Jan Möbius committed
710

711 712 713
      /// Node for coordsys Material
      ACG::SceneGraph::MaterialNode* coordsysMaterialNode_;

714 715
      /// Node for the coordinate system
      ACG::SceneGraph::CoordsysNode* coordsysNode_;
Jan Möbius's avatar
 
Jan Möbius committed
716

717
      /// Node for the grid
718
//       ACG::SceneGraph::GridNode* gridNode_;
719

Jan Möbius's avatar
 
Jan Möbius committed
720 721 722 723 724 725 726 727 728 729
   /** @} */

   //===========================================================================
    /** @name IniFile and Options Handling
    * @{ */
   //===========================================================================

   /// Get all ini files and set basic paths and options
   void setupOptions();

Dirk Wilden's avatar
Dirk Wilden committed
730 731 732
   /// Read Options that needs the GUI to be set up completely
   void readGUIOptions(INIFile& _ini);

733 734 735
   /// Read recent files from ini-file
   void readRecentFiles(QString _filename);

Jan Möbius's avatar
 
Jan Möbius committed
736 737 738 739 740 741
   /// Get and set Application options from ini file
   void readApplicationOptions(INIFile& _ini);

   /// Write Application options to ini file
   void writeApplicationOptions(INIFile& _ini);

742 743 744
   /// Restore key assignments from configs files
   void restoreKeyBindings();

Jan Möbius's avatar
 
Jan Möbius committed
745 746
  public slots:

Dirk Wilden's avatar
Dirk Wilden committed
747 748 749
   /// Save the current options to the standard ini file
   void saveOptions();

750 751 752
   /// after ini-files have been loaded and core is up or if options have been changed -> apply Options
   void applyOptions();

753 754 755 756 757
   /** \brief Load information from an ini file
    *
    * This function will open an ini file and load the information in it.
    *
    * @param _filename Name of the ini file
758
    * @param _coreSettings      Load core settings from the file
759
    * @param _perPluginSettings Load per plugin settings from the file
760
    * @param _loadObjects       Load objects defined in the ini file
761 762
    *
    */
763 764 765 766
   void openIniFile( QString _filename,
                     bool    _coreSettings ,
                     bool    _perPluginSettings,
                     bool    _loadObjects );
Jan Möbius's avatar
 
Jan Möbius committed
767 768 769 770 771 772

  private:

   /** \brief Write current status to ini file (Application and File Options)
    *
    *  Writes the complete status to an ini file ( All open objects and their Information )
Jan Möbius's avatar
Jan Möbius committed
773 774 775 776
    *
    * @param _filename filename of the ini file to write with full path
    * @param _relativePaths This defines if the paths to the objects should be made relative
    * @param _targetOnly Select if we want all open objects or only the ones which are selected as target.
777 778 779
    * @param _saveSystemSettings Choose if you also want to save system settings into the ini file.
    * @param _savePluginSettings Choose if you want to save per Plugin global settings into the ini file.
    * @param _saveObjectInfo If you want to store information about all open objects this has to be true
Jan Möbius's avatar
 
Jan Möbius committed
780
    */
781 782 783 784 785 786
   void writeIniFile( QString _filename,
                      bool    _relativePaths,
                      bool    _targetOnly,
                      bool    _saveSystemSettings,
                      bool    _savePluginSettings ,
                      bool    _saveObjectInfo );
Jan Möbius's avatar
 
Jan Möbius committed
787 788 789 790 791

   /** \brief Write current status to obj file (Application and File Options)
    *
    *  Writes the complete status to an obj file ( All open objects and their Information )
    */
792
   void writeObjFile(QString _filename, bool _relativePaths, bool _targetOnly);
Jan Möbius's avatar
 
Jan Möbius committed
793 794 795 796 797 798

   /// Called if app is closed and writes all information to ini file
   void writeOnExit();

   /** @} */

799
   
Jan Möbius's avatar
 
Jan Möbius committed
800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822
  //===========================================================================
  /** @name Logging
  * @{ */
  //===========================================================================

  signals:
    /// Logg with OUT,WARN or ERR as type
    void log(Logtype _type , QString _message );

    /// Default logging as OUT
    void log(QString _message );

    /// Logging signal for ScriptEngine
    void scriptLog(QString _message);

    /// This signal is emitted to send log data to a plugin
    void externalLog(Logtype _type , QString _message);

  private slots:

    /// Console logger
    void slotLog(Logtype _type, QString _message);

Dirk Wilden's avatar
Dirk Wilden committed
823 824 825 826 827 828 829 830 831 832
    /// log to file
    void slotLogToFile(Logtype _type, QString _message);

  private:
    ///stream for logging to file
    QTextStream* logStream_;

    ///logfile
    QFile* logFile_;

Jan Möbius's avatar
 
Jan Möbius committed
833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859
  public :
    void scriptLogFunction( QString _output);

  /** @} */


  //===========================================================================
  /** @name Signal and Slot processing for Plugins
  * @{ */
  //===========================================================================

  private :
    /// Check if a plugin has a slot
    bool checkSlot(QObject* _plugin , const char* _slotSignature);

    /// Check if a plugin has a signal
    bool checkSignal(QObject* _plugin , const char* _signalSignature);

  /** @} */

  //===========================================================================
    /** @name Plugin Management
      * @{ */
  //===========================================================================

  private:
    /// List of all loaded plugins
Dirk Wilden's avatar
Dirk Wilden committed
860
    std::vector<PluginInfo> plugins;
Jan Möbius's avatar
 
Jan Möbius committed
861 862 863 864 865

    /// Index of Plugins toolbox widget
    int toolboxindex_;

    /// Function for loading Plugins
Jan Möbius's avatar
Jan Möbius committed
866
    void loadPlugin(QString filename, bool silent, QObject* _plugin = 0 );
Jan Möbius's avatar
 
Jan Möbius committed
867 868 869 870

    /// Load all plugins from default plugin directory and from INI-File
    void loadPlugins();
  private slots:
Dirk Wilden's avatar
Dirk Wilden committed
871 872
    /// Show Plugins Dialog
    void slotShowPlugins();
Jan Möbius's avatar
 
Jan Möbius committed
873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895

    /// Function for unloading Plugins
    void unloadPlugin(QString name);

    /// Load Plugins from menu
    void slotLoadPlugin();

  /** @} */


  //===========================================================================
    /** @name Scripting support
      * @{ */
  //===========================================================================

  signals:

    void scriptInfo( QString _pluginName , QString _functionName  );

    void executeScript( QString _script );

    void executeFileScript( QString _filename );

896 897
    void setSlotDescription(QString     _slotName,   QString     _slotDescription,
                            QStringList _parameters, QStringList _descriptions);
898 899 900 901 902 903 904 905 906 907 908

  public slots:
    /** \brief Create an script object from a ui file
     *
     * This function will load an ui file, set up a qwidget from that and makes it available
     * under _objectName for scripting.
     * @param _objectName The name in scripting environment used for the new object
     * @param _uiFilename ui file to load
     */
    void createWidget(QString _objectName, QString _uiFilename);

909 910 911
    /// Set the active ViewMode
    void setViewMode(QString _viewMode);

Dirk Wilden's avatar
Dirk Wilden committed
912 913 914
    /// Set the icon of a viewMode
    void setViewModeIcon(QString _mode, QString _iconName);

Jan Möbius's avatar
 
Jan Möbius committed
915 916 917 918 919 920 921 922 923 924 925 926
  private :
    /// Core scripting engine
    QScriptEngine scriptEngine_;

    /// Wrappers for plugin scripting
    std::vector<ScriptingWrapper*> scriptingWrappers_;

    /// List of all registered scripting functions
    QStringList scriptingFunctions_;

    /// Prototype for the Vector type
    prototypeVec3d vec3dPrototype_;
927 928 929
    
    /// Prototype for the DataType
    prototypeDataType DataTypePrototype_;
Jan Möbius's avatar
 
Jan Möbius committed
930

931
    /// Prototype for the Matrix type
Jan Möbius's avatar
 
Jan Möbius committed
932 933 934 935 936 937 938 939 940 941 942 943
    prototypeMatrix4x4 matrix4x4Prototype_;


  private slots:
    void slotScriptInfo( QString _pluginName , QString _functionName  );

    void slotExecuteScript( QString _script );

    void slotGetScriptingEngine( QScriptEngine*& _engine  );

    void slotGetAllAvailableFunctions( QStringList& _functions  );

944 945 946 947 948 949 950 951 952 953
    /// set a description for one of the plugin's public slots
    void slotSetSlotDescription(QString     _slotName,   QString _slotDescription,
                                QStringList _parameters, QStringList _descriptions);
    /// get available descriptions for a given public slot
    void slotGetDescription(QString _function, QString& _fnDescription,
                                QStringList& _parameters, QStringList& _descriptions );

  private:

    QList< SlotInfo > coreSlots_;
954

955 956
    void setDescriptions();

Jan Möbius's avatar
 
Jan Möbius committed
957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997
  /** @} */

  //===========================================================================
    /** @name RPC ( Remote procedure Call) support
      * @{ */
  //===========================================================================
  private slots:
    void slotPluginExists( QString _pluginName , bool& _exists );


    void slotFunctionExists( QString _pluginName , QString _functionName , bool& _exists  );

    /** This slot executes a function of a plugin.
     * If it does not exist, _success will be false
     * @param _pluginName Plugin where the function is implemented
     * @param _functionName name of the function ( Standard name, no parameters allowed!)
     * @param _success successfull execution?
     */
    void slotCall( QString _pluginName , QString _functionName , bool& _success  );

    /** This slot executes the given expression.
     * No checks are performed if the remote function is available.
     * @param _expression command to execute
     * @param _success successfull execution?
     */
    void slotCall( QString _expression , bool& _success  );

    /** This slot executes the given expression and returns the result
     *  No checks are performed if the remote function is available.
     *  if an error occurs the result contains an invalid QVariant
     *
     * ex. getValue("databaseplugin.tableExists(\"meshes\")", result) )
     *     result.toBool() == true
     *
     * @param _expression command to execute
     * @param _result The return value of the command
     */
    void slotGetValue(QString _expression, QVariant& _result );

  /** @} */

998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
  //===========================================================================
    /** @name Scenegraph redraw handling
      * @{ */
  //===========================================================================

  private slots:

    /// Called to check if the scenegraph needs to be redrawn
    void checkScenegraphDirty();

  private:

    /// Timer that starts scenegraph check
    QTimer *scenegraphCheckTimer_;

    /// Holds the time since last redraw
    QTime *redrawTime_;
Jan Möbius's avatar
 
Jan Möbius committed
1015

1016
  /** @} */
1017 1018 1019 1020 1021 1022 1023 1024 1025
  
  
  //===========================================================================
  /** @name Process Interface and Controls
  * @{ */
  //===========================================================================
  
  private:
    
1026 1027
    QList< JobInfo* >  currentJobs;
    
1028 1029
    ProcessManagerWidget* processManager_;
    
1030 1031 1032
    /// Find a job in the jobslist
    bool getJob(QString _jobId, int& _index);
    
1033 1034
  private slots:

1035 1036
    /// A job has been started by a plugin
    void slotStartJob( QString _jobId, QString _description , int _min , int _max,bool _blocking );
1037
    
1038
    /// A job state has been updated by a plugin
1039 1040
    void slotSetJobState(QString _jobId, int _value );
    
1041 1042 1043 1044 1045 1046
    /// A job's widget caption has been updated by a plugin
    void slotSetJobName(QString _jobId, QString _name );
    
    /// A job's widget's status text has been updated by a plugin
    void slotSetJobDescription(QString _jobId, QString _text );
    
1047
    /// A job state has been canceled by a plugin
1048 1049
    void slotCancelJob(QString _jobId );
    
1050
    /// A job state has been finished by a plugin
1051 1052
    void slotFinishJob(QString _jobId );
    
1053
    /// Called by dialogs if cancel button is pressed
1054
    void slotJobCancelRequested(QString _jobId);
1055
    
1056 1057 1058 1059 1060
  signals:
    
    void jobCanceled( QString _jobId );
    
  /** @} */
Jan Möbius's avatar
Jan Möbius committed
1061 1062 1063 1064 1065
  
  //===========================================================================
  /** @name Object Manager
  * @{ */
  //===========================================================================
1066

Jan Möbius's avatar
Jan Möbius committed
1067 1068 1069 1070 1071
  private slots:
    
    /// This slot is called by the object manager when a new object is created
    void newObject(int _objectId);
    
Jan Möbius's avatar
Jan Möbius committed
1072 1073 1074
    /// This slot is called by the object manager when an object is deleted
    void deletedObject(int _objectId);    
    
Jan Möbius's avatar
Jan Möbius committed
1075 1076
  /** @} */
  
Jan Möbius's avatar
 
Jan Möbius committed
1077 1078 1079 1080 1081 1082 1083 1084 1085 1086
  private :

  /// Id for the next backup
  int nextBackupId_;

  /// Logger interfaces between plugins and core logger
  std::vector<PluginLogger*> loggers_;

  /// File-Plugins
  std::vector<fileTypes> supportedTypes_;
1087 1088 1089
  
  /// Type-Plugins
  std::vector<dataTypes> supportedDataTypes_;
Jan Möbius's avatar
 
Jan Möbius committed
1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105

  private :
    ///Pointer to the data rootNode;
    BaseObject* objectRoot_;

    /// The main applications widget ( only created in gui mode )
    CoreWidget* coreWidget_;

    /// SplashScreen, only used in gui mode
    QSplashScreen* splash_;

    /// Last Splash message;
    QString splashMessage_;

    /// List of available draw modes
    QVector<ViewMode*> viewModes_;
1106 1107 1108

    /// If enabled, this timer will block screen refresh if done more then 30 times per second.
    QTimer* redrawTimer_;
1109 1110


Jan Möbius's avatar
 
Jan Möbius committed
1111 1112 1113 1114 1115 1116 1117 1118 1119
};

/// Special print function for core logger
QScriptValue myPrintFunction(QScriptContext *context, QScriptEngine *engine);

//=============================================================================
#endif // MVIEWWIDGET_HH defined
//=============================================================================