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

/*===========================================================================*\
*                                                                            *
*   $Revision$                                                       *
*   $LastChangedBy$                                                *
*   $Date$                     *
*                                                                            *
\*===========================================================================*/




#ifndef DATACONTROLPLUGIN_HH
#define DATACONTROLPLUGIN_HH


#include <OpenFlipper/BasePlugin/BaseInterface.hh>
#include <OpenFlipper/BasePlugin/ToolboxInterface.hh>
#include <OpenFlipper/BasePlugin/KeyInterface.hh>
#include <OpenFlipper/BasePlugin/LoggingInterface.hh>
#include <OpenFlipper/BasePlugin/ContextMenuInterface.hh>
#include <OpenFlipper/BasePlugin/ScriptInterface.hh>
#include <OpenFlipper/BasePlugin/INIInterface.hh>
#include <OpenFlipper/BasePlugin/LoadSaveInterface.hh>
#include <OpenFlipper/common/Types.hh>
#include <ObjectTypes/Light/Light.hh>
#include "Toolbox.hh"

#include "TreeModel.hh"
#include "DefaultObjectMarker.hh"


class DataControlPlugin : public QObject, BaseInterface, ToolboxInterface, KeyInterface , LoggingInterface, INIInterface, ContextMenuInterface, ScriptInterface, LoadSaveInterface
{
  Q_OBJECT
  Q_INTERFACES(BaseInterface)
  Q_INTERFACES(ToolboxInterface)
  Q_INTERFACES(KeyInterface)
  Q_INTERFACES(LoggingInterface)
  Q_INTERFACES(INIInterface)
  Q_INTERFACES(ContextMenuInterface)
  Q_INTERFACES(ScriptInterface)
  Q_INTERFACES(LoadSaveInterface)

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

  signals:
    // BaseInterface
    void updateView();
    void updatedObject(int _it, const UpdateType& _type);

    void setSlotDescription(QString     _slotName,   QString     _slotDescription,
                            QStringList _parameters, QStringList _descriptions);

    // LoggingInterface
    void log(Logtype _type, QString _message);
    void log(QString _message);
    
    // ContextMenuInterface
    void addContextMenuItem(QAction* _action , ContextMenuType _type);
    void addContextMenuItem(QAction* _action , DataType _objectType , ContextMenuType _type );
    
    // LoadSaveInterface
    void deleteObject( int _id );
    void emptyObjectAdded( int _id );
    void copyObject( int _oldId, int& _newId);
    
    // ToolboxInterface
    void addToolbox( QString _name  , QWidget* _widget, QIcon* _icon, QWidget *_headerAreaWidget);

    void objectsGrouped(IdList);

  private slots :
    // BaseInterface
    void initializePlugin();
    void pluginsInitialized();
    void slotVisibilityChanged      ( int _identifier );
    void slotObjectSelectionChanged ( int _identifier );
    void slotObjectPropertiesChanged( int _identifier );
    void slotObjectUpdated( int _identifier, const UpdateType& _type );

    // KeyInterface
    void slotKeyEvent( QKeyEvent* _event );

    // INIInterface
    void loadIniFileOptionsLast( INIFile& _ini );
    void saveIniFileOptions( INIFile& _ini );
    void saveOnExit(INIFile& _ini );

    // LoadSaveInterface
    void fileOpened(int _id);
    void addedEmptyObject(int _id);
    void objectDeleted(int _id);

    // Tell system that this plugin runs without ui
    void noguiSupported( ) {} ;

    void slotObjectsGrouped(IdList _lst);

  public :

    DataControlPlugin();

    ~DataControlPlugin() {};

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

    QString description() { return (QString(tr("Manages Data Objects"))); };

  private :
    DatacontrolToolboxWidget* tool_;
    QIcon* toolIcon_;

    QGridLayout* MeshDialogLayout_;

    QTableWidget* objectList_;

    bool locked;

    TreeModel* model_;

    QTreeView* view_;

    QHeaderView * viewHeader_;

    DefaultObjectMarker objectMarker;


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

  private slots:

    void slotDataChanged (int _id, int _column, const QVariant& _value);

    void slotMoveBaseObject (int _id, int _newParentId);

  private:
    void propagateDownwards(BaseObject* _obj, int _column );
    void propagateUpwards(BaseObject* _obj, int _column );

    //variables to restrict propagation direction
    int onlyDown_;
    int onlyUp_;
    //defines, which selection column needs an update if not -1
    // 2: source 3: target
    int columnFromGUI_;

//===========================================================================
//===========================================================================
      private slots:
        void slotCustomContextMenuRequested ( const QPoint & _pos );

        void slotPopupRemove( );

        void slotUngroup ( );

        void slotGroup ( );

        void slotCopy();

        void slotRename ( );

        void slotZoomTo();
        
        void slotSwitchLight();
        
        void slotEditLight();

        void slotMaterialProperties();

        void slotCopyMaterialToTargeted();

        void slotCopyMaterialToClipboard();

        void slotPasteMaterialFromClipboard();

        void slotNodeChanged( ACG::SceneGraph::BaseNode* _node );
        
        void slotShowLightSources( bool _state );
        void slotShowLightSources();

      private :
        QModelIndex popupIndex_;

      private slots:

        void slotHeaderCustomContextMenuRequested ( const QPoint & _pos );

      private:
        int headerPopupType_;

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

      private slots:

        void slotContextMenuHide( );

        void slotContextMenuTarget( );

        void slotContextMenuSource( );
        
        void slotContextMenuRemove( );

        void slotUpdateContextMenu( int _objectId);

      private :
        QAction* targetAction_;
        QAction* sourceAction_;
        QAction* removeAction_;

        QToolButton *advancedSettingsBtn_;

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

      private slots:

        void slotBoundingBoxChange( );

     private:

        void updateBoundingBox(BaseObjectData* _obj);

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

      private slots:

        void setDescriptions();

      public slots:
        QString getObjectName( int objectId );

        void objectDelete(int objectId);

        int copyObject( int objectId );

        int getObject( QString _name );

        DataType dataType( int objectId );

        void hideObject( int objectId );

        void showObject( int objectId );

        void setTarget( int objectId, bool _target );

        void setSource( int objectId, bool _source );

        void setObjectName( int objectId, QString _name );

        void setAllTarget();

        void setAllSource();

        void clearAllTarget();

        void clearAllSource();

        void showAll();

        void hideAll();

                int addEmptyGroup(QString _groupName = "", int _parentGroupId = 0);

        int groupObjects(IdList _objectIDs, QString _groupName = "");
        
        bool addObjectToGroup(int _objectId, int _groupId);

        bool unGroupObject(int _id);
        
        IdList getTargetObjects(DataType _type);
        
        IdList getSourceObjects(DataType _type);

        unsigned int groupCount() const;

        QStringList availableDataTypeNames() const;

        void printObjectInfoToLog();

        IdList getGroupElements(int _groupId);

        void showReducedUi(bool reduced);

  public slots:
    QString version() { return QString("1.03"); };
};

#endif //DATACONTROLPLUGIN_HH