ViewControlPlugin.hh

/*===========================================================================*\
*                                                                            *
*                              OpenFlipper                                   *
 *           Copyright (c) 2001-2015, RWTH-Aachen University                 *
 *           Department of Computer Graphics and Multimedia                  *
 *                          All rights reserved.                             *
 *                            www.openflipper.org                            *
 *                                                                           *
 *---------------------------------------------------------------------------*
 * This file is part of OpenFlipper.                                         *
 *---------------------------------------------------------------------------*
 *                                                                           *
 * Redistribution and use in source and binary forms, with or without        *
 * modification, are permitted provided that the following conditions        *
 * are met:                                                                  *
 *                                                                           *
 * 1. Redistributions of source code must retain the above copyright notice, *
 *    this list of conditions and the following disclaimer.                  *
 *                                                                           *
 * 2. Redistributions in binary form must reproduce the above copyright      *
 *    notice, this list of conditions and the following disclaimer in the    *
 *    documentation and/or other materials provided with the distribution.   *
 *                                                                           *
 * 3. Neither the name of the copyright holder nor the names of its          *
 *    contributors may be used to endorse or promote products derived from   *
 *    this software without specific prior written permission.               *
 *                                                                           *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS       *
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A           *
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,  *
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,       *
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR        *
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    *
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING      *
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS        *
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.              *
*                                                                            *
\*===========================================================================*/
 
#pragma once
 
#include <QObject>
#include <QMenuBar>
#include <QGroupBox>
#include <QCheckBox>
 
#include <OpenFlipper/BasePlugin/BaseInterface.hh>
#include <OpenFlipper/BasePlugin/LoggingInterface.hh>
#include <OpenFlipper/BasePlugin/PickingInterface.hh>
#include <OpenFlipper/BasePlugin/PythonInterface.hh>
#include <OpenFlipper/BasePlugin/ToolbarInterface.hh>
#include <OpenFlipper/BasePlugin/ContextMenuInterface.hh>
#include <OpenFlipper/common/Types.hh>
#include <ObjectTypes/PolyMesh/PolyMesh.hh>
#include <ObjectTypes/TriangleMesh/TriangleMesh.hh>
#include "shaderWidget.hh"
 
struct ShaderInfo {
      QString name;
      QString description;
      QString details;
      QString version;
      QString example;
 
      QString directory;
 
      QString vertexShader;
      QString fragmentShader;
 
      QString pickVertexShader;
      QString pickFragmentShader;
 
      bool        hasUniforms;
      QStringList uniforms;
      QStringList uniformTypes;
      QStringList uniformsDefault;
      QStringList uniformsMax;
      QStringList uniformsMin;
};
 
class ViewControlPlugin : public QObject, BaseInterface , PickingInterface, LoggingInterface, ToolbarInterface, ContextMenuInterface, PythonInterface
{
  Q_OBJECT
  Q_INTERFACES(BaseInterface)
  Q_INTERFACES(PickingInterface)
  Q_INTERFACES(LoggingInterface)
  Q_INTERFACES(ToolbarInterface)
  Q_INTERFACES(ContextMenuInterface)
  Q_INTERFACES(PythonInterface)
 
  Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-ViewControl")
 
  signals:
    //BaseInterface
    void updateView();
 
    //PickingInterface
    void addHiddenPickMode( const std::string& _mode );
    
    //LoggingInterface
    void log(Logtype _type, QString _message);
    void log(QString _message);
    
    //ToolbarInterface
    void addToolbar(QToolBar* _toolbar);
    void getToolBar(QString _name, QToolBar*& _toolbar);
 
    // ContextMenuInterface
    void addContextMenuItem(QAction* _action , ContextMenuType _type);
    void addContextMenuItem(QAction* _action , DataType _objectType , ContextMenuType _type );
    void hideContextMenu();
 
    void setSlotDescription(QString     _slotName,   QString     _slotDescription,
                            QStringList _parameters, QStringList _descriptions);
 
  private slots:
 
    void pluginsInitialized();
 
    void contextMenuTriggered(QAction* _action);
 
    void slotUpdateContextMenu( int _objectId );
 
  public :
 
    ViewControlPlugin();
    ~ViewControlPlugin() {};
 
 
    QString name() { return (QString("ViewControl")); };
    QString description( ) { return (QString("Control the current or global visualization settings")); };
 
 
  private:
    QMenu* viewControlMenu_;
 
    int lastObjectId_;
 
    ACG::SceneGraph::DrawModes::DrawMode activeDrawModes_;
 
    ACG::SceneGraph::DrawModes::DrawMode availDrawModes_;
 
    ShaderWidget* shaderWidget_;
 
    std::vector <ShaderInfo> shaderList_;
    
    QToolBar*     toolbar_;
    QActionGroup* toolbarViewingDirections_;
    QAction*      viewTop_;
    QAction*      viewBottom_;
    QAction*      viewLeft_;
    QAction*      viewRight_;
    QAction*      viewFront_;
    QAction*      viewBack_;
 
    std::map<QCheckBox*, ACG::SceneGraph::DrawModes::DrawMode> activeCheckboxes;
 
  private slots:
    QString version() { return QString("1.0"); };
 
    // This slot is called when a custom draw mode is selected from the context menu
    void slotDrawModeSelected( QAction * _action );
 
    // This slot is called when the user clicks on an item in the shaderWidget
    void slotShaderClicked( QListWidgetItem * _item );
 
    // This slot is called when the user doubleclicks on an item in the shaderWidget
    void slotShaderDoubleClicked( QListWidgetItem * _item );
 
    // slot for setting a shader from the widget
    void slotSetShader();
 
    // slot is called when the data of the uniforms-table changes
    void itemChanged(QTableWidgetItem* item);
    
    // Set the view to one of the six possible look-at directions
    void setView(int _mode, int _viewer = PluginFunctions::ACTIVE_VIEWER );
    
    // Set the view mode using the defined actions
    void setView(QAction* _action);
 
  private:
    // Update the list of available shaders
    void updateShaderList();
 
    // initialize the shader Widget
    void initShaderWidget();
 
    // Announce local slots
    void setDescriptions();
 
    bool areasVisible( StatusBits _bits, int _id );
 
    void showAreas(  StatusBits _bits, int _id , bool _state  );
 
 
  public slots:
    bool selectionVisible( int _id );
 
    void showSelection( int _id , bool _state );
 
    bool modelingAreasVisible( int _id );
 
    void showModelingAreas( int _id , bool _state  );
 
    void setSelectionLineWidth( int _id , double _width );
 
    void setFeatureLineWidth( int _id , double _width );
 
    void disableShader(int _objectId, ACG::SceneGraph::DrawModes::DrawMode _drawMode, ShaderInfo* _shader=0);
    
    void setShader(int _id, ACG::SceneGraph::DrawModes::DrawMode _drawMode, ShaderInfo _shader);
 
    void setShader(int _id, QString _drawMode, QString _name );
 
    QStringList getUniforms(QString _shader);
 
    QString getUniformType(QString _shader, QString _uniform );
    QString getUniformDefault(QString _shader, QString _uniform );
    QString getUniformMin(QString _shader, QString _uniform );
    QString getUniformMax(QString _shader, QString _uniform );
 
    void setUniform(int _objID, ACG::SceneGraph::DrawModes::DrawMode _drawMode, QString _shader, QString _uniform, QString _value );
 
 
    void setViewingDirection( Vector _direction, Vector _upvector , int _viewer = PluginFunctions::ALL_VIEWERS );
 
    void setSceneRadius( double _radius , int _viewer = PluginFunctions::ALL_VIEWERS );
 
    void rotate( Vector _axis, double _angle, Vector _center , int _viewer = PluginFunctions::ALL_VIEWERS );
 
    void translate( Vector _vec , int _viewer = PluginFunctions::ALL_VIEWERS );
    
    void setDrawMode(QString _mode, int _viewer = PluginFunctions::ALL_VIEWERS );
    
    void setObjectDrawMode(QString _mode, int _objectID , bool _force = true );
 
    Vector viewingDirection( int _viewer = PluginFunctions::ACTIVE_VIEWER );
 
    Vector upVector( int _viewer = PluginFunctions::ACTIVE_VIEWER );
 
    Vector eyePosition( int _viewer = PluginFunctions::ACTIVE_VIEWER );
 
    Vector sceneCenter( int _viewer = PluginFunctions::ACTIVE_VIEWER );
 
    void setSceneCenter( Vector _center, int _viewer = PluginFunctions::ALL_VIEWERS );
 
    void enableBackfaceCulling( bool _state , int _viewer = PluginFunctions::ALL_VIEWERS );
 
 
    void setEyePosition(Vector _eye);
 
    void viewAll();
 
    void viewAll(int _viewer);
 
    void viewHome();
 
    void viewHome(int _viewer);
 
 
 
    void orthographicProjection();
 
    void orthographicProjection(int _viewer);
 
 
 
    void perspectiveProjection();
 
    void perspectiveProjection(int _viewer);
    
    void setFOVY( double _fovy );
    
    void setCoordsysProjection(bool _orthogonal);
 
    void setTwoSidedLighting(bool _enabled);
 
    ACG::Vec3d project(ACG::Vec3d _point, int _viewerId = 0);
 
};