CoreWidget.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: 8662 $                                                         *
 *   $Author: wilden $                                                      *
 *   $Date: 2010-03-03 16:54:58 +0100 (Mi, 03. Mär 2010) $                   *
 *                                                                           *
\*===========================================================================*/


//=============================================================================
//
//  CLASS CoreWidget
//
//=============================================================================

#ifndef COREWIDGET_HH
#define COREWIDGET_HH


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

#include "OpenFlipper/common/Types.hh"
#include <OpenFlipper/common/GlobalOptions.hh>
#include <OpenFlipper/BasePlugin/ContextMenuInterface.hh>
#include <OpenFlipper/BasePlugin/LoggingInterface.hh>
#include <OpenFlipper/BasePlugin/MenuInterface.hh>
#include <OpenFlipper/BasePlugin/ViewInterface.hh>
#include <OpenFlipper/BasePlugin/StatusbarInterface.hh>

#include <OpenFlipper/widgets/coreWidget/SideArea.hh>
#include <OpenFlipper/widgets/coreWidget/ColorStatusBar.hh>

#include <OpenFlipper/widgets/glWidget/QtBaseViewer.hh>
#include <OpenFlipper/widgets/glWidget/QtGLGraphicsScene.hh>
#include <OpenFlipper/widgets/glWidget/QtGLGraphicsView.hh>
#include <OpenFlipper/widgets/glWidget/QtMultiViewLayout.hh>
#include <OpenFlipper/widgets/glWidget/QtSlideWindow.hh>
#include <OpenFlipper/widgets/glWidget/QtPickToolbar.hh>

// QT INCLUDES
#include <QMainWindow>
#include <QStackedWidget>
#include <QTextEdit>
#include <QToolBar>
#include <QStatusBar>

#include <QDockWidget>

#include <OpenFlipper/widgets/aboutWidget/aboutWidget.hh>
#include <OpenFlipper/widgets/loggerWidget/loggerWidget.hh>
#include <OpenFlipper/widgets/optionsWidget/optionsWidget.hh>
#include <OpenFlipper/widgets/helpWidget/helpWidget.hh>
#include <OpenFlipper/widgets/stereoSettingsWidget/stereoSettingsWidget.hh>

#include <OpenFlipper/Core/PluginInfo.hh>

#include <ACG/QtWidgets/QtSceneGraphWidget.hh>

#include <ACG/Scenegraph/DrawModes.hh>

#include <OpenFlipper/INIFile/INIFile.hh>
#include <OpenFlipper/BasePlugin/PluginFunctions.hh>

struct ViewMode{

  QString name;

  QString icon;

  bool custom;

  QStringList visibleToolboxes;

  QStringList visibleToolbars;

  QStringList visibleContextMenus;
};

class StackWidgetInfo {
  public:
    StackWidgetInfo(bool _editable,QString _name,QWidget* _widget);

    bool editable;
    QString name;
    QWidget* widget;
};

struct MenuInfo {
  QAction*          action;

  DataType        contextType;

  ContextMenuType type;
};

class CoreWidget : public QMainWindow
{
  Q_OBJECT

public:

  CoreWidget( QVector<ViewMode*>& _viewModes, std::vector<PluginInfo>& _plugins, QList< SlotInfo >& _coreSlots );

  ~CoreWidget();

  signals:
    void clearAll();
    void loadMenu();
    void addEmptyObjectMenu();
    void saveMenu();
    void saveToMenu();
    void loadIniMenu();
    void saveIniMenu();
    void recentOpen(QAction*);
    void exit();

    void loadPlugin();
    void showPlugins();

  private slots:

    void closeEvent ( QCloseEvent * event );

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

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

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

  protected :

    virtual void keyPressEvent (QKeyEvent* _e);
    virtual void keyReleaseEvent(QKeyEvent* _e);

    // Filter alt key events under windows
    //bool eventFilter(QObject *obj, QEvent *ev);

  signals :

    void PluginKeyEvent(QKeyEvent* );

    void PluginKeyReleaseEvent(QKeyEvent* );

    void registerKey(int _key, Qt::KeyboardModifiers _modifiers, QString _description,
                     bool _multiUse = false);

    void call( QString _expression , bool& _success  );

  private:
    typedef std::multimap<  std::pair< int, Qt::KeyboardModifiers >  ,  std::pair< QObject*, int > > KeyMap;

    typedef std::multimap< std::pair< QObject*, int >, std::pair< int, Qt::KeyboardModifiers > > InverseKeyMap;

    typedef std::pair< KeyMap::iterator, KeyMap::iterator > KeyRange;

    void registerCoreKeys();

    void coreKeyPressEvent();

    void coreKeyPressEvent  (QKeyEvent* _e);
    void coreKeyReleaseEvent(QKeyEvent* _e);

    KeyBinding getKeyBinding(QObject* _plugin, int _keyIndex );
    QString    getRPCName(QObject* _plugin );

    std::vector<KeyBinding> coreKeys_;

    KeyMap keys_;

    InverseKeyMap invKeys_;

    QList< SlotInfo >& coreSlots_;

  private slots:
    void slotRegisterKey(int _key, Qt::KeyboardModifiers _modifiers, QString _description,
                         bool _multiUse = false);

  public slots:
    void slotAddKeyMapping(int _key, Qt::KeyboardModifiers _modifiers, QObject* _plugin, int _keyBindingID);

    void slotRegisterSlotKeyBindings();

  public:
    void loadKeyBindings(INIFile& _ini);

    void saveKeyBindings(INIFile& _ini);

  private:
    bool shiftPressed_;

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

  public:

    void setupMenuBar();

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

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

    void resizeViewers(int _width, int _height);
    void resizeApplication(int _width, int _height);

  private slots:
    void startVideoCaptureDialog();

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

  public:

  void addRecent(QString _filename, DataType _type);

  void updateRecent();

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

  public :
    void toggleFullscreen();

    void setFullscreen(bool _state );

    void toggleLogger();

    void showLogger(OpenFlipper::Options::LoggerState _state);

    void toggleToolbox();

    void showToolbox( bool _state );

    void setForceNativeCursor ( bool _state );

    QSize defaultIconSize();

  private:
    OpenFlipper::Options::LoggerState loggerState_;

    uint fullscreenState_;
    
    QSize defaultIconSize_;

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

    private:
      QVector<QWidget*> toolWidgets_;

    public:
      QVector<ViewMode*>& viewModes_;

    private:

      QPushButton* viewModeButton_;

      QMenu* viewModeMenu_;

    public slots:

      void initViewModes(  );

      void slotAddViewModeToolboxes(QString _mode, QStringList _usedWidgets);

      void slotAddViewModeToolboxes(QString _mode, bool _custom, QStringList _usedWidgets);

      void slotAddViewModeToolbars(QString _mode, QStringList _usedToolbars);

      void slotAddViewModeToolbars(QString _mode, bool _custom, QStringList _usedToolbars);

      void slotAddViewModeComplete(QString _mode , bool _custom, QStringList _toolboxes, QStringList _toolbars);

      void slotSetViewModeIcon(QString _mode, QString _iconName);

      void slotSetViewModeIcon(QString _mode, bool _custom, QString _iconName);

      void slotChangeView(QString _mode, QStringList _toolboxWidgets, QStringList _toolbars);

    private slots:
      void slotRemoveViewMode(QString _name);

      void slotSetViewMode( QAction* action);


      void slotViewModeDialog();

      void slotViewChangeDialog();

    public slots :
      void setViewMode( QString _mode );

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

  public :

    std::vector< glViewer* >  examiner_widgets_;

    QSplitter* splitter_;

    LoggerWidget* logWidget_;

    int originalLoggerSize_;

    QMenu* recentFilesMenu_;

    QMenu* helpMenu_;

    QGLWidget* glWidget_;

    QtGLGraphicsScene* glScene_;

    QtGLGraphicsView* glView_;

    QGraphicsWidget* centerWidget_;

    QtMultiViewLayout* baseLayout_;

    QtSlideWindow* slidingLogger_;

    QWidget* tempLogWidget;

    QWidget* toolBoxArea_;

    QPushButton* vmChangeButton_;

    QSplitter* toolSplitter_;

    SideArea* toolBox_;

    QScrollArea* toolBoxScroll_;

    QtPickToolbar* pickToolbar_;

    CursorPainter* cursorPainter_;


    // widget showing the scenegraph
    ACG::QtWidgets::QtSceneGraphDialog* sceneGraphDialog_;

  private slots:

    void slotShowSceneGraphDialog();


   void slotActivateExaminer ();


   void slotLog(Logtype _type, QString _message);

   void sceneRectChanged(const QRectF &rect);

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

    void slotAddMenubarAction( QAction* _action , QString _name );
    void slotGetMenubarMenu (QString _name, QMenu *& _menu, bool _create);

  private:

    QMenu *fileMenu_;

    QMenu *viewMenu_;

    QMenu *toolsMenu_;

    QAction* fileMenuEnd_;

    QMap<QString, QMenu *> menus_;

  //===========================================================================
  //===========================================================================
  private:
    QToolBar* viewerToolbar_;

    int toolbarCount_;

    QToolButton* stereoButton_;
    QToolButton* moveButton_;
    QToolButton* lightButton_;
    QToolButton* pickButton_;
    QToolButton* questionButton_;

    QComboBox* viewerLayoutBox_;

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

  public slots:
    void slotUpdateGlobalDrawMenu();


    void setViewerLayout(int _idx);

  private slots:
    void nextViewerLayout();

    void slotGlobalDrawMenu(QAction * _action);

    void slotViewMenuAboutToShow();

  private:
    QMenu* globalDrawMenu_;

    QActionGroup * drawGroup_;

    QActionGroup* viewGroup_;

    QAction* perspectiveProjectionAction_;
    QAction* orthogonalProjectionAction_;

    QAction* globalAnimationAction_;

    QAction* globalBackfaceCullingAction_;

    QAction* globalTwosidedLightingAction_;

    QAction* globalMultisamplingAction_;

    ACG::SceneGraph::DrawModes::DrawMode activeDrawModes_;

    ACG::SceneGraph::DrawModes::DrawMode availableGlobalDrawModes_;

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

  signals :
    void updateContextMenu(int);

    void updateContextMenuNode(int);

    void updateContextMenuBackground();


  private slots:
    void slotCustomContextMenu( const QPoint& _point );

    void slotAddContextItem(QAction* _entry, ContextMenuType _type);

    void slotAddContextItem( QAction* _entry , DataType _dataType ,ContextMenuType type_);

    void slotPasteView( );

    void slotCopyView( );

    void slotViewerDrawMenu( QAction * _action );

    void slotUpdateViewerDrawMenu();

    void slotSnapshot();

    void slotSwitchWheels(bool _state);

    void slotSwitchNavigation(bool _egomode);

    void slotSnapshotName();

    void slotCoordSysVisibility(bool _visible);

  private :
    void updatePopupMenu(const QPoint& _point);

    void updatePopupMenuCoordsysNode(QMenu* _menu , const int _part);
    void updatePopupMenuObject(QMenu* _menu , BaseObjectData* _object );
    void updatePopupMenuBackground(QMenu* _menu , const QPoint& _point);
    void updatePopupMenuNode(QMenu* _menu , ACG::SceneGraph::BaseNode* _node);

    bool addContextMenus( QMenu* _menu , ContextMenuType _type, int _id = -1);

  private :
    QMenu*  contextMenu_;

    QMenu*  contextSelectionMenu_;

    std::vector< MenuInfo > contextMenus_;

    QActionGroup* drawGroupViewer_;

    QMenu* viewerDrawMenu_;

    QMenu* coordSysMenu_;

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

  private:

    QString snapshotName_;
    int     snapshotCounter_;

  public slots:

    void viewerSnapshotDialog();

    void viewerSnapshot();

    void applicationSnapshotDialog();

    void applicationSnapshot();

    void applicationSnapshotName(QString _name);


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

  private slots:
    void slotGetStackWidget( QString _name, QWidget*& _widget );
    void slotAddStackWidget( QString _name, QWidget* _widget );
    void slotUpdateStackWidget( QString _name, QWidget* _widget );

    void slotViewMenuAction( QAction * _action);

    void slotUpdateStackMenu();


  private :
    QMenu* stackMenu_;

    std::vector< StackWidgetInfo > stackWidgetList_;

  public :
    QStackedWidget* stackedWidget_;

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

  public slots:
    void showHelpBrowser();

  private:
    HelpWidget* helpWidget_;

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

  public slots:
    void stereoButtonContextMenu(const QPoint& _pos);

    void slotApplyStereoSettings(int _tmpParam = 0);


  private:
    StereoSettingsWidget* stereoSettingsWidget_;

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

  public slots:
    void showAboutWidget();

  private:
    AboutWidget* aboutWidget_;

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

  public slots:
    void showOptionsWidget();

  signals:
    void applyOptions();
    void saveOptions();

  private:

    OptionsWidget* optionsWidget_;

  //===========================================================================
  //===========================================================================
  private slots:
    void slotAddToolbar(QToolBar* _toolbar);

    void slotRemoveToolbar(QToolBar* _toolbar);

    void getToolBar( QString _name, QToolBar*& _toolbar);

  private :
    QToolBar* mainToolbar_;

    std::vector< QToolBar* > toolbars_;

  //===========================================================================
  //===========================================================================
  public slots:
    void statusMessage(QString _message, int _timeout = 0);

    void clearStatusMessage();

    void setStatus( ApplicationStatus::applicationStatus _status);

    void addWidgetToStatusbar(QWidget* _widget);
    
  private:
    void setupStatusBar();

  private :
    ColorStatusBar* statusBar_;

    QLabel* statusIcon_;

  //===========================================================================
  //===========================================================================
  
  signals:
    void dragOpenFile(QString _filename);
  
  private slots:
    void startDrag( QMouseEvent* _event );

    void dragEnterEvent(QDragEnterEvent* _event);

    void dropEvent( QDropEvent* _event );
    
  private :

  std::vector<PluginInfo>& plugins_;


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

  private slots:

    void slotToggleStereoMode();

    void slotSetGlobalBackgroundColor();

    void slotSetContextBackgroundColor();



    void slotContextHomeView();

    void slotGlobalHomeView();



    void slotContextSetHomeView();

    void slotGlobalSetHomeView();



    void slotContextViewAll();

    void slotGlobalViewAll();


    void slotContextSwitchProjection();

    void slotGlobalPerspectiveProjection();

    void slotGlobalOrthographicProjection();


    void slotSetViewingDirection(QAction* _action);


    void slotGlobalChangeAnimation(bool _animation);

    void slotLocalChangeAnimation(bool _animation);



    void slotGlobalChangeBackFaceCulling(bool _backFaceCulling);

    void slotLocalChangeBackFaceCulling(bool _backFaceCulling);



    void slotGlobalChangeTwoSidedLighting(bool _lighting);

    void slotLocalChangeTwoSidedLighting(bool _lighting);



    void slotGlobalChangeMultisampling(bool _lighting);

    void slotLocalChangeMultisampling(bool _lighting);

    void moveBack();

    void moveForward();

    void strafeLeft();

    void strafeRight();

  private :
    bool stereoActive_;

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

  public slots:

    bool examineMode() { return(actionMode_ == Viewer::ExamineMode  ); };
    bool pickingMode() { return(actionMode_ == Viewer::PickingMode  ); };
    bool lightMode()   { return(actionMode_ == Viewer::LightMode    ); };
    bool questionMode(){ return(actionMode_ == Viewer::QuestionMode ); };

    void setExamineMode() { setActionMode(Viewer::ExamineMode  ); };
    void setPickingMode() { setActionMode(Viewer::PickingMode  ); };
    void setLightMode()   { setActionMode(Viewer::LightMode    ); };
    void setQuestionMode(){ setActionMode(Viewer::QuestionMode ); };

    void setActionMode(const Viewer::ActionMode  _am);
    void getActionMode(Viewer::ActionMode& _am);

  public:
    Viewer::ActionMode actionMode() { return actionMode_; };
    Viewer::ActionMode lastActionMode() { return lastActionMode_; };

  private :
    Viewer::ActionMode actionMode_, lastActionMode_;

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

  public:

    void addPickMode(const std::string& _name,
                     bool               _mouse_tracking = false,
                     int                _pos            = -1,
                     bool               _visible        = true,
                     QCursor            _cursor         = Qt::ArrowCursor );

    void clearPickModes();

    const std::string& pickMode() const;

    void pickMode( int _id );

  public slots:

    void setPickMode(const std::string  _name);


    void getPickMode(std::string& _name);

  public slots:

    void setPickModeCursor(const std::string& _name, QCursor _cursor);

    void setPickModeMouseTracking(const std::string& _name, bool _mouseTracking);

    void setPickModeToolbar( const std::string _mode , QToolBar * _toolbar );

    void removePickModeToolbar( const std::string _mode );

    void actionPickMenu( QAction * _action );

  signals:
    void signalPickModeChanged(const std::string&);

  private:

    QMenu* pickMenu_;

    struct PickMode
    {
      PickMode(const std::string& _n, bool _t, bool _v, QCursor _c, QToolBar *_tb = NULL) :
               name(_n), tracking(_t), visible(_v), cursor(_c), toolbar(_tb) {}

      std::string  name;

      bool         tracking;

      bool         visible;

      QCursor      cursor;

      QToolBar *   toolbar;
    };

    std::vector<PickMode>  pick_modes_;

    std::string            pick_mode_name_;

    int                    pick_mode_idx_;


    void updatePickMenu();

  private slots:

    void hidePopupMenus();
};


//=============================================================================
#endif // COREWIDGET_HH defined
//=============================================================================