SelectionInterface.hh

Go to the documentation of this file.

/*===========================================================================*\
 *                                                                           *
 *                              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 <OpenFlipper/INIFile/INIFile.hh>
#include <OpenFlipper/common/Types.hh>


#include <QWidget>


class SelectionInterface {

  public:

    typedef std::vector<DataType> TypeList;
    typedef unsigned int          PrimitiveType;

    virtual ~SelectionInterface() {};

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

    signals:

    virtual void addSelectionEnvironment(QString _modeName, QString _description, QString _icon, QString& _handleName) {};

    virtual void registerType(QString _handleName, DataType _type) {};

    virtual void addPrimitiveType(QString _handleName, QString _name, QString _icon, PrimitiveType& _typeHandle) {};

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

    signals:

    virtual void showToggleSelectionMode(QString _handleName, bool _show, PrimitiveType _associatedTypes) {};

    virtual void showLassoSelectionMode(QString _handleName, bool _show, PrimitiveType _associatedTypes) {};

    virtual void showVolumeLassoSelectionMode(QString _handleName, bool _show, PrimitiveType _associatedTypes) {};

    virtual void showSurfaceLassoSelectionMode(QString _handleName, bool _show, PrimitiveType _associatedTypes) {};

    virtual void showSphereSelectionMode(QString _handleName, bool _show, PrimitiveType _associatedTypes) {};

    virtual void showClosestBoundarySelectionMode(QString _handleName, bool _show, PrimitiveType _associatedTypes) {};

    virtual void showFloodFillSelectionMode(QString _handleName, bool _show, PrimitiveType _associatedTypes) {};

    virtual void showComponentsSelectionMode(QString _handleName, bool _show, PrimitiveType _associatedTypes) {};

    virtual void addCustomSelectionMode(QString _handleName, QString _modeName, QString _description, QString _icon,
                                        PrimitiveType _associatedTypes, QString& _customIdentifier) {};

    virtual void addCustomSelectionMode(QString _handleName, QString _modeName, QString _description, QString _icon,
                                        PrimitiveType _associatedTypes, QString& _customIdentifier,
                                        DataType _objectTypeRestriction) {};

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


    virtual void getActiveDataTypes(TypeList& _types) {};

    virtual void getActivePrimitiveType(PrimitiveType& _type) {};

    virtual void targetObjectsOnly(bool& _targetsOnly) {};

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

    private slots:

    virtual void slotLoadSelection(const INIFile& _file) {};
    
    virtual void slotSaveSelection(INIFile& _file) {};

    public slots:

    virtual void loadSelection(int _objId, const QString& _filename) {};

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

    signals:
    virtual void registerKeyShortcut(int _key, Qt::KeyboardModifiers _modifiers = Qt::NoModifier) {};


    private slots:

    virtual void slotKeyShortcutEvent(int _key, Qt::KeyboardModifiers _modifiers) {};

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

    signals:
    virtual void addSelectionOperations(QString _handleName, QStringList _operationsList, QString _category, PrimitiveType _type = 0u) {};

    virtual void addSelectionParameters(QString _handleName, QWidget* _widget, QString _category, PrimitiveType _type = 0u) {};

    private slots:

    virtual void slotSelectionOperation(QString _operation) {};


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

   private slots:

   virtual void slotToggleSelection(QMouseEvent* _event, PrimitiveType _currentType, bool _deselect) {};

   virtual void slotLassoSelection(QMouseEvent* _event, PrimitiveType _currentType, bool _deselect) {};

   virtual void slotVolumeLassoSelection(QMouseEvent* _event, PrimitiveType _currentType, bool _deselect) {};

   virtual void slotSurfaceLassoSelection(QMouseEvent* _event, PrimitiveType _currentType, bool _deselect) {};

   virtual void slotSphereSelection(QMouseEvent* _event, double _radius, PrimitiveType _currentType, bool _deselect) {};

   virtual void slotClosestBoundarySelection(QMouseEvent* _event, PrimitiveType _currentType, bool _deselect) {};

   virtual void slotFloodFillSelection(QMouseEvent* _event, PrimitiveType _currentType, bool _deselect) {};

   virtual void slotComponentsSelection(QMouseEvent* _event, PrimitiveType _currentType, bool _deselect) {};

   virtual void slotCustomSelection(QMouseEvent* _event, PrimitiveType _currentType, QString _customIdentifier, bool _deselect) {};


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

   signals:

   virtual void selectionOperation(QString _operation) {};


   virtual void toggleSelection(QMouseEvent* _event, PrimitiveType _currentType, bool _deselect) {};

   virtual void lassoSelection(QMouseEvent* _event, PrimitiveType _currentType, bool _deselect) {};

   virtual void volumeLassoSelection(QMouseEvent* _event, PrimitiveType _currentType, bool _deselect) {};

   virtual void surfaceLassoSelection(QMouseEvent* _event, PrimitiveType _currentType, bool _deselect) {};

   virtual void sphereSelection(QMouseEvent* _event, double _radius, PrimitiveType _currentType, bool _deselect) {};

   virtual void closestBoundarySelection(QMouseEvent* _event, PrimitiveType _currentType, bool _deselect) {};

   virtual void floodFillSelection(QMouseEvent* _event, PrimitiveType _currentType, bool _deselect) {};

   virtual void componentsSelection(QMouseEvent* _event, PrimitiveType _currentType, bool _deselect) {};

   virtual void customSelection(QMouseEvent* _event, PrimitiveType _currentType, QString _customIdentifier, bool _deselect) {};

   virtual void loadSelection(const INIFile& _file) {};

   virtual void saveSelection(INIFile& _file) {};

   virtual void keyShortcutEvent(int _key, Qt::KeyboardModifiers _modifiers = Qt::NoModifier) {};


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

   private slots:

   virtual void slotAddSelectionEnvironment(QString _modeName, QString _description, QString _icon, QString& _handleName) {};

   virtual void slotRegisterType(QString _handleName, DataType _type) {};

   virtual void slotAddPrimitiveType(QString _handleName, QString _name, QString _icon, PrimitiveType& _typeHandle) {};

   virtual void slotAddCustomSelectionMode(QString _handleName, QString _modeName, QString _description, QString _icon,
                                           PrimitiveType _associatedTypes, QString& _customIdentifier) {};

   virtual void slotAddCustomSelectionMode(QString _handleName, QString _modeName, QString _description, QString _icon,
                                           PrimitiveType _associatedTypes, QString& _customIdentifier,
                                           DataType _objectTypeRestriction) {};

   virtual void slotShowToggleSelectionMode(QString _handleName, bool _show, PrimitiveType _associatedTypes) {};

   virtual void slotShowLassoSelectionMode(QString _handleName, bool _show, PrimitiveType _associatedTypes) {};

   virtual void slotShowVolumeLassoSelectionMode(QString _handleName, bool _show, PrimitiveType _associatedTypes) {};

   virtual void slotShowSurfaceLassoSelectionMode(QString _handleName, bool _show, PrimitiveType _associatedTypes) {};

   virtual void slotShowSphereSelectionMode(QString _handleName, bool _show, PrimitiveType _associatedTypes) {};

   virtual void slotShowClosestBoundarySelectionMode(QString _handleName, bool _show, PrimitiveType _associatedTypes) {};

   virtual void slotShowFloodFillSelectionMode(QString _handleName, bool _show, PrimitiveType _associatedTypes) {};

   virtual void slotComponentsSelectionMode(QString _handleName, bool _show, PrimitiveType _associatedTypes) {};

   virtual void slotRegisterKeyShortcut(int _key, Qt::KeyboardModifiers _modifiers) {};

   virtual void slotGetActiveDataTypes(TypeList& _types) {};

   virtual void slotGetActivePrimitiveType(PrimitiveType& _type) {};

   virtual void slotTargetObjectsOnly(bool& _targetsOnly) {};

   virtual void slotAddSelectionOperations(QString _handleName, QStringList _operationsList, QString _category, PrimitiveType _type) {};

   virtual void slotAddSelectionParameters(QString _handleName, QWidget* _widget, QString _category, PrimitiveType _type = 0u) {};


};

Q_DECLARE_INTERFACE(SelectionInterface,"OpenFlipper.SelectionInterface/1.1")