MeshObjectSelectionPlugin.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 <OpenFlipper/BasePlugin/BaseInterface.hh>
#include <OpenFlipper/BasePlugin/KeyInterface.hh>
#include <OpenFlipper/BasePlugin/MouseInterface.hh>
#include <OpenFlipper/BasePlugin/LoggingInterface.hh>
#include <OpenFlipper/BasePlugin/ToolboxInterface.hh>
#include <OpenFlipper/BasePlugin/ToolbarInterface.hh>
#include <OpenFlipper/BasePlugin/LoadSaveInterface.hh>
#include <OpenFlipper/BasePlugin/BackupInterface.hh>
#include <OpenFlipper/BasePlugin/INIInterface.hh>
#include <OpenFlipper/BasePlugin/ScriptInterface.hh>
#include <OpenFlipper/BasePlugin/SelectionInterface.hh>
#include <OpenFlipper/BasePlugin/OptionsInterface.hh>
#include <OpenFlipper/BasePlugin/PythonInterface.hh>

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

#include <ObjectTypes/PolyMesh/PolyMesh.hh>
#include <ObjectTypes/TriangleMesh/TriangleMesh.hh>

#include <ACG/QtWidgets/QtColorChooserButton.hh>

#include "widgets/ConversionDialog.hh"

class ParameterWidget;

class MeshObjectSelectionPlugin : public QObject, BaseInterface, KeyInterface, LoadSaveInterface,
            INIInterface, BackupInterface, ScriptInterface, LoggingInterface, SelectionInterface,
            MouseInterface, OptionsInterface, PythonInterface
{
    Q_OBJECT
    Q_INTERFACES(BaseInterface)
    Q_INTERFACES(KeyInterface)
    Q_INTERFACES(MouseInterface)
    Q_INTERFACES(INIInterface)
    Q_INTERFACES(BackupInterface)
    Q_INTERFACES(ScriptInterface)
    Q_INTERFACES(LoggingInterface)
    Q_INTERFACES(LoadSaveInterface)
    Q_INTERFACES(SelectionInterface)
    Q_INTERFACES(OptionsInterface)
    Q_INTERFACES(PythonInterface)

  Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-SelectionMeshObject")

public:
    MeshObjectSelectionPlugin();

    ~MeshObjectSelectionPlugin();
    
    friend class SelectVolumeAction;

signals:

    // BaseInterface
    void updateView();
    void updatedObject(int, const UpdateType&);
    void nodeVisibilityChanged(int _identifier);
    void setSlotDescription(QString     _slotName,   QString     _slotDescription,
                            QStringList _parameters, QStringList _descriptions);

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

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

    // SelectionInterface
    void addSelectionEnvironment(QString _modeName, QString _description, QString _icon, QString& _handleName);
    void registerType(QString _handleName, DataType _type);
    void addPrimitiveType(QString _handleName, QString _name, QString _icon, SelectionInterface::PrimitiveType& _typeHandle);
    void addSelectionOperations(QString _handleName, QStringList _operationsList, QString _category, SelectionInterface::PrimitiveType _type = 0u);
    void addSelectionParameters(QString _handleName, QWidget* _widget, QString _category, SelectionInterface::PrimitiveType _type = 0u);
    
    void showToggleSelectionMode(QString _handleName, bool _show, SelectionInterface::PrimitiveType _associatedTypes);

    void showLassoSelectionMode(QString _handleName, bool _show, SelectionInterface::PrimitiveType _associatedTypes);
    void showVolumeLassoSelectionMode(QString _handleName, bool _show, SelectionInterface::PrimitiveType _associatedTypes);
    void showSphereSelectionMode(QString _handleName, bool _show, SelectionInterface::PrimitiveType _associatedTypes);
    void showClosestBoundarySelectionMode(QString _handleName, bool _show, SelectionInterface::PrimitiveType _associatedTypes);
    void showFloodFillSelectionMode(QString _handleName, bool _show, SelectionInterface::PrimitiveType _associatedTypes);
    void showComponentsSelectionMode(QString _handleName, bool _show, SelectionInterface::PrimitiveType _associatedTypes);
    
    void getActiveDataTypes(SelectionInterface::TypeList& _types);
    void getActivePrimitiveType(SelectionInterface::PrimitiveType& _type);
    void targetObjectsOnly(bool& _targetsOnly);
    
    void registerKeyShortcut(int _key, Qt::KeyboardModifiers _modifiers = Qt::NoModifier);
    
    // LoadSaveInterface
    void deleteObject(int _objectId);
    void addEmptyObject( DataType _type, int& _id);
    
    // ScriptInterface
    void scriptInfo(QString _functionName);

public slots:

    // SelectionInterface
    void loadSelection(int _objId, const QString& _filename);

private slots:

    // INIInterface
    void loadIniFile(INIFile& _ini, int _id);
    void saveIniFile(INIFile& _ini, int _id);

    // BaseInterface
    void initializePlugin();
    void pluginsInitialized();
    void noguiSupported() {};

    // SelectionInterface
    void slotSelectionOperation(QString _operation);
    void slotToggleSelection(QMouseEvent* _event, SelectionInterface::PrimitiveType _currentType, bool _deselect);

    void slotLassoSelection(QMouseEvent* _event, SelectionInterface::PrimitiveType _currentType, bool _deselect);
    void slotVolumeLassoSelection(QMouseEvent* _event, SelectionInterface::PrimitiveType _currentType, bool _deselect);
    void slotSphereSelection(QMouseEvent* _event, double _radius, SelectionInterface::PrimitiveType _currentType, bool _deselect);
    void slotClosestBoundarySelection(QMouseEvent* _event, SelectionInterface::PrimitiveType _currentType, bool _deselect);
    void slotFloodFillSelection(QMouseEvent* _event, SelectionInterface::PrimitiveType _currentType, bool _deselect);
    void slotComponentsSelection(QMouseEvent* _event, SelectionInterface::PrimitiveType _currentType, bool _deselect);
    void slotIndexSelection(int _key);

    void slotLoadSelection(const INIFile& _file);
    void slotSaveSelection(INIFile& _file);
    
    void slotKeyShortcutEvent(int _key, Qt::KeyboardModifiers _modifiers);

    // MouseInterface
    void slotMouseWheelEvent(QWheelEvent* event, std::string const& mode);

    // LoadSaveInterface
    void addedEmptyObject( int _id );

public:

    // OptionsInterface
    bool initializeOptionsWidget(QWidget*& _widget);

private slots:
    void applyOptions();

    // BaseInterface
    QString name() {
        return (QString(tr("MeshObjectSelection")));
    };
    
    QString description() {
        return (QString(tr("Allows to select parts of Mesh Objects")));
    };

    //===========================================================================
    //===========================================================================
private:
    
    // update and saves new color values for area node/selecion noe etc.
    void updateColorValues();

    void updateSlotDescriptions();
    
    void setColorForSelection(const int _objectId, const PrimitiveType _primitiveType);
    
    //===========================================================================
    //===========================================================================
private slots:
    
    void conversionRequested();

    void setDefaultColorValues();

public slots:

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

    // Is vertex type active? (for use in plugins that need mesh selection)
    bool vertexTypeActive() {
        SelectionInterface::PrimitiveType t = 0u;
        emit getActivePrimitiveType(t);
        return (t & vertexType_) > 0;
    }

    // Is vertex type active? (for use in plugins that need mesh selection)
    bool edgeTypeActive() {
        SelectionInterface::PrimitiveType t = 0u;
        emit getActivePrimitiveType(t);
        return (t & edgeType_) > 0;
    }

    // Is face type active? (for use in plugins that need mesh selection)
    bool faceTypeActive() {
        SelectionInterface::PrimitiveType t = 0u;
        emit getActivePrimitiveType(t);
        return (t & faceType_) > 0;
    }

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

    //==========================================
    // VERTEX OPERATIONS
    //==========================================

    void selectVertices(int objectId, IdList _vertexList);

    bool selectVertex(int _objectId, int _idx, bool _fly_to_vertex);

    void unselectVertices(int objectId, IdList _vertexList);

    void selectAllVertices(int _objectId);

    void clearVertexSelection(int _objectId);

    void invertVertexSelection(int _objectId);

    void selectBoundaryVertices(int _objectId);

    void selectClosestBoundaryVertices(int _objectId, int _vertexId);

    void shrinkVertexSelection(int _objectId);

    void growVertexSelection(int _objectId);

    IdList getVertexSelection(int _objectId);

    void deleteVertexSelection(int _objectId);

    int createMeshFromVertexSelection( int _objectId);

    void colorizeVertexSelection(int _objectId, int _r, int _g, int _b, int a);

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

    void selectHandleVertices(int objectId, IdList _vertexList);

    void unselectHandleVertices(int objectId, IdList _vertexList);

    void clearHandleVertices(int objectId);

    void setAllHandleVertices(int objectId);

    IdList getHandleVertices(int objectId);

    void loadFlipperModelingSelection(int _objectId, QString _filename);

    void saveFlipperModelingSelection(int _objectId, QString _filename);

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

    void selectModelingVertices(int objectId, IdList _vertexList);

    void unselectModelingVertices(int objectId, IdList _vertexList);

    void selectVerticesByValue(int _objectId, QString _component, bool _greater, double _value );

    void clearModelingVertices(int objectId);

    void setAllModelingVertices(int objectId);

    IdList getModelingVertices(int objectId);

    //==========================================
    // EDGE OPERATIONS
    //==========================================

    void selectEdges(int objectId, IdList _edgeList, const double _dihedral_angle_threshold = 0.0);

    bool selectEdge(int _objectId, int _idx, bool _fly_to_edge);

    void unselectEdges(int objectId, IdList _edgeList);

    void selectAllEdges(int objectId);

    void invertEdgeSelection(int objectId);

    void clearEdgeSelection(int objectId);

    void selectBoundaryEdges(int objectId);

    void deleteEdgeSelection(int _objectId);

    IdList getEdgeSelection(int objectId);

    IdList convertEdgesToVertexPairs(int _id, const IdList& _edges);

    IdList convertVertexPairsToEdges(int _id, const IdList& _vertices);

    int createMeshFromEdgeSelection( int _objectId);

    void colorizeEdgeSelection(int objectId, int r, int g, int b, int a);

    void traceEdgePath(int objectId, double threshold);

    //==========================================
    // HALFEDGE OPERATIONS
    //==========================================

    void selectHalfedges(int objectId, IdList _vertexList);

    bool selectHalfedge(int _objectId, int _idx, bool _fly_to_halfedge);

    void unselectHalfedges(int objectId, IdList _vertexList);

    void selectAllHalfedges(int objectId);

    void invertHalfedgeSelection(int objectId);

    void clearHalfedgeSelection(int objectId);

    void selectBoundaryHalfedges(int objectId);

    IdList getHalfedgeSelection(int objectId);

    IdList convertHalfedgesToVertexPairs(int _id, const IdList& _halfedges);

    IdList convertVertexPairsToHalfedges(int _id, const IdList& _vertices);

    void colorizeHalfedgeSelection(int objectId, int r, int g, int b, int a);

    //==========================================
    // FACE OPERATIONS
    //==========================================

    void selectFaces(int objectId, IdList _facesList);

    bool selectFace(int _objectId, int _idx, bool _fly_to_face);

    void unselectFaces(int objectId, IdList _facesList);

    void selectAllFaces(int objectId);

    void clearFaceSelection(int objectId);

    void invertFaceSelection(int objectId);

    void deleteFaceSelection(int _objectId);

    void selectBoundaryFaces(int objectId);

    void shrinkFaceSelection(int objectId);

    void growFaceSelection(int objectId);

    IdList getFaceSelection(int objectId);

    int createMeshFromFaceSelection( int _objectId);

    void colorizeFaceSelection(int objectId, int r, int g, int b, int a);
    
    //===========================================================================

    void lassoSelect(QRegion& _region, PrimitiveType _primitiveType, bool _deselection);

    void convertSelection(const int& _objectId ,const QString& _from, const QString& _to, bool _deselect);

    void conversion(const QString& _from, const QString& _to, bool _deselect);

public:
    template <typename HandleT>
    bool selectElement(int _objectId, HandleT _handle, bool _fly_to_element);

private:
    template <typename MeshObjectT, typename HandleT>
    void getFlightData(MeshObjectT& _mesh_object, HandleT _handle,
                       OpenMesh::Vec3d& center, OpenMesh::Vec3d& normal, bool& handle_valid);


public:
    void   set_dihedral_angle_threshold(const double _a);
    double get_dihedral_angle_threshold();

    void   set_max_angle(const double _a);
    double get_max_angle();

private:
    void update_dihedral_angle_threshold_from_ui();

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

private:

    template<typename MeshT>
    bool deleteSelection(MeshT* _mesh, PrimitiveType _primitiveType);

    template<typename MeshT>
    void update_regions(MeshT* _mesh);

    template<typename MeshT>
    void toggleMeshSelection(int _objectId, MeshT* _mesh, uint _fh, ACG::Vec3d& _hit_point, PrimitiveType _primitiveType);

    template<typename MeshT>
    void paintSphereSelection(MeshT* _mesh, int _objectId, int _target_idx,
            typename MeshT::Point _hitpoint, double _radius,
            PrimitiveType _primitiveTypes, bool _deselection);
    
    template<class MeshT>
    bool volumeSelection(MeshT* _mesh, int _objectId, ACG::GLState& _state,
            QRegion *_region, PrimitiveType _primitiveTypes, bool _deselection);

    template<class MeshT>
    void closestBoundarySelection(MeshT* _mesh, int _vh,
            PrimitiveType _primitiveTypes, bool _deselection);
    
    template<class MeshT>
    void floodFillSelection(MeshT* _mesh, int _objectId, uint _fh,
            double _maxAngle, PrimitiveType _primitiveTypes, bool _deselection);

    template<typename MeshT>
    void componentsMeshSelection(MeshT* _mesh, int _objectId, uint _fh,
            ACG::Vec3d& _hit_point, PrimitiveType _primitiveType);
                            
    template<class MeshT>
    void colorizeSelection(MeshT* _mesh, PrimitiveType _primitiveTypes, int _red, int _green, int _blue, int _alpha);

    template< class MeshT >
    void createMeshFromSelection( MeshT& _mesh, MeshT& _newMesh, PrimitiveType _primitiveType);

    template< class MeshT >
    void selectVerticesByValue(MeshT* _mesh, QString _component, bool _greater, double _value);

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

    int createMeshFromSelection( int _objectId , PrimitiveType _primitiveType);

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

private:

    QString environmentHandle_;

    SelectionInterface::PrimitiveType vertexType_;
    SelectionInterface::PrimitiveType edgeType_;
    SelectionInterface::PrimitiveType halfedgeType_;
    SelectionInterface::PrimitiveType faceType_;
    
    SelectionInterface::PrimitiveType allSupportedTypes_;

    QPolygon lasso_2Dpoints_;
    
    QVector<QPoint> volumeLassoPoints_;

    ConversionDialog* conversionDialog_;

    ParameterWidget* parameterWidget_;

    QtColorChooserButton*       colorButtonSelection_;
    QtColorChooserButton*       colorButtonArea_;
    QtColorChooserButton*       colorButtonHandle_;
    QtColorChooserButton*       colorButtonFeature_;

    ACG::Vec4f statusColor_;
    ACG::Vec4f areaColor_;
    ACG::Vec4f handleColor_;
    ACG::Vec4f featureColor_;

    double dihedral_angle_threshold_;
    double max_angle_;

};

class SelectVolumeAction
{
public:

    SelectVolumeAction(QRegion&_region, MeshObjectSelectionPlugin* _plugin,
                       unsigned int _type, bool _deselection, ACG::GLState& _state) :
            state_(_state), region_(_region), plugin_(_plugin), type_(_type), deselection_(_deselection) {};

    void enter(BaseNode* /*_node*/) {};

    void leave(BaseNode* /*_node*/) {};

    bool operator()(BaseNode* _node);

private:
    ACG::GLState&               state_;
    QRegion&                    region_;
    MeshObjectSelectionPlugin*  plugin_;
    unsigned int                type_;
    bool                        deselection_;
};
//=============================================================================
#if defined(INCLUDE_TEMPLATES) && !defined(MESHOBJECTSELECTIONPLUGINT_CC)
#define MESHOBJECTSELECTIONPLUGINT_TEMPLATES
#include "MeshObjectSelectionPluginT_impl.hh"
#endif