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

//=============================================================================
//
// CLASS PolyLinePlugin
//
// Author:  David Bommes <bommes@cs.rwth-aachen.de>
//
// Version: $Revision: 1$
// Date:    $Author$
//   $Date: 03-10-2007$
//
//
//=============================================================================

#ifndef POLYLINEPLUGIN_HH
#define POLYLINEPLUGIN_HH

#define CGAL_NO_AUTOLINK_MPFR
#define CGAL_NO_AUTOLINK_GMP

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

#include <QObject>
#include <QMenuBar>
#include <QTimer>

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

#include "PolyLineToolbarWidget.hh"

#include <ObjectTypes/Plane/QtPlaneSelect.hh>

#include <ACG/Scenegraph/GlutPrimitiveNode.hh>

#include <ObjectTypes/PolyLine/PolyLineCircleData.hh>
#include <ObjectTypes/PolyLine/PolyLineBezierSplineData.hh>

#define CREATE_CUT_POLYLINE "Create Polyline"
#define CREATE_CUT_POLYLINES "Create Polylines"

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


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

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

signals:

  // BaseInterface
  void updateView();
  void updatedObject(int _identifier, const UpdateType& _type);
  void nodeVisibilityChanged(int _id);

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

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

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

  // ScriptInterface
  void scriptInfo( QString _functionName );

  // ToolboxInterface
  void addToolbox( QString  _name  , QWidget* _widget, QIcon* _icon);

  void deleteObject( int _id );
  void addEmptyObject( DataType _type, int& _id);

  void registerKey(int _key, Qt::KeyboardModifiers _modifiers, QString _description, bool _multiUse = false);
  void showStatusMessage(QString _message, int _timeout = 0);
  void clearStatusMessage();

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

private slots :
  // BaseInterface
  void initializePlugin();

  void slotEditModeChanged();

  void slotMouseEvent( QMouseEvent* _event );
  void slotKeyEvent(QKeyEvent* _event);

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

  void pluginsInitialized();

  bool pick_triangle_mesh( QPoint mPos,
                                                TriMeshObject*& _mesh_object_, TriMesh::FaceHandle& _fh, TriMesh::VertexHandle& _vh, ACG::Vec3d& _hitPoint);

  void slotUpdateContextMenu(int objectId);
public slots :

  void slotEnablePickMode(QString _name);

public :

  enum EditMode { PL_NONE  =0,
                  PL_INSERT=1,
                  PL_INSERTCIRCLE,
                  PL_INSERTSPLINE,
                  PL_DELETE,
                  PL_MOVE,
                  PL_SPLIT,
                  PL_MERGE,
                  PL_SMART_MOVE,
                  PL_COPY_PASTE };

  PolyLinePlugin();

  ~PolyLinePlugin() {};

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

  QString description() { return (QString("Handling of PolyLines (Insertion/Deletion/Modeling/...")); };

public slots:

#ifdef EXTENDED_POLY_LINE
    void slot_resample_on_edges();
#endif

private slots:

  void slot_subdivide();
  void slot_subdivide_percent(bool _checked);
  void slot_decimate();
  void slot_decimate_percent(bool _checked);

  void slot_smooth();
  void slot_smooth( PolyLineObject*& _pol);
  void slot_project();
  void slot_project( PolyLineObject*& _pol);
  void slot_smooth_project();
  void slot_smooth_project( PolyLineObject*& _pol);

  void slot_smart_move_timer();

  void slot_setCirclePointNum(int i);
  void slot_setSplinePointNum(int i);

  virtual void slotObjectUpdated( int _identifier, const UpdateType &_type );

  void slot_duplicate();
  void slot_instanciate();
  void finishSpline();
private :

  EditMode mode();

  // mouse events
  void me_insert      ( QMouseEvent* _event );
  void me_insertCircle( QMouseEvent* _event );
  void me_insertSpline( QMouseEvent* _event );
  void me_delete      ( QMouseEvent* _event );
  void me_move        ( QMouseEvent* _event );
  void me_split       ( QMouseEvent* _event );
  void me_merge       ( QMouseEvent* _event );
  void me_smart_move  ( QMouseEvent* _event );

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

  private :

    PolyLineToolbarWidget* tool_;

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

  private :
    QAction*      polyLineAction_;
    QActionGroup* toolBarActions_;

    QToolBar*     toolbar_;

  private slots:

    void slotSetPolyLineMode(QAction* _action);

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

  private :
    QToolBar*     pickToolbar_;
    QActionGroup* pickToolBarActions_;

    QAction*      insertAction_;
    QAction*      insertCircleAction_;
    QAction*      insertSplineAction_;
    QAction*      deleteAction_;
    QAction*      moveAction_;
    QAction*      smartMoveAction_;
    QAction*      mergeAction_;
    QAction*      splitAction_;
    QAction*      cutAction_;
    QAction*      cutMultipleAction_;

  private slots:

    void slotPickToolbarAction(QAction* _action);

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

  private:

  template< class MeshT > std::vector< ACG::Vec3d >
  getIntersectionPoints ( MeshT* _mesh, uint _fh, ACG::Vec3d _planeNormal ,
                          ACG::Vec3d _planePoint, bool& _closed );

  template< class MeshT > std::vector< std::vector< ACG::Vec3d > >
  getMultipleIntersectionPoints( MeshT* _mesh, ACG::Vec3d _planeNormal , ACG::Vec3d _planePoint );

  template< class MeshT >
  typename MeshT::EdgeHandle
  getCuttedEdge(MeshT& _mesh, ACG::Vec3d& _planeNormal, ACG::Vec3d& _planePoint);

public slots:

  QString version() { return QString("1.02"); };

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

  int generatePolyLineFromCut( int _objectId, Vector _planePoint, Vector _planeNormal, int _polyLineId = -1 );

  IdList generatePolyLinesFromCut( int _objectId, Vector _planePoint, Vector _planeNormal );

private slots:

  void slotScissorButton();

  void slotScissorLinesButton();

  void slotTriggerCutPlaneSelect();

private:
    int               cur_insert_id_;
    PolyLineObject   *cur_polyline_obj_;

    int               cur_move_id_;
    PolyLine::Point*  move_point_ref_;
    PolyLine::Point*  create_point_ref_;
    PolyLine::Point   move_point_orig_;

    int                             createCircle_CurrSelIndex_;
    int                                 createCircle_LastSelIndex_;
    ACG::SceneGraph::GlutPrimitiveNode* moveCircle_SelNode_;
    ACG::Vec3d          moveCircle_LastHitPos_;
    ACG::Vec3d          moveCircle_LastHitNor_;
    bool                moveCircle_IsLocked;
    bool                moveCircle_IsFloating;

    QAction*            copyPaste_Action_;
    int                 copyPaste_ObjectId_;
    int                 copyPaste_ActionType_;
    int                 copyPaste_NewObjectId_;
    std::vector<ACG::Vec3d> copyPaste_RelativePoints_;
    QPoint              copyPaste_LastMouse;

    /*
     * \brief Handles the mouse event during a copy paste event
     *
     * Determines wether duplicate or instanciate is happening and performs the
     * action, ending the mode.
     */
    void me_copyPasteMouse(QMouseEvent* _event);

        bool createCircle_getPointOnMesh(TriMeshObject* _triMeshObject,
                                                                         ACG::Vec3d     _center,
                                                                         ACG::Vec3d     _pOnPlane,
                                                                         ACG::Vec3d     _n,
                                                                         ACG::Vec3d*    _pOut);

        bool createCircle_getHitInfo(PolyLineCircleData* _circleData,
                                                                 ACG::Vec3d          _hit_Point,
                                                                 ACG::Vec3d*         _pOut = 0,
                                                                 double*             _r = 0,
                                                                 ACG::Vec3d*         _onPlane = 0);

        ACG::Vec3d createCircle_getHit(PolyLineCircleData* _circleData, ACG::Vec3d _hit_point);

public slots:
        /* \brief Creates the UI elements for the poly line(asserting it has circle data)
         *
         */
        void createCircle_createUI(int _polyLineObjectID);

        /* \brief Creates the UI elements for the poly line(asserting it has spline data)
         *
         */
        void createSpline_createUI(int _polyLineObjectID);

private:
        void updatePolyEllipse(PolyLineObject* _lineObject, unsigned int _pointCount);

        void updateHandles(PolyLineObject* _lineObject);

        void updatePolyBezierSpline(PolyLineObject* _lineObject, unsigned int _pointsPerSegment);

        void updatePolyBezierHandles(PolyLineObject* _lineObject, ACG::SceneGraph::LineNode* _line);

        ACG::Vec3d getPointOnMesh(PolyLineBezierSplineData* _SplineData, ACG::Vec3d _point, ACG::Vec3d* _nor = 0);

        int createSpline_CurrSelIndex_;
        int createSpline_LastSelIndex_;

        ACG::SceneGraph::GlutPrimitiveNode* moveBezSpline_SelNode_;
        int moveBezSpline_SelIndex_;
        int moveBezSpline_SelSubIndex_;

        int               cur_merge_id_;

        QTimer*           smart_move_timer_;

        PolyLineObject*   cur_smart_move_obj_;

        QtPlaneSelect*    planeSelect_;

};

#if defined(INCLUDE_TEMPLATES) && !defined(POLYLINEPLUGIN_CC)
#define POLYLINEPLUGIN_TEMPLATES
#include "PolyLinePluginT.cc"
#endif

#endif //MOVEPLUGIN_HH