Core.hh 53.1 KB
Newer Older
1
/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
2 3
*                                                                            *
*                              OpenFlipper                                   *
Jan Möbius's avatar
Jan Möbius committed
4
*      Copyright (C) 2001-2011 by Computer Graphics Group, RWTH Aachen       *
Jan Möbius's avatar
Jan Möbius committed
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
*                           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/>.                                       *
*                                                                            *
33 34 35
\*===========================================================================*/

/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
36 37 38 39 40
*                                                                            *
*   $Revision$                                                       *
*   $LastChangedBy$                                                *
*   $Date$                     *
*                                                                            *
41
\*===========================================================================*/
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
#include "OpenFlipper/BasePlugin/MenuInterface.hh"
98
#include "OpenFlipper/BasePlugin/SelectionInterface.hh" // -> for SelectionInterface::PrimitiveType
Jan Möbius's avatar
 
Jan Möbius committed
99 100 101 102
#include "OpenFlipper/BasePlugin/ContextMenuInterface.hh"

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

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

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

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

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

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

114 115
#include <OpenFlipper/common/FileTypes.hh>

Jan Möbius's avatar
 
Jan Möbius committed
116 117 118
//== CLASS DEFINITION =========================================================


119 120 121 122 123 124
struct dataTypes {
  QString name;
  DataType type;
  TypeInterface* plugin;
};

Jan Möbius's avatar
 
Jan Möbius committed
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
/** 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 );
Jan Möbius's avatar
Mike:  
Jan Möbius committed
149 150 151
  
  /// Handle Mouse events when in Light mode
  void slotMouseEventLight( QMouseEvent* _event );
Jan Möbius's avatar
 
Jan Möbius committed
152 153 154 155 156 157 158 159

protected:

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

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

Dirk Wilden's avatar
Dirk Wilden committed
166 167 168
   /// 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
169 170 171 172 173 174 175 176
   /// 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* );
Jan Möbius's avatar
Mike:  
Jan Möbius committed
177 178 179
   
   /// Emitted when an light event occurs
   void PluginMouseEventLight( QMouseEvent* );
Jan Möbius's avatar
 
Jan Möbius committed
180

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

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

Dirk Wilden's avatar
Dirk Wilden committed
187 188 189
   /// 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
190 191 192
   /// The texture with the given name and filename has been added
   void addTexture( QString, QString , uint );

193 194 195
   /// 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
196 197 198 199 200 201 202 203 204
   /// 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
205 206 207
   /// A texture mode should be changed
   void setTextureMode(QString _textureName ,QString _mode, int _id);

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

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

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

217 218 219 220 221 222
   /// 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 );

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

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

   /// get the texture index
   void textureIndex( QString _textureName, int _id, int& _index);
   
232 233 234
   /// get the texture index property name
   void textureIndexPropertyName( int _id, QString& _propertyName);
   
235 236
   /// get the texture name
   void textureName( int _id, int _textureIndex, QString& _textureName);
237 238 239
   
   /// get the texture's filename
   void textureFilename( int _id, QString _textureName, QString& _textureFilename);
240

241 242 243 244 245
   ///get current texture
   void getCurrentTexture( int _id, QString& _textureName );

   /// get a multi-texture's sub textures
   void getSubTextures( int _id, QString _multiTextureName, QStringList& _subTextures );
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330
   
   /// SelectionInterface: This signal is emitted when a new toolbutton should be added
   void addSelectionEnvironment(QString _modeName, QString _description, QIcon _icon, QString& _handleName);
   
   /// SelectionInterface: This signal is emitted when a data type should be registered for a selection mode
   void registerType(QString _handleName, DataType _type);
   
   /// SelectionInterface: This signal is emitted when a selection plugin should handle a new primitive type
   void addPrimitiveType(QString _handleName, QString _name, QIcon _icon, SelectionInterface::PrimitiveType& _typeHandle);
   
   /// SelectionInterface: This signal is emitted when a custom selection mode is added
   void addCustomSelectionMode(QString _handleName, QString _modeName, QString _description, QIcon _icon,
                               SelectionInterface::PrimitiveType _associatedTypes, QString& _customIdentifier);
   
   /// SelectionInterface: This signal is used to add non-interactive operations for a specific primitive type
   void addSelectionOperations(QString _handleName, QStringList _operationsList, QString _category, SelectionInterface::PrimitiveType _type);
   
   /// SelectionInterface: This signal is emitted when a non-interactive operation has been performed
   void selectionOperation(QString _operation);
  
   /// SelectionInterface: This signal is emitted when standard toggle selection is required
   void showToggleSelectionMode(QString _handleName, bool _show, SelectionInterface::PrimitiveType _associatedTypes);
   
   /// SelectionInterface: This signal is emitted when standard lasso selection is required
   void showLassoSelectionMode(QString _handleName, bool _show, SelectionInterface::PrimitiveType _associatedTypes);
   
   /// SelectionInterface: This signal is emitted when standard volume lasso selection is required
   void showVolumeLassoSelectionMode(QString _handleName, bool _show, SelectionInterface::PrimitiveType _associatedTypes);
   
   /// SelectionInterface: This signal is emitted when standard surface lasso selection is required
   void showSurfaceLassoSelectionMode(QString _handleName, bool _show, SelectionInterface::PrimitiveType _associatedTypes);
   
   /// SelectionInterface: This signal is emitted when standard sphere selection is required
   void showSphereSelectionMode(QString _handleName, bool _show, SelectionInterface::PrimitiveType _associatedTypes);
   
   /// SelectionInterface: This signal is emitted when standard closest boundary selection is required
   void showClosestBoundarySelectionMode(QString _handleName, bool _show, SelectionInterface::PrimitiveType _associatedTypes);
   
   /// SelectionInterface: This signal is emitted when standard flood fill selection is required
   void showFloodFillSelectionMode(QString _handleName, bool _show, SelectionInterface::PrimitiveType _associatedTypes);
  
   /// SelectionInterface: This signal is emitted when standard toggle selection has been performed
   void toggleSelection(QPoint _position, SelectionInterface::PrimitiveType _currentType, bool _deselect);
   
   /// SelectionInterface: This signal is emitted when standard lasso selection has been performed
   void lassoSelection(QMouseEvent* _event, SelectionInterface::PrimitiveType _currentType, bool _deselect);
   
   /// SelectionInterface: This signal is emitted when standard volume lasso selection has been performed
   void volumeLassoSelection(QMouseEvent* _event, SelectionInterface::PrimitiveType _currentType, bool _deselect);
   
   /// SelectionInterface: This signal is emitted when standard surface lasso selection has been performed
   void surfaceLassoSelection(QMouseEvent* _event, SelectionInterface::PrimitiveType _currentType, bool _deselect);
   
   /// SelectionInterface: This signal is emitted when standard sphere selection has been performed
   void sphereSelection(QPoint _position, double _radius, SelectionInterface::PrimitiveType _currentType, bool _deselect);
   
   /// SelectionInterface: This signal is emitted when standard closest boundary selection has been performed
   void closestBoundarySelection(QPoint _position, SelectionInterface::PrimitiveType _currentType, bool _deselect);
   
   /// SelectionInterface: This signal is emitted when standard flood fill selection has been performed
   void floodFillSelection(QPoint _position, double _maxAngle, SelectionInterface::PrimitiveType _currentType, bool _deselect);
   
   /// SelectionInterface: This signal is emitted when a custom selection operation has been performed
   void customSelection(QMouseEvent* _event, SelectionInterface::PrimitiveType _currentType, QString _customIdentifier, bool _deselect);
  
   /// SelectionInterface: This signal is emitted when the active (selected) data types should be fetched
   void getActiveDataTypes(SelectionInterface::TypeList& _types);
   
   /// SelectionInterface: This signal is emitted when the active (selected) primitive type should be fetched
   void getActivePrimitiveType(SelectionInterface::PrimitiveType& _type);
   
   /// SelectionInterface: This signal is emitted if the current target restriction state is requested
   void targetObjectsOnly(bool& _targetsOnly);
   
   /// SelectionInterface: This signal is emitted when a selection should be loaded from a file
   void loadSelection(const INIFile& _file);
   
   /// SelectionInterface: This signal is emitted when a selection should be written into a file
   void saveSelection(INIFile& _file);
   
   /// SelectionInterface: This signal is emitted when a type selection plugin wants to listen to a key event
   void registerKeyShortcut(int _key, Qt::KeyboardModifiers _modifiers);
   
   /// SelectionInterface: This signal is emitted when a key shortcut has been pressed
   void keyShortcutEvent(int _key, Qt::KeyboardModifiers _modifiers = Qt::NoModifier);
331

Jan Möbius's avatar
 
Jan Möbius committed
332 333 334 335 336 337 338 339 340 341 342 343
   /// 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 );

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

347 348 349
   /// This signal is emitted before the core deletes its data and exits
   void saveOnExit( INIFile& _ini );

Dirk Wilden's avatar
Dirk Wilden committed
350 351 352
   /// Tell plugins to create a backup group
   void createBackupGroup( QString _name , int _groupId);
   
Jan Möbius's avatar
 
Jan Möbius committed
353
   /// Tell plugins to create a backup
Dirk Wilden's avatar
Dirk Wilden committed
354
   void createBackup( int _objectId , QString _name , int _internalId, int groupId = -1);
Jan Möbius's avatar
Jan Möbius committed
355
   
Jan Möbius's avatar
Jan Möbius committed
356 357 358
   /// Tell Plugins to make a backup persistent
   void makeBackupPersistent(int _objectid, int _internalId);
   
Dirk Wilden's avatar
Dirk Wilden committed
359 360 361
   /// Tell Backup Plugin to restore a group with the given group id
   void restoreGroup( int _groupId);
   
Jan Möbius's avatar
Jan Möbius committed
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376
   /// Tell Backup Plugin to restore an object with the given backup id
   void restoreObject( int _objectId, int _internalId);
   
   
   /** \brief Backup Plugin tells other Plugins that a restore will happen
   */
   void aboutToRestore(int _objectId , int _internalId);
   
   /** \brief Backup Plugin tells other Plugins that they should restore their own data
   */
   void restore(int _objectId , int _internalId);
   
   /** \brief Backup Plugin tells other Plugins that a restore has happened
   */
   void restored( int _objectId , int _internalId);
Jan Möbius's avatar
 
Jan Möbius committed
377 378 379 380

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

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

Jan Möbius's avatar
 
Jan Möbius committed
384 385 386
   /// Called after all plugins are loaded
   void pluginsInitialized();

387 388 389
   /// Tell plugins that the visibility of an object has changed
   void visibilityChanged(int _id);

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

393 394 395
   /// Called after an object has been deleted
   void objectDeleted( int );

Jan Möbius's avatar
 
Jan Möbius committed
396 397 398 399 400 401 402 403 404 405 406
   /** @} */

   //===========================================================================
    /** @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
407
      void slotObjectUpdated(int _identifier, const UpdateType _type = UPDATE_ALL);
Jan Möbius's avatar
 
Jan Möbius committed
408

409
      /// Called when a plugin changes the visibility of an object
410
      void slotVisibilityChanged(int _id);
411

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

Jan Möbius's avatar
 
Jan Möbius committed
415
      /// Called by Plugins if they changed the active object
416
      void slotObjectSelectionChanged( int _id);
Jan Möbius's avatar
 
Jan Möbius committed
417 418 419 420 421 422 423

      /// 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
424 425 426
      /// 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
427 428 429
      /// Called by a plugin if it creates a texture
      void slotAddTexture( QString _textureName , QString _filename , uint _dimension );

430 431 432
      /// 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
433 434 435 436 437 438 439 440 441
      /// 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
442 443 444
      /// A texture mode should be changed
      void slotSetTextureMode(QString _textureName ,QString _mode, int _id);

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

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

Jan Möbius's avatar
 
Jan Möbius committed
451 452 453
      /// Tells Plugins to switch to the given Texture
      void slotSwitchTexture( QString _textureName );

454 455 456 457 458 459
      ///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 );

460 461 462 463 464 465
      ///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 );
      
466 467 468
      ///Called by plugins if texture index should be fetched
      void slotTextureIndex( QString _textureName, int _id, int& _index);
      
469 470 471
      ///Called by plugins if texture index property name should be fetched
      void slotTextureIndexPropertyName( int _id, QString& _propertyName);
      
472 473 474
      ///Called by plugins if texture name should be fetched
      void slotTextureName( int _id, int _textureIndex, QString& _textureName);
      
475 476 477
      ///Called by plugins if texture name should be fetched
      void slotTextureFilename( int _id, QString _textureName, QString& _textureFilename);
      
478 479 480 481 482 483
      ///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 );

Dirk Wilden's avatar
Dirk Wilden committed
484 485 486
      /// Called if a backup group is requested by the plugins
      void slotBackupGroup(QString _name, int& _groupId );
      
Jan Möbius's avatar
 
Jan Möbius committed
487
      /// Called if a backup is requested by the plugins
Dirk Wilden's avatar
Dirk Wilden committed
488
      void slotBackup( int _objectId, QString _name, int& _internalId, int _groupId = -1 );
Jan Möbius's avatar
Jan Möbius committed
489 490 491
      
      /// Called if a backup is requested by the plugins
      void slotBackup( int _objectId, QString _name );
Dirk Wilden's avatar
Dirk Wilden committed
492 493 494

      /// Called if a group restore is requested by the plugins
      void slotRestoreGroup( int _groupId);
Jan Möbius's avatar
Jan Möbius committed
495 496 497
      
      /// Called if a backup is requested by the plugins
      void slotRestore( int _objectId, int _internalId = -1 );
Jan Möbius's avatar
 
Jan Möbius committed
498 499 500 501

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

Dirk Wilden's avatar
Dirk Wilden committed
502 503 504
      /// the load widget wants to load a given file
      void slotLoad(QString _filename, int _pluginID);
      
Jan Möbius's avatar
 
Jan Möbius committed
505
      /// Called when a file has been opened
506
      void slotFileOpened ( int _id );
Jan Möbius's avatar
 
Jan Möbius committed
507 508 509

      /// Called when an empty object has been Added
      void slotEmptyObjectAdded ( int _id );
510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594
  
      /// SelectionInterface: Called when a new selection type button should be added to the toolbar
      void slotAddSelectionEnvironment(QString _modeName, QString _description, QIcon _icon, QString& _handleName);

      /// SelectionInterface: Called when a data type is added for a specific selection type
      void slotRegisterType(QString _handleName, DataType _type);

      /// SelectionInterface: Called when a new, non-standard primitive type should be handled
      void slotAddPrimitiveType(QString _handleName, QString _name, QIcon _icon, SelectionInterface::PrimitiveType& _typeHandle);

      /// SelectionInterface: Add new selection mode for specified type
      void slotAddCustomSelectionMode(QString _handleName, QString _modeName, QString _description, QIcon _icon,
                                      SelectionInterface::PrimitiveType _associatedTypes, QString& _customIdentifier);
      
      /// SelectionInterface: Called in order to add non-interactive operations for a specific primitive type
      void slotAddSelectionOperations(QString _handleName, QStringList _operationsList, QString _category, SelectionInterface::PrimitiveType _type);
       
      /// SelectionInterface: Called when a non-interactive operation has been performed
      void slotSelectionOperation(QString _operation);

      /// SelectionInterface: Provide toggle selection operation for specific selection mode
      void slotShowToggleSelectionMode(QString _handleName, bool _show, SelectionInterface::PrimitiveType _associatedTypes);

      /// SelectionInterface: Provide lasso selection operation for specific selection mode
      void slotShowLassoSelectionMode(QString _handleName, bool _show, SelectionInterface::PrimitiveType _associatedTypes);

      /// SelectionInterface: Provide volume lasso selection operation for specific selection mode
      void slotShowVolumeLassoSelectionMode(QString _handleName, bool _show, SelectionInterface::PrimitiveType _associatedTypes);
      
      /// SelectionInterface: Provide surface lasso selection operation for specific selection mode
      void slotShowSurfaceLassoSelectionMode(QString _handleName, bool _show, SelectionInterface::PrimitiveType _associatedTypes);

      /// SelectionInterface: Provide sphere selection operation for specific selection mode
      void slotShowSphereSelectionMode(QString _handleName, bool _show, SelectionInterface::PrimitiveType _associatedTypes);

      /// SelectionInterface: Provide closest boundary selection operation for specific selection mode
      void slotShowClosestBoundarySelectionMode(QString _handleName, bool _show, SelectionInterface::PrimitiveType _associatedTypes);

      /// SelectionInterface: Provide flood fill selection operation for specific selection mode
      void slotShowFloodFillSelectionMode(QString _handleName, bool _show, SelectionInterface::PrimitiveType _associatedTypes);

      /// SelectionInterface: Called when toggle selection operation has been performed
      void slotToggleSelection(QPoint _position, SelectionInterface::PrimitiveType _currentType, bool _deselect);

      /// SelectionInterface: Called when lasso selection operation has been performed
      void slotLassoSelection(QMouseEvent* _event, SelectionInterface::PrimitiveType _currentType, bool _deselect);

      /// SelectionInterface: Called when volume lasso selection operation has been performed
      void slotVolumeLassoSelection(QMouseEvent* _event, SelectionInterface::PrimitiveType _currentType, bool _deselect);
      
      /// SelectionInterface: Called when surface lasso selection operation has been performed
      void slotSurfaceLassoSelection(QMouseEvent* _event, SelectionInterface::PrimitiveType _currentType, bool _deselect);

      /// SelectionInterface: Called when sphere selection operation has been performed
      void slotSphereSelection(QPoint _position, double _radius, SelectionInterface::PrimitiveType _currentType, bool _deselect);

      /// SelectionInterface: Called when closest boundary selection operation has been performed
      void slotClosestBoundarySelection(QPoint _position, SelectionInterface::PrimitiveType _currentType, bool _deselect);

      /// SelectionInterface: Called when flood fill selection operation has been performed
      void slotFloodFillSelection(QPoint _position, double _maxAngle, SelectionInterface::PrimitiveType _currentType, bool _deselect);

      /// SelectionInterface: Called when custom selection operation has been performed
      void slotCustomSelection(QMouseEvent* _event, SelectionInterface::PrimitiveType _currentType, QString _customIdentifier, bool _deselect);

      /// SelectionInterface: Called when active (selected) data types should be fetched
      void slotGetActiveDataTypes(SelectionInterface::TypeList& _types);

      /// SelectionInterface: Called when active primitive type should be fetched
      void slotGetActivePrimitiveType(SelectionInterface::PrimitiveType& _type);
      
      /// SelectionInterface: Called when target restriction state should be fetched
      void slotTargetObjectsOnly(bool& _targetsOnly);
      
      /// SelectionInterface: Called when a selection should be loaded from a file
      void slotLoadSelection(const INIFile& _file);
      
      /// SelectionInterface: Called when a selection should be stored into a file
      void slotSaveSelection(INIFile& _file);
      
      /// SelectionInterface: Called when a key shortcut is to be registered
      void slotRegisterKeyShortcut(int _key, Qt::KeyboardModifiers _modifiers);
      
      /// SelectionInterface: Called when a key event occurred
      void slotKeyShortcutEvent(int _key, Qt::KeyboardModifiers _modifiers);
Jan Möbius's avatar
 
Jan Möbius committed
595

Jan Möbius's avatar
Jan Möbius committed
596 597 598 599 600 601 602
      /** \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
603 604
      void slotGetAllFilters ( QStringList& _list);

605 606 607
      /// Called when a plugin wants to delete an object
      void slotDeleteObject( int _id );

608 609
      /// Called when a plugin wants to delete all objects
      void slotDeleteAllObjects( );
610 611 612
      
      /// Called to create inter plugin connections
      void slotCrossPluginConnect( QString _pluginName1, const char* _signal, QString _pluginName2, const char* _slot);
613

Dirk Wilden's avatar
Dirk Wilden committed
614 615 616
      /// 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
617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
   /** @} */

    //===========================================================================
    /** @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();

634 635
    /// set fullscreen mode
    void fullscreen( bool _state );
636 637 638
    
    /// Show or Hide the viewmode control widget.
    void showViewModeControls( bool _show );
639

Jan Möbius's avatar
Jan Möbius committed
640 641
    /// Change the logging window state
    void loggerState(int _state);
642 643 644
    
    /// Enable or disable OpenMesh error logging
    void enableOpenMeshErrorLog(bool _state);
Jan Möbius's avatar
 
Jan Möbius committed
645

646 647
    /// Show or hide toolbox
    void showToolbox( bool _state );
Jan Möbius's avatar
 
Jan Möbius committed
648

649 650
    /// Switch the multiView Mode
    void multiViewMode( int _mode );
Jan Möbius's avatar
 
Jan Möbius committed
651

652 653 654 655 656 657
    /// Enable or disable framerate restriction
    void restrictFrameRate( bool _enable );

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

658 659
    /// set the baseFilename for snapshots (a counter is automatically increased when
    /// snapshot() is called)
Jan Möbius's avatar
Jan Möbius committed
660
    void snapshotBaseFileName(const QString& _fname, unsigned int _viewerId = 0);
661 662
    
    /// Set the file type for snapshots.
Ellen Dekkers's avatar
bugfix  
Ellen Dekkers committed
663
    void snapshotFileType(const QString& _type, unsigned int _viewerId = 0);
664 665 666
    
    /// Set the start index for the snapshot counter
    void snapshotCounterStart(const int _counter, unsigned int _viewerId = 0);
667

668 669 670
    /** 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.
671
      The id of the current viewer is 0 (default).
672
    */
673
    void snapshot(unsigned int _viewerId = 0, int _width = 0, int _height = 0, bool _alpha = false, bool _hideCoordsys = false);
674

Dirk Wilden's avatar
Dirk Wilden committed
675 676 677 678 679 680
    /// 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
681 682 683
    /// Take a snapshot from all viewers
    void viewerSnapshot();

Dirk Wilden's avatar
 
Dirk Wilden committed
684
    /// resize the examinerViewer
685 686 687 688
    void resizeViewers(int _width, int _height );

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

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

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

696 697 698 699 700 701
   //===========================================================================
    /** @name Scripting functions for controlling view modes
    * @{ */
   //===========================================================================

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

704
      @param _modeName Name of the View Mode
705 706
      @param _toolboxList ; seperated list of toolboxes in the view mode
    */
707 708 709 710 711 712 713 714
    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
715 716 717 718 719 720 721
    
    /** \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);
722 723 724 725 726 727 728
    
    /** \brief Scripting function to set an icon for a view mode
    
    @param _modeName Name of the View Mode
    @param _toolboxList Name of the Icon File. Will be taken from OpenFlippers Icon directory
    */
    void addViewModeIcon(QString _modeName, QString _iconName);    
729 730 731 732 733 734
    
    /** \brief Scripting function to set the side of the main window on which the toolbox should be displayed
    
    @param _side The desired side (either "left" or "right")
    */
    void setToolBoxSide(QString _side);
735

Dirk Wilden's avatar
Dirk Wilden committed
736 737 738 739 740 741
    /** \brief Scripting function to set the side of the main window on which the toolbox should be displayed
    
    @param _side The desired side (either "left" or "right")
    */
    void setToolBoxActive(QString _toolBoxName, bool _active);
    
Jan Möbius's avatar
 
Jan Möbius committed
742 743 744 745 746 747
    /** @} */

   //===========================================================================
    /** @name Basic functions
    * @{ */
   //===========================================================================
748
public slots:
Jan Möbius's avatar
Jan Möbius committed
749 750 751 752 753
  /** \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
754 755 756 757
   *  @param _filename Filename of the data
   *  @return id of object otherwise -1
   */
  int loadObject ( QString _filename );
758 759
  
private slots:
760 761 762 763 764
  /** 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
765 766 767

 public :

Jan Möbius's avatar
Jan Möbius committed
768 769 770 771 772 773
  /** \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.
774 775 776 777
  *
  * @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
778
  */
779
  void commandLineOpen(const char* _filename, bool _asPolyMesh );
Jan Möbius's avatar
 
Jan Möbius committed
780

781 782 783 784 785 786 787 788 789 790
  /** \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
791 792
  void commandLineScript(const char* _filename );

793 794
  private slots:

Jan Möbius's avatar
Jan Möbius committed
795
  /** \brief Executed after loading core completly to load files from commandline
796
  *
Jan Möbius's avatar
Jan Möbius committed
797 798 799
  * 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.
800
  */
Jan Möbius's avatar
Jan Möbius committed
801
  void slotExecuteAfterStartup();
802 803

  private:
Jan Möbius's avatar
Jan Möbius committed
804
    /// Vector storing filenames from commandline to be opened after application startup (objects)
805
    std::vector< std::pair < std::string , bool >  > commandLineFileNames_;
Jan Möbius's avatar
Jan Möbius committed
806 807
    
    /// Vector storing filenames from commandline to be opened after application startup (script files)
808
    std::vector< std::string > commandLineScriptNames_;
809 810 811

  public:

Jan Möbius's avatar
 
Jan Möbius committed
812 813 814 815 816
  /** 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
817 818 819 820 821
  /** \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
822 823 824 825
   * @return id of the new object or -1 if unsupported
   */
  int loadObject( DataType _type, QString _filename);

826
  /** @} */
Jan Möbius's avatar
 
Jan Möbius committed
827

828
  //===========================================================================
Jan Möbius's avatar
Jan Möbius committed
829 830 831 832 833 834 835 836 837 838
  /** @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
839 840
  public slots:

Jan Möbius's avatar
Jan Möbius committed
841
    /// Start video capturing
Dirk Wilden's avatar
Dirk Wilden committed
842
    void startVideoCapture(QString _baseName, int _fps, bool _captureViewers);
Jan Möbius's avatar
Jan Möbius committed
843 844

    /// Stop video capturing
Dirk Wilden's avatar
Dirk Wilden committed
845
    void stopVideoCapture();
Jan Möbius's avatar
Jan Möbius committed
846 847 848 849 850

  private:
    QTimer videoTimer_;
    QTime  lastVideoTime_;

Dirk Wilden's avatar
Dirk Wilden committed
851 852
    int captureType_;

853 854
    bool capture_;

855 856 857
    int lastWidth_;
    int lastHeight_;

Jan Möbius's avatar
Jan Möbius committed
858 859
  /** @} */
  //===========================================================================
860 861 862 863 864 865 866 867 868 869
    /** @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
870 871
    
    void saveObject( int _id, QString _filename, int _pluginID );
872 873
    
    void saveObjects( IdList _ids, QString _filename, int _pluginID );
874

875 876 877 878 879 880
    /** 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 );

881 882
    bool saveObjectsTo( IdList _ids, QString _filename );
      
883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899
    /// 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
900

901 902 903
    /// Get object id from filename
    int getObjectId(QString _filename);

Jan Möbius's avatar
 
Jan Möbius committed
904 905 906 907 908 909 910 911 912 913 914 915 916 917
  /** @} */

  //===========================================================================
    /** @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);

918 919 920 921
      /** \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
922 923
      void slotAddEmptyObjectMenu();

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

927 928 929
      /// Slot copying an object
      void slotCopyObject( int _oldId , int& _newId );

Jan Möbius's avatar
 
Jan Möbius committed
930 931 932 933 934
      /// Exit Application
      void slotExit();

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

Jan Möbius's avatar
Jan Möbius committed
936
   public slots:
Jan Möbius's avatar
Jan Möbius committed
937

Jan Möbius's avatar
Jan Möbius committed
938 939
    /// Add a Toolbox from a plugin or from scripting
     void addToolbox(QString _name ,QWidget* _widget);
Jan Möbius's avatar
 
Jan Möbius committed
940

Dirk Wilden's avatar
Dirk Wilden committed
941 942 943
    /// Add a Toolbox from a plugin or from scripting (with icon)
     void addToolbox(QString _name ,QWidget* _widget, QIcon* _icon);

Jan Möbius's avatar
 
Jan Möbius committed
944 945 946 947 948 949 950 951 952
   private :

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

   private:
      /// Scenegraphs root node
Dirk Wilden's avatar
Dirk Wilden committed
953
      SeparatorNode* root_node_scenegraph_;
954 955 956
      
      /// Seperator node for global nodes
      SeparatorNode* root_node_scenegraph_global_;
Dirk Wilden's avatar
Dirk Wilden committed
957

Jan Möbius's avatar
Jan Möbius committed
958 959 960 961 962 963 964 965 966
      /// 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
967

968 969 970
      /// Node for coordsys Material
      ACG::SceneGraph::MaterialNode* coordsysMaterialNode_;

971 972
      /// Node for the coordinate system
      ACG::SceneGraph::CoordsysNode* coordsysNode_;
Jan Möbius's avatar
 
Jan Möbius committed
973 974 975 976 977 978 979 980 981 982 983

   /** @} */

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

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

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

Jan Möbius's avatar
 
Jan Möbius committed
987 988 989 990 991 992
   /// Get and set Application options from ini file
   void readApplicationOptions(INIFile& _ini);

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

993 994 995
   /// Restore key assignments from configs files
   void restoreKeyBindings();

Jan Möbius's avatar
 
Jan Möbius committed
996 997
  public slots:

Dirk Wilden's avatar
Dirk Wilden committed
998 999 1000
   /// Save the current options to the standard ini file
   void saveOptions();

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

1004 1005 1006 1007 1008
   /** \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
1009
    * @param _coreSettings      Load core settings from the file
1010
    * @param _perPluginSettings Load per plugin settings from the file
1011
    * @param _loadObjects       Load objects defined in the ini file
1012 1013
    *
    */
1014 1015 1016 1017
   void openIniFile( QString _filename,
                     bool    _coreSettings ,
                     bool    _perPluginSettings,
                     bool    _loadObjects );
Jan Möbius's avatar
 
Jan Möbius committed
1018 1019 1020 1021 1022 1023

  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
1024 1025 1026 1027
    *
    * @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.
1028 1029 1030
    * @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
1031
    */
1032 1033 1034 1035 1036 1037
   void writeIniFile( QString _filename,
                      bool    _relativePaths,
                      bool    _targetOnly,
                      bool    _saveSystemSettings,
                      bool    _savePluginSettings ,
                      bool    _saveObjectInfo );
Jan Möbius's avatar
 
Jan Möbius committed
1038 1039 1040 1041 1042

   /** \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 )
    */
1043
   void writeObjFile(QString _filename, bool _relativePaths, bool _targetOnly);
Jan Möbius's avatar
 
Jan Möbius committed
1044 1045 1046 1047 1048 1049

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

   /** @} */

1050
   
Jan Möbius's avatar
 
Jan Möbius committed
1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073
  //===========================================================================
  /** @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
1074 1075 1076 1077 1078 1079 1080 1081 1082 1083
    /// 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
1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110
  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
1111
    std::vector<PluginInfo> plugins;
Jan Möbius's avatar
 
Jan Möbius committed
1112 1113 1114 1115 1116

    /// Index of Plugins toolbox widget
    int toolboxindex_;

    /// Function for loading Plugins
1117
    void loadPlugin(QString filename, bool silent, QString& _licenseErrors , QObject* _plugin = 0 );
Jan Möbius's avatar
 
Jan Möbius committed
1118 1119 1120 1121

    /// Load all plugins from default plugin directory and from INI-File
    void loadPlugins();
  private slots:
Dirk Wilden's avatar
Dirk Wilden committed
1122 1123
    /// Show Plugins Dialog
    void slotShowPlugins();
Jan Möbius's avatar
 
Jan Möbius committed
1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146

    /// 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 );

1147 1148
    void setSlotDescription(QString     _slotName,   QString     _slotDescription,
                            QStringList _parameters, QStringList _descriptions);
1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159

  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);

1160 1161 1162
    /// Set the active ViewMode
    void setViewMode(QString _viewMode);

Dirk Wilden's avatar
Dirk Wilden committed
1163 1164
    /// Set the icon of a viewMode
    void setViewModeIcon(QString _mode, QString _iconName);
1165 1166
    
    /// Move selected toolbox to top of side area
1167
    void moveToolBoxToTop(QString _name);
1168 1169
    
    /// Move selected toolbox to bottom of side area
1170
    void moveToolBoxToBottom(QString _name);
Dirk Wilden's avatar
Dirk Wilden committed
1171

Jan Möbius's avatar
 
Jan Möbius committed
1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183
  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_;
1184 1185 1186
    
    /// Prototype for the DataType
    prototypeDataType DataTypePrototype_;
Jan Möbius's avatar
 
Jan Möbius committed
1187

1188
    /// Prototype for the Matrix type
Jan Möbius's avatar
 
Jan Möbius committed
1189 1190 1191 1192 1193 1194
    prototypeMatrix4x4 matrix4x4Prototype_;


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

Jan Möbius's avatar
Jan Möbius committed
1195 1196 1197 1198 1199

    /** Core slot, executes the given script text via scripting plugin
     *
     * @param _script Script as QString
     */
Jan Möbius's avatar
 
Jan Möbius committed
1200 1201
    void slotExecuteScript( QString _script );

Jan Möbius's avatar
Jan Möbius committed
1202 1203 1204 1205 1206 1207
    /** Core slot, executes the given file as a script via scripting plugin
     *
     * @param _filename Filename of the script
     */
    void slotExecuteFileScript( QString _filename );

Jan Möbius's avatar
 
Jan Möbius committed
1208 1209 1210 1211
    void slotGetScriptingEngine( QScriptEngine*& _engine  );

    void slotGetAllAvailableFunctions( QStringList& _functions  );

1212 1213 1214 1215 1216 1217 1218 1219 1220 1221
    /// 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_;
1222

1223 1224
    void setDescriptions();

Jan Möbius's avatar
 
Jan Möbius committed
1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265
  /** @} */

  //===========================================================================
    /** @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 );

  /** @} */

1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282
  //===========================================================================
    /** @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
1283

1284
  /** @} */
1285 1286 1287 1288 1289 1290 1291 1292 1293
  
  
  //===========================================================================
  /** @name Process Interface and Controls
  * @{ */
  //===========================================================================
  
  private:
    
1294 1295
    QList< JobInfo* >  currentJobs;
    
1296 1297
    ProcessManagerWidget* processManager_;
    
1298 1299 1300
    /// Find a job in the jobslist
    bool getJob(QString _jobId, int& _index);
    
1301 1302
  private slots:

1303 1304
    /// A job has been started by a plugin
    void slotStartJob( QString _jobId, QString _description , int _min , int _max,bool _blocking );
1305
    
1306
    /// A job state has been updated by a plugin
1307 1308
    void slotSetJobState(QString _jobId, int _value );
    
1309 1310 1311 1312 1313 1314
    /// 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 );
    
1315
    /// A job state has been canceled by a plugin
1316 1317
    void slotCancelJob(QString _jobId );
    
1318
    /// A job state has been finished by a plugin
1319 1320
    void slotFinishJob(QString _jobId );
    
1321
    /// Called by dialogs if cancel button is pressed
1322
    void slotJobCancelRequested(QString _jobId);
1323
    
1324 1325 1326 1327 1328
  signals:
    
    void jobCanceled( QString _jobId );
    
  /** @} */
Jan Möbius's avatar
Jan Möbius committed
1329 1330 1331 1332 1333
  
  //===========================================================================
  /** @name Object Manager
  * @{ */
  //===========================================================================
1334

Jan Möbius's avatar
Jan Möbius committed
1335 1336 1337 1338 1339
  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
1340 1341 1342
    /// 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
1343 1344
  /** @} */
  
Jan Möbius's avatar
Jan Möbius committed
1345 1346 1347 1348 1349 1350 1351 1352
  
  private:
    /** \brief OpenGL capability check 
    *
    * Checks if the OpenGL Capabilities of the graphics card are sufficient and
    * prints an error message if not.
    */
    bool checkOpenGLCapabilities();
Jan Möbius's avatar
Jan Möbius committed
1353 1354 1355 1356 1357 1358
    
    /** \brief Checks for library inconsistencies
    *
    * Checks if the used libraries are consistent
    */
    bool checkLibraryVersions();
Jan Möbius's avatar
Jan Möbius committed
1359 1360
  
  
Jan Möbius's avatar
 
Jan Möbius committed
1361 1362 1363 1364
  private :

  /// Id for the next backup
  int nextBackupId_;
Dirk Wilden's avatar
Dirk Wilden committed
1365 1366 1367
  
  /// Id for the next backup group
  int nextBackupGroupId_;
Jan Möbius's avatar
 
Jan Möbius committed
1368 1369 1370

  /// Logger interfaces between plugins and core logger
  std::vector<PluginLogger*> loggers_;
1371 1372 1373
  
  /// Type-Plugins
  std::vector<dataTypes> supportedDataTypes_;
Jan Möbius's avatar
 
Jan Möbius committed
1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389

  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_;
1390 1391 1392

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


Jan Möbius's avatar
 
Jan Möbius committed
1395 1396 1397 1398 1399 1400 1401 1402 1403
};

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

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