MeshRepairPlugin.hh 11.7 KB
Newer Older
1 2 3
/*===========================================================================*\
*                                                                            *
*                              OpenFlipper                                   *
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
 *           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.              *
39 40 41
*                                                                            *
\*===========================================================================*/

Jan Möbius's avatar
Jan Möbius committed
42

43 44 45 46 47 48 49 50 51 52 53

#ifndef MESHREPAIRPLUGIN_HH
#define MESHREPAIRPLUGIN_HH

#include <QObject>
#include <QMenuBar>

#include <OpenFlipper/BasePlugin/BaseInterface.hh>
#include <OpenFlipper/BasePlugin/LoggingInterface.hh>
#include <OpenFlipper/BasePlugin/ToolboxInterface.hh>
#include <OpenFlipper/BasePlugin/BackupInterface.hh>
54 55
#include <OpenFlipper/BasePlugin/ScriptInterface.hh>
#include <OpenFlipper/BasePlugin/RPCInterface.hh>
56 57 58 59 60 61
#include <OpenFlipper/common/Types.hh>
#include <ObjectTypes/PolyMesh/PolyMesh.hh>
#include <ObjectTypes/TriangleMesh/TriangleMesh.hh>

#include "MeshRepairToolbar.hh"

62
class MeshRepairPlugin : public QObject, BaseInterface , ToolboxInterface, BackupInterface, LoggingInterface, ScriptInterface, RPCInterface
63 64 65 66 67 68
{
    Q_OBJECT
    Q_INTERFACES(BaseInterface)
    Q_INTERFACES(ToolboxInterface)
    Q_INTERFACES(BackupInterface)
    Q_INTERFACES(LoggingInterface)
69 70
    Q_INTERFACES(ScriptInterface)
    Q_INTERFACES(RPCInterface)
71

72 73
  Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-MeshRepair")

74 75 76 77 78
signals:

    void updateView();

    // Base Interface
79
    void updatedObject(int _identifier, const UpdateType& _type);
80 81
    void setSlotDescription(QString     _slotName,   QString     _slotDescription,
                            QStringList _parameters, QStringList _descriptions);
82

83
    // Logging interface
84 85 86 87 88 89 90
    void log(Logtype _type, QString _message);
    void log(QString _message);

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

    // Backup Interface
Dirk Wilden's avatar
Dirk Wilden committed
91
    void createBackup( int _objectid, QString _name, UpdateType _type = UPDATE_ALL);
92

93 94 95 96 97 98 99
    // RPC Interface
    void pluginExists( QString _pluginName , bool& _exists  ) ;
    void functionExists( QString _pluginName , QString _functionName , bool& _exists  );

    // ScriptInterface
    void scriptInfo( QString _functionName );

100 101 102
private slots:

    void initializePlugin();
103
    void pluginsInitialized();
104 105 106

public :

Jan Möbius's avatar
Jan Möbius committed
107 108
    MeshRepairPlugin();

109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
    ~MeshRepairPlugin() {};

    QString name() {
        return (QString("Mesh Repair"));
    };
    QString description( ) {
        return (QString("Functionality to repair meshes"));
    };

private :

    /// Widget for Toolbox
    MeshRepairToolbarWidget* tool_;
    QIcon* toolIcon_;

private slots:

    /// Button slot
    void slotRemoveSelectedVal3Vertices();

    /// Button slot
    void slotRemoveSelectedEdges();

    /// Button slot
133
    void slotDetectSkinnyTriangleByAngle();
134 135

    /// Button slot
136
    void slotRemoveSkinnyTriangleByAngle();
137 138 139 140 141 142 143

    /// Button slot
    void slotDetectFoldover();

    /// Button slot
    void slotDetectTriangleAspect();

144 145 146
    /// Button slot
    void slotFlipOrientation();

Jan Möbius's avatar
Jan Möbius committed
147 148 149
    /// Button slot
    void slotFixMesh();

150 151 152 153 154 155
    /// Button slot
    void slotUpdateVertexNormals();

    /// Button slot
    void slotUpdateFaceNormals();

156 157 158
    /// Button slot
    void slotUpdateHalfedgeNormals();

159 160 161 162
    /// Button slot
    void slotUpdateNormals();

    /// Button Slot
163
    void slotDetectEdgesLonger();
164

165 166
    /// Button Slot
    void slotDetectEdgesShorter();
167

168 169
    /// Button slot
    void slotDetectFlatValence3Vertices();
170

171 172 173
    /// Button slot
    void slotSnapBoundary();

174
    /// Button slot
175 176 177 178 179 180 181
    void slotFixNonManifoldVertices();


    //===========================================================================
    /** @name Scripting functions
    * @{ */
    //===========================================================================
182

183
public slots:
184

Jan Möbius's avatar
Jan Möbius committed
185 186 187 188 189 190 191 192 193
    // ==================================================
    // Vertex operations
    // ==================================================

    /** \brief Detect valence 3 vertices with faces that lie in the plane of their adjacent triangles
     *
     */
    void detectFlatValence3Vertices(int _objectId, double _angle);

194 195 196
    /// Remove all selected valence 3 vertices
    void removeSelectedVal3Vertices(int _objectId);

Jan Möbius's avatar
Jan Möbius committed
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
    // ==================================================
    // Edge operations
    // ==================================================

    /** \brief Selects all edges of an object which are shorter than the given length
     *
     * @param _objectId Id of the object
     * @param _length   maximal edge length to select
     */
    void selectEdgesShorterThan(int _objectId,double _length);

    /** \brief Selects all edges of an object which are larger than the given length
     *
     * @param _objectId Id of the object
     * @param _length   Minimal edge length to select
     */
    void selectEdgesLongerThan(int _objectId,double _length);

    /** \brief Removes all selected edges
     *
     * @param _objectId Id of the object
     */
219 220
    void removeSelectedEdges(int _objectId);

Jan Möbius's avatar
Jan Möbius committed
221 222 223 224 225 226
    /** \brief  Detect/Remove edges where neighboring faces form angle > _angle degrees
     *
     * @param _objectId Id of the object
     * @param _angle    minimal angle to detect
     * @param _remove   Detect them or also remove them?
     */
227
    void detectSkinnyTriangleByAngle(int _objectId, double _angle, bool _remove);
228

Jan Möbius's avatar
Jan Möbius committed
229 230 231 232 233
    /** \brief Detect folded-over configurations by the dihedral angle
     *
     * @param _objectId Id of the object
     * @param _angle    Minimal dihedral angle that will be selected
     */
234
    void detectFoldover(int _objectId, float _angle);
235

Jan Möbius's avatar
Jan Möbius committed
236

Jan Möbius's avatar
Jan Möbius committed
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
    // ==================================================
    // Face operations
    // ==================================================

    /** \brief Detect triangles with aspect ratio greater than _aspect and select them
     *
     * @param _objectId Id of the object
     * @param _aspect   Minimal aspect ratio to select
     */
    void detectTriangleAspect(int _objectId, float _aspect);

    /** \brief Flips the normals of all selected faces by changing the vertex order
     *
     * @param _objectId Id of the object
     */
    void flipOrientation(int _objectId);
253

254 255 256 257
    // ==================================================
    // Normal recomputations
    // ==================================================

258 259 260 261
    /** \brief  Recomputes the face normals of an object
     *
     * @param _objectId Id of the object
     */
262 263
    void updateFaceNormals(int _objectId);

264 265 266 267
    /** \brief Recomputes the halfedge normals of an object
     *
     * @param _objectId Id of the object
     */
268 269
    void updateHalfedgeNormals(int _objectId);

270 271 272 273
    /** \brief Recomputes the vertex normals of an object
     *
     * @param _objectId Id of the object
     */
274 275
    void updateVertexNormals(int _objectId);

276 277 278 279
    /** \brief  Recomputes the face and vertex normals of an object
     *
     * @param _objectId Id of the object
     */
280 281 282 283 284 285
    void updateNormals(int _objectId);

    // ==================================================
    // General
    // ==================================================

Jan Möbius's avatar
Jan Möbius committed
286 287 288 289 290 291 292 293 294
    /** \brief Snaps selected vertices at boundaries
     *
     * Snaps selected boundary vertices together if they are closer than the given
     * distance. No new vertices will be introduced on either edge, so they are just
     * snapped to existing ones.
     *
     * @param _objectId Id of the object
     * @param _eps      Distance of vertices to snap
     */
295 296
    void snapBoundary(int _objectId, double _eps);

297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
    /** \brief remove non-manifold vertices by duplicating them
     *
     * @param _objectId Id of the mesh to fix
     */
    void fixNonManifoldVertices(int _objectId);

    /** \brief Fix a mesh
     *
     * Degenerated faces will be removed and all vertices which are closer than the given distance
     * will be collapsed. Non-manifold configurations at vertices will be removed and all faces of
     * each component will be updated to have the same orientation.
     *
     * @param _objectId Id of the object to fix
     * @param _epsilon  Snapping distance
     */
    void fixMesh(int _objectId, double _epsilon);

    /** @} */
315

316 317 318 319 320 321 322 323 324 325
private:
    /** \brief select edges based on length
    *
    * Selects edges if they are larger or shorter than a given length,
    * @param _objectId Id of the object to select
    * @param _length Length
    * @param _larger true : select larger edges, false select smaller edges
    */
    void selectionEdgeLength(int _objectId, double _length, bool _larger);

326 327
    /** \brief flip orientation of selected faces.
     *
328 329 330
     * flips the orientation of selected faces or if nothing is selected, the whole mesh is flipped
     * for correct topology, some vertices may be duplicated
     *
331 332 333
     * @param _mesh target mesh
     *
     */
334
    template<typename MeshT>
335
    void flipOrientation(MeshT& _mesh);
336 337


338
public slots:
Jan Möbius's avatar
Jan Möbius committed
339
    QString version() { return QString("1.3"); };
340 341
};

342 343 344 345 346
#if defined(INCLUDE_TEMPLATES) && !defined(MESHREPAIRPLUGINT_CC)
#define MESHREPAIRPLUGIN_TEMPLATES
#include "MeshRepairPluginT.cc"
#endif

347
#endif //MESHREPAIRPLUGIN_HH