MovePlugin.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.              *
*                                                                            *
\*===========================================================================*/

/*===========================================================================*\
*                                                                            *
*   $Revision$                                                       *
*   $LastChangedBy$                                                *
*   $Date$                     *
*                                                                            *
\*===========================================================================*/

#ifndef MOVEPLUGIN_HH
#define MOVEPLUGIN_HH

#include <QObject>
#include <QMenuBar>

#include <OpenFlipper/BasePlugin/BaseInterface.hh>
#include <OpenFlipper/BasePlugin/MouseInterface.hh>
#include <OpenFlipper/BasePlugin/KeyInterface.hh>
#include <OpenFlipper/BasePlugin/PickingInterface.hh>
#include <OpenFlipper/BasePlugin/ToolboxInterface.hh>
#include <OpenFlipper/BasePlugin/BackupInterface.hh>
#include <OpenFlipper/BasePlugin/LoggingInterface.hh>
#include <OpenFlipper/BasePlugin/ScriptInterface.hh>
#include <OpenFlipper/BasePlugin/ToolbarInterface.hh>
#include <OpenFlipper/BasePlugin/ContextMenuInterface.hh>
#include <OpenFlipper/BasePlugin/LoadSaveInterface.hh>
#include <OpenFlipper/BasePlugin/RPCInterface.hh>
#include <OpenFlipper/common/Types.hh>
#include <ObjectTypes/PolyMesh/PolyMesh.hh>
#include <ObjectTypes/Plane/Plane.hh>
#include <ObjectTypes/TriangleMesh/TriangleMesh.hh>

#ifdef ENABLE_SKELETON_SUPPORT
  #include <ObjectTypes/Skeleton/Skeleton.hh>
#endif

#ifdef ENABLE_OPENVOLUMEMESH_SUPPORT
#include <OpenVolumeMesh/Attribs/NormalAttrib.hh>
#endif

#include "MoveToolbar.hh"
#include "MoveProps.hh"
#include "MoveObjectMarker.hh"

class MovePlugin : public QObject, BaseInterface, MouseInterface, KeyInterface, PickingInterface, ToolboxInterface, BackupInterface, LoggingInterface, ScriptInterface,ToolbarInterface, ContextMenuInterface, LoadSaveInterface, RPCInterface
{
  Q_OBJECT
  Q_INTERFACES(BaseInterface)
  Q_INTERFACES(MouseInterface)
  Q_INTERFACES(KeyInterface)
  Q_INTERFACES(PickingInterface)
  Q_INTERFACES(ToolboxInterface)
  Q_INTERFACES(BackupInterface)
  Q_INTERFACES(LoggingInterface)
  Q_INTERFACES(ContextMenuInterface)
  Q_INTERFACES(ScriptInterface)
  Q_INTERFACES(ToolbarInterface)
  Q_INTERFACES(LoadSaveInterface)
  Q_INTERFACES(RPCInterface)

#if QT_VERSION >= 0x050000
  Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-Move")
#endif

public:
  typedef unsigned int SelectionType;
  static const SelectionType VERTEX = 1;
  static const SelectionType EDGE   = 2;
  static const SelectionType FACE   = 4;
  static const SelectionType CELL   = 8;

  signals:
    // BaseInterface
    void updateView();
    void updatedObject(int, const UpdateType& _type);
    void nodeVisibilityChanged(int);

    // PickingInterface
    void addPickMode( const std::string& _mode );
    void addHiddenPickMode( const std::string& _mode );
    void setPickModeMouseTracking (const std::string& _mode, bool _mouseTracking);
    void setPickModeToolbar (const std::string& _mode, QToolBar * _toolbar);

    // ContextMenuInterface
    void addContextMenuItem(QAction* _action , ContextMenuType _type);

    // BackupInterface
    void createBackup( int _objectid, QString _name, UpdateType _type = UPDATE_ALL);

    // LoggingInterface
    void log(Logtype _type, QString _message);
    void log(QString _message);

    // ScriptInterface
    void scriptInfo( QString _functionName  );
    void setSlotDescription(QString     _slotName,   QString     _slotDescription,
                            QStringList _parameters, QStringList _descriptions);

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

    // KeyInterface
    void registerKey(int _key, Qt::KeyboardModifiers _modifiers, QString _description, bool _multiUse = false);
    
    // ToolboxInterface
    void addToolbox( QString _name  , QWidget* _widget, QIcon* _icon );
    
    // RPCInterface
    void pluginExists(QString _pluginName, bool &_exists);
    void functionExists(QString _pluginName, QString _functionName, bool &_exists);

  private slots :

    // BaseInterface
    void initializePlugin();
    void pluginsInitialized();
    
    void slotAllCleared();
    
    // LoadSaveInterface
    void objectDeleted( int _id );

    // MouseInterface
    void slotMouseWheelEvent(QWheelEvent * _event, const std::string & _mode);
    void slotMouseEvent( QMouseEvent* _event );

    // KeyInterface
    void slotKeyEvent (QKeyEvent* _event);
    void slotKeyReleaseEvent (QKeyEvent* _event);

    // PickingInterface
    void slotPickModeChanged( const std::string& _mode);

    // BackupInterface
    void slotBackupRequested( int /*_id*/ , QString /*_name*/ , int /*_backup_id*/){};
    void slotRestoreRequested( int /*_id*/ , QString /*_name*/ , int /*_backup_id*/){};

  public :

    MovePlugin();

    ~MovePlugin();

    QString name(){ return (QString("Move")); };

    QString description() { return (QString(tr("Moves Meshes with Manipulators"))); };

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

  private:
    int axisA_;
    int axisB_;

    enum Unificationtype
    {
      DIAGONAL,
      LONGEST_AXIS,
      ALL_AXIS
    };

  private slots:

    void slotSetPosition();

    void slotToggleAxisA();

    void slotToggleAxisB();

    void slotSetDirection();

    void slotTranslation();

    void slotProjectToTangentPlane();

    void slotMoveManipToCOG();

    void slotRotate();

    void slotScale();

    void slotEnableSelectionMode();

    void slotEnableObjectMode();

  private:

    void updateManipulatorDialog();

    template <typename MeshType>
    OpenMesh::Vec3d getNearestVertex(MeshType* _mesh, uint _fh, OpenMesh::Vec3d& _hitPoint);

    template <typename MeshType>
    OpenMesh::Vec3d getNearestEdge(MeshType* _mesh, uint _fh, OpenMesh::Vec3d& _hitPoint);

    template <typename MeshType>
    OpenMesh::Vec3d getNearestFace(MeshType* _mesh, uint _fh, OpenMesh::Vec3d& _hitPoint);

    bool toolboxActive_;

    moveToolbarWidget* tool_;
    
    QIcon* toolIcon_;

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

  private :
    QAction* moveAction_;
    QAction* moveSelectionAction_;
    
    QActionGroup* toolBarActions_;
    
    QToolBar* toolbar_;

  private slots:

    void slotSetMoveMode(QAction* _action);

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

  private :
    QToolBar* pickToolbar_;

    QAction* placeAction_;
    QAction* rotateTranslateAction_;
    QAction* rotateManipAction_;
    QAction* resizeAction_;

    QAction* biggerManipAction_;
    QAction* smallerManipAction_;

    QAction* fixChildManipAction_;
    QAction* transformRefPoseManipAction_;
    QAction* currentPoseManipAction_;
    
    QAction* placeAndSnapAction_;

    QActionGroup* pickToolBarActions_;

  private slots:

    void slotPickToolbarAction(QAction* _action);

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

  private:
    //object ids of all objects with active Manipulator
    std::vector< int > activeManipulators_;

  private slots:

    void manipulatorMoved( QtTranslationManipulatorNode* _node , QMouseEvent* _event);

    void ManipulatorPositionChanged(QtTranslationManipulatorNode* _node );

  private:

    void unifyBoundingBox(Unificationtype u);

    template< typename MeshT >
    void transformMesh(ACG::Matrix4x4d _mat , MeshT& _mesh );

    #ifdef ENABLE_POLYLINE_SUPPORT
    template< class PolyLineT >
    void transformPolyLine( ACG::Matrix4x4d _mat , PolyLineT& _polyLine );
    #endif

    #ifdef ENABLE_SKELETON_SUPPORT
    void transformSkeleton( ACG::Matrix4x4d _mat , Skeleton& _skeleton );
    #endif

    #ifdef ENABLE_OPENVOLUMEMESH_SUPPORT
    template< typename VolumeMeshT >
    void transformVolumeMesh(ACG::Matrix4x4d _mat , VolumeMeshT& _mesh , OpenVolumeMesh::NormalAttrib<VolumeMeshT>& _normalAttrib );

    template< typename VolumeMeshT >
    ACG::Vec3d cogVolumeMesh( VolumeMeshT& _mesh );

    template< typename VolumeMeshT >
    void getBBVolumeMesh( VolumeMeshT& _mesh, ACG::Vec3d& _bb_min, ACG::Vec3d& _bb_max  );

    template< typename VolumeMeshT >
    void unifyBBVolumeMesh(VolumeMeshT& _mesh, OpenVolumeMesh::NormalAttrib<VolumeMeshT>& _normalAttrib, Unificationtype u = MovePlugin::DIAGONAL);

    template< typename VolumeMeshT >
    void unifyBBVolumeMesh( VolumeMeshT& _mesh, OpenVolumeMesh::NormalAttrib<VolumeMeshT>& _normalAttrib, ACG::Vec3d& _bb_min, ACG::Vec3d& _bb_max, Unificationtype u = MovePlugin::DIAGONAL  );
    #endif

    ACG::Matrix4x4d getLastManipulatorMatrix(bool _reset = true);

    void showManipulators( );

    void placeManip(QMouseEvent * _event, bool _snap = false);

    template< typename MeshT >
    void unifyBB(MeshT& _mesh , Unificationtype u = MovePlugin::DIAGONAL);

    template< typename MeshT >
    void getBB( MeshT& _mesh, ACG::Vec3d& _bb_min, ACG::Vec3d& _bb_max  );

    template< typename MeshT >
    void unifyBB( MeshT& _mesh, ACG::Vec3d& _bb_min, ACG::Vec3d& _bb_max, Unificationtype u = MovePlugin::DIAGONAL  );

    double manip_size_;

    double manip_size_modifier_;

    int lastActiveManipulator_;

    void setDescriptions();

    void moveObject(ACG::Matrix4x4d mat, int _id);

    void moveSelection(ACG::Matrix4x4d mat, int _id, QEvent::Type _type);

    MoveObjectMarker objectMarker_;

  private:

    QtTranslationManipulatorNode::ManipulatorMode manMode_;

    void setManipMode (QtTranslationManipulatorNode::ManipulatorMode _mode);

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

    SelectionType selectionType_;

    void updateSelectionType();

  private slots:

    void setAllTargets(bool _state);

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

    private slots:

    void showProps( );
    
    void hideManipulator();

    movePropsWidget* getDialogWidget(BaseObjectData* _obj);

    movePropsWidget* getDialogFromButton(QPushButton* _but);

    void slotUpdateContextMenuNode( int _nodeId );

    private:

    void setPickModeProps(movePropsWidget* _pW, const std::string &_pickmode);

    QList<movePropsWidget*> propsWindows_;

    QAction* contextAction_;
    
    QAction* contextActionHide_;

    QAction* toAllTargets_;

    QMenu* contextMenuManipControl_;

    QAction* contextMenuManipControlsAction_;

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

public slots :

  void slotMoveToOrigin();

  void slotUnifyBoundingBoxDiagonal();

  void slotUnifyBoundingBoxLongestAxis();

  void slotUnifyBoundingBoxAllAxis();

  void translate( int _objectId , Vector _vector );

  void translate( int _objectId , IdList _vHandles, Vector _vector );

  void translateVertexSelection( int _objectId , Vector _vector );

  void translateFaceSelection( int _objectId , Vector _vector );

  void translateEdgeSelection( int _objectId , Vector _vector );

  void transform( int _objectId , Matrix4x4 _matrix );

  void transform( int _objectId , IdList _vHandles, Matrix4x4 _matrix );

  bool transformVertexSelection( int _objectId , Matrix4x4 _matrix );

  bool transformFaceSelection( int _objectId , Matrix4x4 _matrix );

  bool transformEdgeSelection( int _objectId , Matrix4x4 _matrix );

  bool transformCellSelection( int _objectId , Matrix4x4 _matrix );

  void transformHandleRegion(int _objectId, Matrix4x4 _matrix);

  void setManipulatorPosition( int _objectId , Vector _position );

  Vector manipulatorPosition( int _objectId );

  void setManipulatorDirection( int _objectId , Vector _directionX, Vector _directionY );

  Vector manipulatorDirectionX( int _objectId );

  Vector manipulatorDirectionY( int _objectId );

  Vector manipulatorDirectionZ( int _objectId );

  void objectRenderingMatrixIdentity(int _objectId);

  void objectRenderingMatrixScale(int _objectId, double _s);

  void objectRenderingMatrixTranslate(int _objectId, Vector _translation);

  void objectRenderingMatrixRotate(int _objectId, Vector _axis, double _angle);

  Matrix4x4 getObjectRenderingMatrix(int _objectId);

  public slots:
    QString version() { return QString("1.2"); };

  private:
    bool hide_;

    bool allTargets_;

    bool placeMode_;

    bool transformedSelected_;
};

#endif //MOVEPLUGIN_HH