Core.hh 59.4 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-2014 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

// QT INCLUDES
66 67
#include <QVariant>
#include <QMainWindow>
Jan Möbius's avatar
 
Jan Möbius committed
68 69 70 71 72 73
#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

#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"
Jan Möbius's avatar
Jan Möbius committed
86
#include "OpenFlipper/Scripting/scriptPrototypes/prototypeVec4d.hh"
Jan Möbius's avatar
 
Jan Möbius committed
87
#include "OpenFlipper/Scripting/scriptPrototypes/prototypeMatrix4x4.hh"
88
#include "OpenFlipper/Scripting/scriptPrototypes/prototypeDataType.hh"
Jan Möbius's avatar
 
Jan Möbius committed
89
#include <OpenFlipper/Scripting/scriptWrappers/vec3dWrapper.hh>
Jan Möbius's avatar
Jan Möbius committed
90
#include <OpenFlipper/Scripting/scriptWrappers/vec4dWrapper.hh>
Jan Möbius's avatar
 
Jan Möbius committed
91
#include <OpenFlipper/Scripting/scriptWrappers/matrix4x4Wrapper.hh>
92
#include <OpenFlipper/Scripting/scriptWrappers/DataTypeWrapper.hh>
Jan Möbius's avatar
 
Jan Möbius committed
93 94 95 96 97
// #include <OpenFlipper/Scripting/scriptWrappers/ObjectIdWrapper.hh>

// Required Interface definition ( Some variables were defined there )
#include "OpenFlipper/BasePlugin/BaseInterface.hh"
#include "OpenFlipper/BasePlugin/FileInterface.hh"
98
#include "OpenFlipper/BasePlugin/TypeInterface.hh"
Jan Möbius's avatar
 
Jan Möbius committed
99
#include "OpenFlipper/BasePlugin/MenuInterface.hh"
100
#include "OpenFlipper/BasePlugin/InformationInterface.hh"
101
#include "OpenFlipper/BasePlugin/SelectionInterface.hh" // -> for SelectionInterface::PrimitiveType
Jan Möbius's avatar
 
Jan Möbius committed
102 103 104 105
#include "OpenFlipper/BasePlugin/ContextMenuInterface.hh"

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

106 107 108
// Process manager widget
#include <OpenFlipper/widgets/processManagerWidget/processManagerWidget.hh>

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

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

113 114
#include <ACG/Scenegraph/CoordsysNode.hh>

115 116
#include <OpenFlipper/threads/JobInfo.hh>

117
#include <OpenFlipper/common/FileTypes.hh>
118
#include <OpenFlipper/common/InformationPlugins.hh>
119
#include "SpinBoxEventFilter.hh"
120

Jan Möbius's avatar
 
Jan Möbius committed
121 122 123
//== CLASS DEFINITION =========================================================


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

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

protected:

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

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

Dirk Wilden's avatar
Dirk Wilden committed
171
   /// When this Signal is emitted all Plugins are informed that some type of update was performed on an object
172
   void signalObjectUpdated(int, const UpdateType&);
Dirk Wilden's avatar
Dirk Wilden committed
173
   
Jan Möbius's avatar
 
Jan Möbius committed
174 175 176 177 178 179
   /// 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* );

Jan Möbius's avatar
Mike:  
Jan Möbius committed
180 181
   /// Emitted when an light event occurs
   void PluginMouseEventLight( QMouseEvent* );
Jan Möbius's avatar
 
Jan Möbius committed
182

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

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

189 190 191
   /// This signal is emitted after the scene has been drawn
   void pluginSceneDrawn();

Dirk Wilden's avatar
Dirk Wilden committed
192 193 194
   /// 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
195 196 197
   /// The texture with the given name and filename has been added
   void addTexture( QString, QString , uint );

198 199 200
   /// 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
201 202 203 204 205 206 207 208 209
   /// 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
210 211 212
   /// A texture mode should be changed
   void setTextureMode(QString _textureName ,QString _mode, int _id);

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

Dirk Wilden's avatar
Dirk Wilden committed
216 217 218
   /// Switch Texture Plugins to a given Mode
   void switchTexture( QString, int );

Jan Möbius's avatar
 
Jan Möbius committed
219 220 221
   /// Switch Texture Plugins to a given Mode
   void switchTexture( QString );

222 223 224 225 226 227
   /// 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 );

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

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

   /// get the texture index
   void textureIndex( QString _textureName, int _id, int& _index);
   
237 238 239
   /// get the texture index property name
   void textureIndexPropertyName( int _id, QString& _propertyName);
   
240 241
   /// get the texture name
   void textureName( int _id, int _textureIndex, QString& _textureName);
242 243 244
   
   /// get the texture's filename
   void textureFilename( int _id, QString _textureName, QString& _textureFilename);
245

246 247 248 249 250
   ///get current texture
   void getCurrentTexture( int _id, QString& _textureName );

   /// get a multi-texture's sub textures
   void getSubTextures( int _id, QString _multiTextureName, QStringList& _subTextures );
251 252
   
   /// SelectionInterface: This signal is emitted when a new toolbutton should be added
Jan Möbius's avatar
Jan Möbius committed
253
   void addSelectionEnvironment(QString _modeName, QString _description, QString _icon, QString& _handleName);
254 255 256 257 258
   
   /// 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
Jan Möbius's avatar
Jan Möbius committed
259
   void addPrimitiveType(QString _handleName, QString _name, QString _icon, SelectionInterface::PrimitiveType& _typeHandle);
260 261
   
   /// SelectionInterface: This signal is emitted when a custom selection mode is added
Jan Möbius's avatar
Jan Möbius committed
262
   void addCustomSelectionMode(QString _handleName, QString _modeName, QString _description, QString _icon,
263
                               SelectionInterface::PrimitiveType _associatedTypes, QString& _customIdentifier);
Jan Möbius's avatar
Jan Möbius committed
264
   void addCustomSelectionMode(QString _handleName, QString _modeName, QString _description, QString _icon,
265 266
                               SelectionInterface::PrimitiveType _associatedTypes, QString& _customIdentifier,
                               DataType _objectTypeRestriction);
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
   
   /// 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);
294 295 296

   /// SelectionInterface: This signal is emitted when standard connected components selection is required
   void showComponentsSelectionMode(QString _handleName, bool _show, SelectionInterface::PrimitiveType _associatedTypes);
297 298
  
   /// SelectionInterface: This signal is emitted when standard toggle selection has been performed
299
   void toggleSelection(QMouseEvent* _event, SelectionInterface::PrimitiveType _currentType, bool _deselect);
300 301 302 303 304 305 306 307 308 309 310
   
   /// 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
311
   void sphereSelection(QMouseEvent* _event, double _radius, SelectionInterface::PrimitiveType _currentType, bool _deselect);
312 313
   
   /// SelectionInterface: This signal is emitted when standard closest boundary selection has been performed
314
   void closestBoundarySelection(QMouseEvent* _event, SelectionInterface::PrimitiveType _currentType, bool _deselect);
315 316
   
   /// SelectionInterface: This signal is emitted when standard flood fill selection has been performed
317
   void floodFillSelection(QMouseEvent* _event, double _maxAngle, SelectionInterface::PrimitiveType _currentType, bool _deselect);
318
   
319 320 321
   /// SelectionInterface: This signal is emitted when standard connected components selection has been performed
   void componentsSelection(QMouseEvent* _event, SelectionInterface::PrimitiveType _currentType, bool _deselect);

322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
   /// 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);
345

Jan Möbius's avatar
 
Jan Möbius committed
346 347 348 349 350 351 352 353 354 355 356 357
   /// 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 );

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

361 362 363
   /// This signal is emitted before the core deletes its data and exits
   void saveOnExit( INIFile& _ini );

364 365 366 367 368 369 370 371 372 373 374
   /// Tell backup-plugin to create a backup
   void createBackup( int _objectid, QString _name, UpdateType _type = UPDATE_ALL);
   void createBackup( IdList _objectids, QString _name, std::vector<UpdateType> _types);

   /// Tell backup-plugin to undo/redo
   void undo(int _objectid);
   void redo(int _objectid);
   void undo();
   void redo();

   /// Backup Plugin tells other Plugins that a restore will happen
375
   void aboutToRestore(int _objectId);
Jan Möbius's avatar
Jan Möbius committed
376
   
377
   /// Backup Plugin tells other Plugins that a restore has happened
378
   void restored( int _objectId);
Jan Möbius's avatar
 
Jan Möbius committed
379 380 381 382

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

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

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

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

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

395 396 397
   /// Called after an object has been deleted
   void objectDeleted( int );

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

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

Jan Möbius's avatar
Jan Möbius committed
406
      /// Called by the plugins if they changed something in the object list (deleted, added, or other property changes)
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

      /// Add a new picking mode to the examiner_widget_
Jan Möbius's avatar
Jan Möbius committed
419
      void slotAddPickMode( const std::string& _mode );
Jan Möbius's avatar
 
Jan Möbius committed
420 421

      /// Add a new and invisible picking mode to the examiner_widget_
Jan Möbius's avatar
Jan Möbius committed
422
      void slotAddHiddenPickMode( const std::string& _mode );
Jan Möbius's avatar
 
Jan Möbius committed
423

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

Jan Möbius's avatar
 
Jan Möbius committed
484 485 486
      /// A plugin wants to load a given file
      void slotLoad(QString _filename, DataType _type, int& _id);

Dirk Wilden's avatar
Dirk Wilden committed
487 488 489
      /// the load widget wants to load a given file
      void slotLoad(QString _filename, int _pluginID);
      
Jan Möbius's avatar
 
Jan Möbius committed
490
      /// Called when a file has been opened
491
      void slotFileOpened ( int _id );
Jan Möbius's avatar
 
Jan Möbius committed
492 493 494

      /// Called when an empty object has been Added
      void slotEmptyObjectAdded ( int _id );
495 496
  
      /// SelectionInterface: Called when a new selection type button should be added to the toolbar
Jan Möbius's avatar
Jan Möbius committed
497
      void slotAddSelectionEnvironment(QString _modeName, QString _description, QString _icon, QString& _handleName);
498 499 500 501 502

      /// 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
Jan Möbius's avatar
Jan Möbius committed
503
      void slotAddPrimitiveType(QString _handleName, QString _name, QString _icon, SelectionInterface::PrimitiveType& _typeHandle);
504

Jan Möbius's avatar
Jan Möbius committed
505 506 507 508 509 510 511 512 513
      /** \brief SelectionInterface: Add new selection mode for specified type
       *
       * @param _handleName             Handle of the selection mode
       * @param _modeName               User visible name of the selection mode
       * @param _description            Description of the mode
       * @param _icon                   Icon displayed in the selection toolbar
       * @param _associatedTypes        primitive types supported by this mode
       * @param _customIdentifier       Identifier of this mode
       */
Jan Möbius's avatar
Jan Möbius committed
514
      void slotAddCustomSelectionMode(QString _handleName, QString _modeName, QString _description, QString _icon,
515
                                      SelectionInterface::PrimitiveType _associatedTypes, QString& _customIdentifier);
Jan Möbius's avatar
Jan Möbius committed
516 517 518 519 520 521 522 523 524 525 526

      /** \brief  SelectionInterface: Add new selection mode for specified type
       *
       * @param _handleName             Handle of the selection mode
       * @param _modeName               User visible name of the selection mode
       * @param _description            Description of the mode
       * @param _icon                   Icon displayed in the selection toolbar
       * @param _associatedTypes        primitive types supported by this mode
       * @param _customIdentifier       Identifier of this mode
       * @param _objectTypeRestriction  Object types supported by this mode
       */
Jan Möbius's avatar
Jan Möbius committed
527
      void slotAddCustomSelectionMode(QString _handleName, QString _modeName, QString _description, QString _icon,
528 529
                                      SelectionInterface::PrimitiveType _associatedTypes, QString& _customIdentifier,
                                      DataType _objectTypeRestriction);
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
      
      /// 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);

558 559 560
      /// SelectionInterface: Provide connected components selection operation for specific selection mode
      void slotShowComponentsSelectionMode(QString _handleName, bool _show, SelectionInterface::PrimitiveType _associatedTypes);

561
      /// SelectionInterface: Called when toggle selection operation has been performed
562
      void slotToggleSelection(QMouseEvent* _event, SelectionInterface::PrimitiveType _currentType, bool _deselect);
563 564 565 566 567 568 569 570 571 572 573

      /// 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
574
      void slotSphereSelection(QMouseEvent* _event, double _radius, SelectionInterface::PrimitiveType _currentType, bool _deselect);
575 576

      /// SelectionInterface: Called when closest boundary selection operation has been performed
577
      void slotClosestBoundarySelection(QMouseEvent* _event, SelectionInterface::PrimitiveType _currentType, bool _deselect);
578 579

      /// SelectionInterface: Called when flood fill selection operation has been performed
580
      void slotFloodFillSelection(QMouseEvent* _event, double _maxAngle, SelectionInterface::PrimitiveType _currentType, bool _deselect);
581

582 583 584
      /// SelectionInterface: Called when connected components selection operation has been performed
      void slotComponentsSelection(QMouseEvent* _event, SelectionInterface::PrimitiveType _currentType, bool _deselect);

585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607
      /// 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
608

Jan Möbius's avatar
Jan Möbius committed
609 610 611 612 613 614 615
      /** \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
616 617
      void slotGetAllFilters ( QStringList& _list);

618

619 620
      /// Called when a plugin wants to delete all objects
      void slotDeleteAllObjects( );
621 622 623
      
      /// Called to create inter plugin connections
      void slotCrossPluginConnect( QString _pluginName1, const char* _signal, QString _pluginName2, const char* _slot);
624

625 626 627
      /// called to switch the renderer for a specific viewer
      void slotSetRenderer(unsigned int _viewer, QString _rendererName);

Jan Möbius's avatar
Jan Möbius committed
628 629 630
      /// called to get the currently active renderer renderer for a specific viewer
      void slotGetCurrentRenderer(unsigned int _viewer, QString& _rendererName);

Dirk Wilden's avatar
Dirk Wilden committed
631
      /// Get a Pointer to the Plugin with given _name (if it is loaded)
Jan Möbius's avatar
Jan Möbius committed
632
      //  void slotGetPlugin(QString _name, QObject* & _plugin );
Dirk Wilden's avatar
Dirk Wilden committed
633

Jan Möbius's avatar
 
Jan Möbius committed
634 635 636 637 638 639 640 641 642 643 644
   /** @} */

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

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

645 646 647
    /// process events during script execution to keep the ui alive
    void updateUI();

Jan Möbius's avatar
 
Jan Möbius committed
648 649 650
    /// Clear all data objects
    void clearAll();

651 652 653
    /// Called to delete an object
    void deleteObject( int _id );

654 655 656 657
    void setObjectComment(int objId, QString key, QString comment);
    void clearObjectComment(int objId, QString key);
    void clearAllComments(int objId);

658 659
    /// set fullscreen mode
    void fullscreen( bool _state );
660 661 662
    
    /// Show or Hide the viewmode control widget.
    void showViewModeControls( bool _show );
663

Jan Möbius's avatar
Jan Möbius committed
664 665
    /// Change the logging window state
    void loggerState(int _state);
666 667 668
    
    /// Enable or disable OpenMesh error logging
    void enableOpenMeshErrorLog(bool _state);
Jan Möbius's avatar
 
Jan Möbius committed
669

670 671
    /// Show or hide toolbox
    void showToolbox( bool _state );
Jan Möbius's avatar
 
Jan Möbius committed
672

673 674 675
    /// Show or hide Status Bar
    void showStatusBar( bool _state );

676 677
    /// Switch the multiView Mode
    void multiViewMode( int _mode );
Jan Möbius's avatar
 
Jan Möbius committed
678

679 680 681 682 683 684
    /// Enable or disable framerate restriction
    void restrictFrameRate( bool _enable );

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

685 686
    /// set the baseFilename for snapshots (a counter is automatically increased when
    /// snapshot() is called)
687
    void snapshotBaseFileName(QString _fname, unsigned int _viewerId = 0);
688 689
    
    /// Set the file type for snapshots.
690
    void snapshotFileType(QString _type, unsigned int _viewerId = 0);
691 692 693
    
    /// Set the start index for the snapshot counter
    void snapshotCounterStart(const int _counter, unsigned int _viewerId = 0);
694

695 696 697
    /** 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.
698
      The id of the current viewer is 0 (default).
699
    */
700
    void snapshot(unsigned int _viewerId = 0, int _width = 0, int _height = 0, bool _alpha = false, bool _hideCoordsys = false, int _numSamples = 1);
701

Dirk Wilden's avatar
Dirk Wilden committed
702 703 704 705 706 707
    /// 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
708 709 710
    /// Take a snapshot from all viewers
    void viewerSnapshot();

Dirk Wilden's avatar
 
Dirk Wilden committed
711
    /// resize the examinerViewer
712 713 714 715
    void resizeViewers(int _width, int _height );

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

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

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

723 724 725 726 727 728
    /// Block the scenegraph updates
    void blockSceneGraphUpdates();

    /// Unblock the scenegraph updates
    void unblockSceneGraphUpdates();

729 730
    void setView(QString view);

731 732 733 734 735 736
   //===========================================================================
    /** @name Scripting functions for controlling view modes
    * @{ */
   //===========================================================================

public slots:
737
    /** \brief Scripting function to set toolboxes in a view mode
Jan Möbius's avatar
Jan Möbius committed
738 739 740
     *
     * @param _modeName Name of the View Mode
     * @param _toolboxList ; separated list of toolboxes in the view mode
741
    */
742 743 744
    void addViewModeToolboxes(QString _modeName, QString _toolboxList);
    
    /** \brief Scripting function to set toolbars in a view mode
Jan Möbius's avatar
Jan Möbius committed
745 746 747 748
     *
     * @param _modeName Name of the View Mode
     * @param _toolbarList ; separated list of toolbars in the view mode
     *
749 750
    */
    void addViewModeToolbars(QString _modeName, QString _toolbarList);
Jan Möbius's avatar
Marlin:  
Jan Möbius committed
751 752
    
    /** \brief Scripting function to set context menus in a view mode
Jan Möbius's avatar
Jan Möbius committed
753 754 755
     *
     * @param _modeName Name of the View Mode
     * @param _contextMenuList ; separated list of context menus in the view mode
Jan Möbius's avatar
Marlin:  
Jan Möbius committed
756 757
    */
    void addViewModeContextMenus(QString _modeName, QString _contextMenuList);
758 759
    
    /** \brief Scripting function to set an icon for a view mode
Jan Möbius's avatar
Jan Möbius committed
760 761
     * @param _modeName Name of the View Mode
     * @param _iconName Name of the Icon File. Will be taken from OpenFlippers Icon directory
762 763
    */
    void addViewModeIcon(QString _modeName, QString _iconName);    
764 765
    
    /** \brief Scripting function to set the side of the main window on which the toolbox should be displayed
Jan Möbius's avatar
Jan Möbius committed
766 767
     *
     * @param _side The desired side (either "left" or "right")
768 769
    */
    void setToolBoxSide(QString _side);
770

Jan Möbius's avatar
Jan Möbius committed
771 772 773 774
    /** \brief Scripting function to activate or deactivate a toolbox
     *
     * @param _toolBoxName Name of the toolbox to manipulate
     * @param _active      Activate or deactivate
Dirk Wilden's avatar
Dirk Wilden committed
775 776
    */
    void setToolBoxActive(QString _toolBoxName, bool _active);
Jan Möbius's avatar
Jan Möbius committed
777

Jan Möbius's avatar
 
Jan Möbius committed
778 779 780 781 782 783
    /** @} */

   //===========================================================================
    /** @name Basic functions
    * @{ */
   //===========================================================================
784
public slots:
Jan Möbius's avatar
Jan Möbius committed
785 786 787 788 789
  /** \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
790 791 792 793
   *  @param _filename Filename of the data
   *  @return id of object otherwise -1
   */
  int loadObject ( QString _filename );
794 795
  
private slots:
796 797 798 799 800
  /** 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
801 802 803

 public :

Jan Möbius's avatar
Jan Möbius committed
804 805 806 807 808 809
  /** \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.
810 811 812 813
  *
  * @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
814
  */
815
  void commandLineOpen(const char* _filename, bool _asPolyMesh );
Jan Möbius's avatar
 
Jan Möbius committed
816

817 818 819 820 821 822 823 824 825 826
  /** \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
827 828
  void commandLineScript(const char* _filename );

829 830
  private slots:

Jan Möbius's avatar
Jan Möbius committed
831
  /** \brief Executed after loading core completly to load files from commandline
832
  *
Jan Möbius's avatar
Jan Möbius committed
833 834 835
  * 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.
836
  */
Jan Möbius's avatar
Jan Möbius committed
837
  void slotExecuteAfterStartup();
838 839

  private:
Jan Möbius's avatar
Jan Möbius committed
840
    /// Vector storing filenames from commandline to be opened after application startup (objects)
841
    std::vector< std::pair < std::string , bool >  > commandLineFileNames_;
Jan Möbius's avatar
Jan Möbius committed
842 843
    
    /// Vector storing filenames from commandline to be opened after application startup (script files)
844
    std::vector< std::string > commandLineScriptNames_;
845 846 847

  public:

Jan Möbius's avatar
 
Jan Möbius committed
848 849 850 851 852
  /** 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
853 854 855 856 857
  /** \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
858 859 860 861
   * @return id of the new object or -1 if unsupported
   */
  int loadObject( DataType _type, QString _filename);

862
  /** @} */
Jan Möbius's avatar
 
Jan Möbius committed
863

864
  //===========================================================================
Jan Möbius's avatar
Jan Möbius committed
865 866 867 868 869 870 871 872 873 874
  /** @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
875 876
  public slots:

Jan Möbius's avatar
Jan Möbius committed
877
    /// Start video capturing
Dirk Wilden's avatar
Dirk Wilden committed
878
    void startVideoCapture(QString _baseName, int _fps, bool _captureViewers);
Jan Möbius's avatar
Jan Möbius committed
879 880

    /// Stop video capturing
Dirk Wilden's avatar
Dirk Wilden committed
881
    void stopVideoCapture();
Jan Möbius's avatar
Jan Möbius committed
882 883 884 885 886

  private:
    QTimer videoTimer_;
    QTime  lastVideoTime_;

Dirk Wilden's avatar
Dirk Wilden committed
887 888
    int captureType_;

889 890
    bool capture_;

891 892 893
    int lastWidth_;
    int lastHeight_;

Jan Möbius's avatar
Jan Möbius committed
894 895
  /** @} */
  //===========================================================================
896 897 898 899 900 901 902 903 904 905
    /** @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
906 907
    
    void saveObject( int _id, QString _filename, int _pluginID );
908 909
    
    void saveObjects( IdList _ids, QString _filename, int _pluginID );
910

911 912 913 914 915 916
    /** 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 );

917 918
    bool saveObjectsTo( IdList _ids, QString _filename );
      
919 920 921 922 923 924
    /// Slot for saving objects from Menu
    void saveAllObjects();

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

925
    /// Save current status to a settings file. Solicit file name through dialog.
926 927
    void saveSettings();

928 929 930 931
    /// Save current status to a the provided settings file
    void saveSettings(QString filePath, bool is_saveObjectInfo, bool is_targetOnly, bool is_saveAll,
                      bool is_askOverwrite, bool is_saveProgramSettings, bool is_savePluginSettings);

932 933 934 935 936 937 938 939
    /// 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
940

941 942 943
    /// Get object id from filename
    int getObjectId(QString _filename);

Jan Möbius's avatar
Jan Möbius committed
944 945 946 947 948 949
    /** \brief Serialize material properties
     *
     * @param _objId  Id of the object where the material should be deserialized into
     * @param _props   A QString containing the serialized material
     */
    void deserializeMaterialProperties(int _objId, QString _props);
950

Jan Möbius's avatar
Jan Möbius committed
951 952 953 954 955
    /** \brief Serialize material properties
     *
     * @param _objId  Id of the object where the material should be serialized
     * @return A Qstring containing the serialized material
     */
956 957
    QString serializeMaterialProperties(int _objId);

Jan Möbius's avatar
 
Jan Möbius committed
958 959 960 961 962 963 964 965 966 967 968 969 970 971
  /** @} */

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

972 973 974 975
      /** \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
976 977
      void slotAddEmptyObjectMenu();

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

981 982 983
      /// Slot copying an object
      void slotCopyObject( int _oldId , int& _newId );

Jan Möbius's avatar
 
Jan Möbius committed
984 985 986 987 988
      /// Exit Application
      void slotExit();

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

990 991 992
      /// Slot for generating type specific backups
      void slotGenerateBackup( int _id, QString _name, UpdateType _type );

Jan Möbius's avatar
Jan Möbius committed
993
   public slots:
Jan Möbius's avatar
Jan Möbius committed
994

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

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

1001 1002 1003
     /**
      * Get a toolbox.
      *
1004
      * @param _pluginName The plugin which the requested toolbox belongs to.
1005
      * @param _toolboxName The name of the requested toolbox.
1006
      * @return A pointer to the requested toolbox widget if it was found, nullptr, otherwise.
1007 1008 1009
      */
     QWidget *getToolbox(QString _pluginName, QString _toolboxName);

Jan Möbius's avatar
Jan Möbius committed
1010 1011
     void activateToolbox(QString _pluginName, QString _toolboxName, bool activate);

Jan Möbius's avatar
 
Jan Möbius committed
1012 1013 1014 1015 1016 1017 1018 1019 1020
   private :

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

   private:
      /// Scenegraphs root node
Dirk Wilden's avatar
Dirk Wilden committed
1021
      SeparatorNode* root_node_scenegraph_;
1022 1023 1024
      
      /// Seperator node for global nodes
      SeparatorNode* root_node_scenegraph_global_;
Dirk Wilden's avatar
Dirk Wilden committed
1025

Jan Möbius's avatar
Jan Möbius committed
1026 1027 1028 1029 1030 1031 1032 1033 1034
      /// 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
1035

1036 1037 1038
      /// Node for coordsys Material
      ACG::SceneGraph::MaterialNode* coordsysMaterialNode_;

1039 1040
      /// Node for the coordinate system
      ACG::SceneGraph::CoordsysNode* coordsysNode_;
Jan Möbius's avatar
 
Jan Möbius committed
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051

   /** @} */

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

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

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

Jan Möbius's avatar
 
Jan Möbius committed
1055 1056 1057 1058 1059 1060
   /// Get and set Application options from ini file
   void readApplicationOptions(INIFile& _ini);

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

1061 1062 1063
   /// Restore key assignments from configs files
   void restoreKeyBindings();

Jan Möbius's avatar
 
Jan Möbius committed
1064 1065
  public slots:

Dirk Wilden's avatar
Dirk Wilden committed
1066 1067 1068
   /// Save the current options to the standard ini file
   void saveOptions();

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

1072 1073 1074 1075 1076
   /** \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
1077
    * @param _coreSettings      Load core settings from the file
1078
    * @param _perPluginSettings Load per plugin settings from the file
1079
    * @param _loadObjects       Load objects defined in the ini file
1080 1081
    *
    */
1082 1083 1084 1085
   void openIniFile( QString _filename,
                     bool    _coreSettings ,
                     bool    _perPluginSettings,
                     bool    _loadObjects );
Jan Möbius's avatar
 
Jan Möbius committed
1086 1087 1088 1089 1090 1091

  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
1092
    *
Jan Möbius's avatar
Jan Möbius committed
1093 1094 1095
    * @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.
1096 1097
    * @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.
Jan Möbius's avatar
Jan Möbius committed
1098 1099
    * @param _saveObjectInfo     If you want to store information about all open objects this has to be true
    * @param _fileMapping        If multiple files have the same name, all duplicates get renamed. Mapping: Id -> new file name.
Jan Möbius's avatar
 
Jan Möbius committed
1100
    */
1101 1102 1103 1104 1105
   void writeIniFile( QString _filename,
                      bool    _relativePaths,
                      bool    _targetOnly,
                      bool    _saveSystemSettings,
                      bool    _savePluginSettings ,
1106 1107
                      bool    _saveObjectInfo,
                      std::map<int,QString>& _fileMapping);
Jan Möbius's avatar
 
Jan Möbius committed
1108 1109 1110 1111 1112

   /** \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 )
    */
1113
   void writeObjFile(QString _filename, bool _relativePaths, bool _targetOnly, std::map<int,QString>& _fileMapping);
Jan Möbius's avatar
 
Jan Möbius committed
1114 1115 1116 1117 1118 1119

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

   /** @} */

1120
   
Jan Möbius's avatar
 
Jan Möbius committed
1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143
  //===========================================================================
  /** @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
1144 1145 1146 1147 1148 1149 1150 1151 1152 1153
    /// 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
1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178
  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
      * @{ */
  //===========================================================================

Jan Möbius's avatar
Jan Möbius committed
1179 1180 1181
  public :
    const std::vector<PluginInfo> plugins() const {return plugins_; };

Jan Möbius's avatar
 
Jan Möbius committed
1182
  private:
Jan Möbius's avatar
Jan Möbius committed
1183 1184
    /// List of all loaded plugins_
    std::vector<PluginInfo> plugins_;
Jan Möbius's avatar
 
Jan Möbius committed
1185 1186 1187 1188 1189 1190 1191

    /// Index of Plugins toolbox widget
    int toolboxindex_;

    /// Load all plugins from default plugin directory and from INI-File
    void loadPlugins();
  private slots:
Dirk Wilden's avatar
Dirk Wilden committed
1192 1193
    /// Show Plugins Dialog
    void slotShowPlugins();
Jan Möbius's avatar
 
Jan Möbius committed
1194

1195 1196
    /// Function for loading Plugins
    void loadPlugin(const QString& _filename,const bool _silent, QString& _licenseErrors , QObject* _plugin = 0 );
Jan Möbius's avatar
 
Jan Möbius committed
1197 1198 1199 1200

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

1201 1202 1203 1204 1205 1206
    /// Function for Blocking Plugins. Blocked plugins will unloaded and not loaded wthin the next starts
    void slotBlockPlugin(const QString &_rpcName);

    /// Function for UnBlocking Plugins. Plugins will not loaded automatically
    void slotUnBlockPlugin(const QString &_rpcName);

Jan Möbius's avatar
 
Jan Möbius committed
1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222
  /** @} */


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

  signals:

    void scriptInfo( QString _pluginName , QString _functionName  );

    void executeScript( QString _script );

    void executeFileScript( QString _filename );

1223 1224
    void setSlotDescription(QString     _slotName,   QString     _slotDescription,
                            QStringList _parameters, QStringList _descriptions);
1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235

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

1236 1237 1238
    /// Set the active ViewMode
    void setViewMode(QString _viewMode);

1239 1240 1241
    /// Get current view mode
    QString getCurrentViewMode();

Dirk Wilden's avatar
Dirk Wilden committed
1242 1243
    /// Set the icon of a viewMode
    void setViewModeIcon(QString _mode, QString _iconName);
1244 1245
    
    /// Move selected toolbox to top of side area
1246
    void moveToolBoxToTop(QString _name);
1247 1248
    
    /// Move selected toolbox to bottom of side area
1249
    void moveToolBoxToBottom(QString _name);
Dirk Wilden's avatar
Dirk Wilden committed
1250

Jan Möbius's avatar
Jan Möbius committed
1251 1252
    void showReducedMenuBar