Core.hh

Go to the documentation of this file.

/*===========================================================================*\
 *                                                                           *
 *                              OpenFlipper                                  *
 *      Copyright (C) 2001-2009 by Computer Graphics Group, RWTH Aachen      *
 *                           www.openflipper.org                             *
 *                                                                           *
 *---------------------------------------------------------------------------*
 *  This file is part of OpenFlipper.                                        *
 *                                                                           *
 *  OpenFlipper is free software: you can redistribute it and/or modify      *
 *  it under the terms of the GNU Lesser General Public License as           *
 *  published by the Free Software Foundation, either version 3 of           *
 *  the License, or (at your option) any later version with the              *
 *  following exceptions:                                                    *
 *                                                                           *
 *  If other files instantiate templates or use macros                       *
 *  or inline functions from this file, or you compile this file and         *
 *  link it with other files to produce an executable, this file does        *
 *  not by itself cause the resulting executable to be covered by the        *
 *  GNU Lesser General Public License. This exception does not however       *
 *  invalidate any other reasons why the executable file might be            *
 *  covered by the GNU Lesser General Public License.                        *
 *                                                                           *
 *  OpenFlipper is distributed in the hope that it will be useful,           *
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of           *
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the            *
 *  GNU Lesser General Public License for more details.                      *
 *                                                                           *
 *  You should have received a copy of the GNU LesserGeneral Public          *
 *  License along with OpenFlipper. If not,                                  *
 *  see <http://www.gnu.org/licenses/>.                                      *
 *                                                                           *
\*===========================================================================*/

/*===========================================================================*\
 *                                                                           *
 *   $Revision: 8694 $                                                         *
 *   $Author: wilden $                                                      *
 *   $Date: 2010-03-09 18:49:22 +0100 (Di, 09. Mär 2010) $                   *
 *                                                                           *
\*===========================================================================*/




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

#ifndef MVIEWWIDGET_HH
#define MVIEWWIDGET_HH


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

#include <OpenFlipper/widgets/glWidget/QtBaseViewer.hh>

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

#include <QDockWidget>
#include <QVector>
#include <QProgressDialog>

#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"
#include "OpenFlipper/Scripting/scriptPrototypes/prototypeDataType.hh"
#include <OpenFlipper/Scripting/scriptWrappers/vec3dWrapper.hh>
#include <OpenFlipper/Scripting/scriptWrappers/matrix4x4Wrapper.hh>
#include <OpenFlipper/Scripting/scriptWrappers/DataTypeWrapper.hh>
// #include <OpenFlipper/Scripting/scriptWrappers/ObjectIdWrapper.hh>

// Required Interface definition ( Some variables were defined there )
#include "OpenFlipper/BasePlugin/BaseInterface.hh"
#include "OpenFlipper/BasePlugin/FileInterface.hh"
#include "OpenFlipper/BasePlugin/TypeInterface.hh"
#include "OpenFlipper/BasePlugin/MenuInterface.hh"
#include "OpenFlipper/BasePlugin/ContextMenuInterface.hh"

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

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

#include <OpenFlipper/common/GlobalOptions.hh>

#include <OpenFlipper/Core/PluginInfo.hh>

#include <ACG/Scenegraph/CoordsysNode.hh>
#include <ACG/Scenegraph/GridNode.hh>

#include <OpenFlipper/threads/JobInfo.hh>

//== CLASS DEFINITION =========================================================

struct fileTypes {
  QString name;
  DataType type;
  QString loadFilters;
  QString saveFilters;
  FileInterface* plugin;
  QObject* object;
};

struct dataTypes {
  QString name;
  DataType type;
  TypeInterface* plugin;
};

class Core : public QObject
{
  Q_OBJECT

public:

  Core();

  void init();

  ~Core();

  bool add_sync_host(const QString& _name);


private slots:

  void slotMouseEventIdentify( QMouseEvent* _event );

protected:

    //===========================================================================
   //===========================================================================
signals:
   void allCleared();

   void signalObjectUpdated(int);

   void signalObjectUpdated(int, const UpdateType);
   
   void PluginWheelEvent(QWheelEvent * , const std::string & );

   void PluginMouseEvent(QMouseEvent* );

   void PluginMouseEventIdentify( QMouseEvent* );

   void objectSelectionChanged( int );

   void pluginViewChanged();

   void addTexture( QString, QString , uint, int );

   void addTexture( QString, QString , uint );

   void addMultiTexture( QString _textureGroup , QString _name , QString _filename , int _id , int& _textureId );

   void updateTexture( QString , int );

   void updateAllTextures( );

   void updatedTextures( QString , int );

   void setTextureMode(QString _textureName ,QString _mode, int _id);

   void setTextureMode(QString _textureName ,QString _mode);

   void switchTexture( QString, int );

   void switchTexture( QString );

   void textureChangeImage( QString _textureName , QImage& _image );

   void textureChangeImage( QString _textureName , QImage& _image , int _id );

   void iniLoad( INIFile&, int );

   void iniSave( INIFile& _ini ,int _id );

   void iniSaveOptions(  INIFile& _ini );

   void iniLoadOptions(  INIFile& _ini );

   void iniLoadOptionsLast(  INIFile& _ini );

   void saveOnExit( INIFile& _ini );

   void createBackup( int _id , QString _name , int nextBackupId_);

   void openedFile( int _id );

   void emptyObjectAdded( int _id);

   void pluginsInitialized();

   void visibilityChanged(int _id);

   void objectPropertiesChanged( int _id );

   void objectDeleted( int );

   //===========================================================================
   //===========================================================================
   private slots :

      void slotObjectUpdated(int _identifier, const UpdateType _type = UPDATE_ALL);

      void slotVisibilityChanged(int _id);

      void slotObjectPropertiesChanged( int _id );

      void slotObjectSelectionChanged( int _id);

      void slotAddPickMode( const std::string _mode );

      void slotAddHiddenPickMode( const std::string _mode );

      void slotAddTexture( QString _textureName , QString _filename , uint _dimension , int _id );

      void slotAddTexture( QString _textureName , QString _filename , uint _dimension );

      void slotMultiTextureAdded( QString _textureGroup , QString _name , QString _filename , int _id , int& _textureId );

      void slotUpdateTexture( QString _name , int _identifier);

      void slotUpdateAllTextures( );

      void slotTextureUpdated( QString _textureName , int _identifier );

      void slotSetTextureMode(QString _textureName ,QString _mode, int _id);

      void slotSetTextureMode(QString _textureName ,QString _mode);

      void slotSwitchTexture( QString _textureName, int _id );

      void slotSwitchTexture( QString _textureName );

      void slotTextureChangeImage( QString _textureName , QImage& _image );

      void slotTextureChangeImage( QString _textureName , QImage& _image , int _id );

      void backupRequest( int _id , QString _name );

      void slotLoad(QString _filename, DataType _type, int& _id);

      void slotLoad(QString _filename, int _pluginID);
      
      void slotObjectOpened ( int _id );

      void slotEmptyObjectAdded ( int _id );

      void slotGetAllFilters ( QStringList& _list);

      void slotDeleteObject( int _id );

      void slotDeleteAllObjects( );

//       void slotGetPlugin(QString _name, QObject* & _plugin );

    //===========================================================================
   //===========================================================================
public slots:

    void updateView();

    void clearAll();

    void exitApplication();

    void fullscreen( bool _state );

    void loggerState(int _state);

    void showToolbox( bool _state );

    void multiViewMode( int _mode );

    void restrictFrameRate( bool _enable );

    void setMaxFrameRate( int _rate );

    void snapshotBaseFileName(const QString& _fname, unsigned int _viewerId = 0);

    void snapshot(unsigned int _viewerId = 0);

    void applicationSnapshot();

    void applicationSnapshotName(QString _name);

    void viewerSnapshot();

    void resizeViewers(int _width, int _height );

    void resizeApplication(int _width, int _height );

    void writeVersionNumbers(QString _filename);

    QList<int> objectList (QString _selection, QStringList _types);

   //===========================================================================
   //===========================================================================

public slots:
    void addViewModeToolboxes(QString _modeName, QString _toolboxList);
    
    void addViewModeToolbars(QString _modeName, QString _toolbarList);

   //===========================================================================
   //===========================================================================
private slots:
  int loadObject ( QString _filename );

  void resetScenegraph( bool _resetTrackBall );

 public :

  void commandLineOpen(const char* _filename, bool _asPolyMesh );

  void commandLineScript(const char* _filename );

  private slots:

  void slotExecuteAfterStartup();

  private:
    std::vector< std::pair < std::string , bool >  > commandLineFileNames_;
    
    std::vector< std::string > commandLineScriptNames_;

  public:

  int addEmptyObject( DataType _type );

  int loadObject( DataType _type, QString _filename);

  //===========================================================================
  //===========================================================================
  private slots:
    void viewUpdated();

    void captureVideo();

  public slots:

    void startVideoCapture(QString _baseName, int _fps, bool _captureViewers);

    void stopVideoCapture();

  private:
    QTimer videoTimer_;
    QTime  lastVideoTime_;

    int captureType_;

    bool capture_;

    int lastWidth_;
    int lastHeight_;

  //===========================================================================
  //===========================================================================

  public slots:

    bool saveObject( int _id, QString _filename );
    
    void saveObject( int _id, QString _filename, int _pluginID );

    bool saveObjectTo( int _id, QString _filename );

    void saveAllObjects();

    void saveAllObjectsTo();

    void saveSettings();

    void loadObject();

    void loadSettings();

    void loadSettings(QString _filename);

    int getObjectId(QString _filename);

  //===========================================================================
  //===========================================================================
   private slots :

      void slotMouseEvent( QMouseEvent* _event );

      void slotWheelEvent( QWheelEvent * _event, const std::string & _mode);

      void slotAddEmptyObjectMenu();

      void slotAddEmptyObject( DataType _type , int& _id );

      void slotCopyObject( int _oldId , int& _newId );

      void slotExit();

      void slotRecentOpen(QAction* _action);

   public slots:

     void addToolbox(QString _name ,QWidget* _widget);

   private :

   //===========================================================================
   //===========================================================================

   private:
      SeparatorNode* root_node_scenegraph_;

      SeparatorNode* core_nodes_;
      
      
      SeparatorNode* dataSeparatorNode_;
      
      SeparatorNode*  dataRootNode_;

      ACG::SceneGraph::MaterialNode* coordsysMaterialNode_;

      ACG::SceneGraph::CoordsysNode* coordsysNode_;

//       ACG::SceneGraph::GridNode* gridNode_;

   //===========================================================================
   //===========================================================================

   void setupOptions();

   void readGUIOptions(INIFile& _ini);

   void readRecentFiles(QString _filename);

   void readApplicationOptions(INIFile& _ini);

   void writeApplicationOptions(INIFile& _ini);

   void restoreKeyBindings();

  public slots:

   void saveOptions();

   void applyOptions();

   void openIniFile( QString _filename,
                     bool    _coreSettings ,
                     bool    _perPluginSettings,
                     bool    _loadObjects );

  private:

   void writeIniFile( QString _filename,
                      bool    _relativePaths,
                      bool    _targetOnly,
                      bool    _saveSystemSettings,
                      bool    _savePluginSettings ,
                      bool    _saveObjectInfo );

   void writeObjFile(QString _filename, bool _relativePaths, bool _targetOnly);

   void writeOnExit();

  //===========================================================================
  //===========================================================================

  signals:
    void log(Logtype _type , QString _message );

    void log(QString _message );

    void scriptLog(QString _message);

    void externalLog(Logtype _type , QString _message);

  private slots:

    void slotLog(Logtype _type, QString _message);

    void slotLogToFile(Logtype _type, QString _message);

  private:
    QTextStream* logStream_;

    QFile* logFile_;

  public :
    void scriptLogFunction( QString _output);

  //===========================================================================
  //===========================================================================

  private :
    bool checkSlot(QObject* _plugin , const char* _slotSignature);

    bool checkSignal(QObject* _plugin , const char* _signalSignature);

  //===========================================================================
  //===========================================================================

  private:
    std::vector<PluginInfo> plugins;

    int toolboxindex_;

    void loadPlugin(QString filename, bool silent);

    void loadPlugins();
  private slots:
    void slotShowPlugins();

    void unloadPlugin(QString name);

    void slotLoadPlugin();

  //===========================================================================
  //===========================================================================

  signals:

    void scriptInfo( QString _pluginName , QString _functionName  );

    void executeScript( QString _script );

    void executeFileScript( QString _filename );

    void setSlotDescription(QString     _slotName,   QString     _slotDescription,
                            QStringList _parameters, QStringList _descriptions);

  public slots:
    void createWidget(QString _objectName, QString _uiFilename);

    void setViewMode(QString _viewMode);

    void setViewModeIcon(QString _mode, QString _iconName);

  private :
    QScriptEngine scriptEngine_;

    std::vector<ScriptingWrapper*> scriptingWrappers_;

    QStringList scriptingFunctions_;

    prototypeVec3d vec3dPrototype_;
    
    prototypeDataType DataTypePrototype_;

    prototypeMatrix4x4 matrix4x4Prototype_;


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

    void slotExecuteScript( QString _script );

    void slotGetScriptingEngine( QScriptEngine*& _engine  );

    void slotGetAllAvailableFunctions( QStringList& _functions  );

    void slotSetSlotDescription(QString     _slotName,   QString _slotDescription,
                                QStringList _parameters, QStringList _descriptions);
    void slotGetDescription(QString _function, QString& _fnDescription,
                                QStringList& _parameters, QStringList& _descriptions );

  private:

    QList< SlotInfo > coreSlots_;

    void setDescriptions();

  //===========================================================================
  //===========================================================================
  private slots:
    void slotPluginExists( QString _pluginName , bool& _exists );


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

    void slotCall( QString _pluginName , QString _functionName , bool& _success  );

    void slotCall( QString _expression , bool& _success  );

    void slotGetValue(QString _expression, QVariant& _result );

  //===========================================================================
  //===========================================================================

  private slots:

    void checkScenegraphDirty();

  private:

    QTimer *scenegraphCheckTimer_;

    QTime *redrawTime_;

  //===========================================================================
  //===========================================================================
  
  private:
    
    QList< JobInfo* >  currentJobs;
    
    ProcessManagerWidget* processManager_;
    
    bool getJob(QString _jobId, int& _index);
    
  private slots:

    void slotStartJob( QString _jobId, QString _description , int _min , int _max,bool _blocking );
    
    void slotSetJobState(QString _jobId, int _value );
    
    void slotSetJobName(QString _jobId, QString _name );
    
    void slotSetJobDescription(QString _jobId, QString _text );
    
    void slotCancelJob(QString _jobId );
    
    void slotFinishJob(QString _jobId );
    
    void slotJobCancelRequested(QString _jobId);
    
  signals:
    
    void jobCanceled( QString _jobId );
    
  //===========================================================================
  //===========================================================================

  private slots:
    
    void newObject(int _objectId);
    
    void deletedObject(int _objectId);    
    
  private :

  int nextBackupId_;

  std::vector<PluginLogger*> loggers_;

  std::vector<fileTypes> supportedTypes_;
  
  std::vector<dataTypes> supportedDataTypes_;

  private :
    BaseObject* objectRoot_;

    CoreWidget* coreWidget_;

    QSplashScreen* splash_;

    QString splashMessage_;

    QVector<ViewMode*> viewModes_;

    QTimer* redrawTimer_;


};

QScriptValue myPrintFunction(QScriptContext *context, QScriptEngine *engine);

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