VolumeMeshSelectionPlugin.hh 13.7 KB
Newer Older
1 2 3 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 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
/*===========================================================================*\
 *                                                                           *
 *                              OpenFlipper                                  *
 *      Copyright (C) 2001-2010 by Computer Graphics Group, RWTH Aachen      *
 *                           www.openflipper.org                             *
 *                                                                           *
 *---------------------------------------------------------------------------*
 *  This file is part of OpenFlipper.                                        *
 *                                                                           *
 *  OpenFlipper is free software: you can redistribute it and/or modify      *
 *  it under the terms of the GNU Lesser General Public License as           *
 *  published by the Free Software Foundation, either version 3 of           *
 *  the License, or (at your option) any later version with the              *
 *  following exceptions:                                                    *
 *                                                                           *
 *  If other files instantiate templates or use macros                       *
 *  or inline functions from this file, or you compile this file and         *
 *  link it with other files to produce an executable, this file does        *
 *  not by itself cause the resulting executable to be covered by the        *
 *  GNU Lesser General Public License. This exception does not however       *
 *  invalidate any other reasons why the executable file might be            *
 *  covered by the GNU Lesser General Public License.                        *
 *                                                                           *
 *  OpenFlipper is distributed in the hope that it will be useful,           *
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of           *
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the            *
 *  GNU Lesser General Public License for more details.                      *
 *                                                                           *
 *  You should have received a copy of the GNU LesserGeneral Public          *
 *  License along with OpenFlipper. If not,                                  *
 *  see <http://www.gnu.org/licenses/>.                                      *
 *                                                                           *
\*===========================================================================*/

/*===========================================================================*\
 *                                                                           *
 *   $Revision: 11942 $                                                       *
 *   $Author: kremer $                                                       *
 *   $Date: 2011-07-06 15:10:17 +0200 (Wed, 06 Jul 2011) $                   *
 *                                                                           *
\*===========================================================================*/

#ifndef VOLUMEMESHSELECTIONPLUGIN_HH
#define VOLUMEMESHSELECTIONPLUGIN_HH

#include <QObject>

#include <OpenFlipper/BasePlugin/BaseInterface.hh>
#include <OpenFlipper/BasePlugin/KeyInterface.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/common/Types.hh>
#include <OpenFlipper/BasePlugin/PluginFunctions.hh>
#include <OpenFlipper/INIFile/INIFile.hh>

#include <ObjectTypes/PolyhedralMesh/PolyhedralMesh.hh>
#include <ObjectTypes/HexahedralMesh/HexahedralMesh.hh>

class VolumeMeshSelectionPlugin : public QObject, BaseInterface, KeyInterface,
            INIInterface, BackupInterface, LoggingInterface, ScriptInterface, SelectionInterface
{
    Q_OBJECT
    Q_INTERFACES(BaseInterface)
    Q_INTERFACES(KeyInterface)
    Q_INTERFACES(INIInterface)
    Q_INTERFACES(BackupInterface)
    Q_INTERFACES(LoggingInterface)
    Q_INTERFACES(ScriptInterface)    
    Q_INTERFACES(SelectionInterface)

Matthias Möller's avatar
Matthias Möller committed
77 78 79 80
#if QT_VERSION >= 0x050000
  Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-SelectionVolumeMesh")
#endif

81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
public:
    
    /// Default constructor
    VolumeMeshSelectionPlugin();

    /// Default destructor
    ~VolumeMeshSelectionPlugin();
    
signals:

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

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

    // ScriptInterface
    void scriptInfo(QString _functionName);

    // SelectionInterface
Jan Möbius's avatar
Jan Möbius committed
106
    void addSelectionEnvironment(QString _modeName, QString _description, QString _icon, QString& _handleName);
107
    void registerType(QString _handleName, DataType _type);
Jan Möbius's avatar
Jan Möbius committed
108
    void addPrimitiveType(QString _handleName, QString _name, QString _icon, SelectionInterface::PrimitiveType& _typeHandle);
109 110 111
    void addSelectionOperations(QString _handleName, QStringList _operationsList, QString _category, SelectionInterface::PrimitiveType _type = 0u);
    void showToggleSelectionMode(QString _handleName, bool _show, SelectionInterface::PrimitiveType _associatedTypes);
    void showVolumeLassoSelectionMode(QString _handleName, bool _show, SelectionInterface::PrimitiveType _associatedTypes);
Jan Möbius's avatar
Jan Möbius committed
112
    void addCustomSelectionMode(QString _handleName, QString _modeName, QString _description, QString _icon,
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
           SelectionInterface::PrimitiveType _associatedTypes, QString& _customIdentifier);

    void getActiveDataTypes(SelectionInterface::TypeList& _types);
    void getActivePrimitiveType(SelectionInterface::PrimitiveType& _type);
    void targetObjectsOnly(bool& _targetsOnly);
    
    void registerKeyShortcut(int _key, Qt::KeyboardModifiers _modifiers = Qt::NoModifier);

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 slotCustomSelection(QMouseEvent *_event, SelectionInterface::PrimitiveType _currentType, QString _customIdentifier, bool _deselect);

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

public slots:

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

public:

    // BaseInterface
    QString name() {
        return (QString(tr("VolumeMesh Selection")));
    };
    
    QString description() {
        return (QString(tr("Allows to select VolumeMeshes")));
    };

    //===========================================================================
    /** @name Private methods
    * @{ */
    //===========================================================================
private:
    
    /// Set slot descriptions for scripting functions
    void updateSlotDescriptions();
    
    /** @} */
    
public slots:

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

    //===========================================================================
    /** @name Scriptable slots
    * @{ */
    //===========================================================================
179 180 181 182 183 184 185 186 187 188 189 190 191 192

    /// Is vertex type active? (for use in plugins that need mesh selection)
    bool vertexTypeActive();

    /// Is vertex type active? (for use in plugins that need mesh selection)
    bool edgeTypeActive();

    /// Is face type active? (for use in plugins that need mesh selection)
    bool faceTypeActive();

    /// Is cell type active? (for use in plugins that need mesh selection)
    bool cellTypeActive();

    //===========================================================================
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352
    
    /// Select all vertices of a volume mesh
    void selectAllVertices(int _objectId);

    /// Deselect all vertices of a volume mesh
    void deselectAllVertices(int _objectId);

    /// Invert vertex selection
    void invertVertexSelection(int _objectId);

    /// Select specific vertices of a volume mesh
    void selectVertices(int _objectId, const IdList& _ids, bool _deselect = false);

    /// Get current vertex selection
    IdList getVertexSelection(int _objectId);

    /// Delete selected vertices from mesh
    void deleteSelectedVertices(int _objectId, bool _preserveManifoldness = true);

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

    /// Select all edges of a volume mesh
    void selectAllEdges(int _objectId);

    /// Deselect all edges of a volume mesh
    void deselectAllEdges(int _objectId);

    /// Invert edge selection
    void invertEdgeSelection(int _objectId);

    /// Select specific edges of a volume mesh
    void selectEdges(int _objectId, const IdList& _ids, bool _deselect = false);

    /// Get current edge selection
    IdList getEdgeSelection(int _objectId);

    /// Delete selected edges from mesh
    void deleteSelectedEdges(int _objectId, bool _preserveManifoldness = true);

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

    /// Select all half-edges of a volume mesh
    void selectAllHalfEdges(int _objectId);

    /// Deselect all half-edges of a volume mesh
    void deselectAllHalfEdges(int _objectId);

    /// Invert half-edge selection
    void invertHalfEdgeSelection(int _objectId);

    /// Select specific half-edges of a volume mesh
    void selectHalfEdges(int _objectId, const IdList& _ids, bool _deselect = false);

    /// Get current half-edge selection
    IdList getHalfEdgeSelection(int _objectId);

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

    /// Select all faces of a volume mesh
    void selectAllFaces(int _objectId);

    /// Deselect all faces of a volume mesh
    void deselectAllFaces(int _objectId);

    /// Invert face selection
    void invertFaceSelection(int _objectId);

    /// Select specific faces of a volume mesh
    void selectFaces(int _objectId, const IdList& _ids, bool _deselect = false);

    /// Get current face selection
    IdList getFaceSelection(int _objectId);

    /// Delete selected faces from mesh
    void deleteSelectedFaces(int _objectId, bool _preserveManifoldness = true);

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

    /// Select all half-faces of a volume mesh
    void selectAllHalfFaces(int _objectId);

    /// Deselect all half-faces of a volume mesh
    void deselectAllHalfFaces(int _objectId);

    /// Invert half-face selection
    void invertHalfFaceSelection(int _objectId);

    /// Select specific half-faces of a volume mesh
    void selectHalfFaces(int _objectId, const IdList& _ids, bool _deselect = false);

    /// Get current half-face selection
    IdList getHalfFaceSelection(int _objectId);

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

    /// Select all cells of a volume mesh
    void selectAllCells(int _objectId);

    /// Deselect all cells of a volume mesh
    void deselectAllCells(int _objectId);

    /// Invert cell selection
    void invertCellSelection(int _objectId);

    /// Select specific cells of a volume mesh
    void selectCells(int _objectId, const IdList& _ids, bool _deselect = false);

    /// Get current cell selection
    IdList getCellSelection(int _objectId);

    /// Delete selected cells from mesh
    void deleteSelectedCells(int _objectId, bool _preserveManifoldness = true);

    /** @} */

    //===========================================================================
    /** @name Member variables
    * @{ */
    //===========================================================================

private:

    // Get orthogonal orientation of neighboring cell
    unsigned char getOrthogonalOrientationOfNeighborCell(const OpenVolumeMesh::CellHandle& _ch1,
            const OpenVolumeMesh::CellHandle& _ch2, unsigned char _firstOrthDirection, const HexahedralMesh* _mesh) const;

    // Get face shared by two adjacent cells
    typedef std::pair<OpenVolumeMesh::HalfFaceHandle,OpenVolumeMesh::HalfFaceHandle> HFPair;
    HFPair getCommonFace(const OpenVolumeMesh::CellHandle& _ch1,
            const OpenVolumeMesh::CellHandle& _ch2, const HexahedralMesh* _mesh) const;

    /// Handle to selection environment
    QString environmentHandle_;

    QString columnSelectionHandle_;
    QString sheetSelectionHandle_;

    /// Primitive type handles:
    PrimitiveType vertexType_;
    PrimitiveType edgeType_;
    PrimitiveType faceType_;
    PrimitiveType cellType_;
    
    PrimitiveType allSupportedTypes_;
    
    /// Keep volume lasso points
    QVector<QPoint> volumeLassoPoints_;

    // Store last picked cell for sheet selection
    OpenVolumeMesh::CellHandle lastPickedCell_;
    unsigned char lastPickedOrientation_;
    std::map<OpenVolumeMesh::CellHandle, unsigned char> orientationMap_;

    /** @} */

};

//=============================================================================
#endif // VOLUMEMESHSELECTIONPLUGIN_HH defined
//=============================================================================