DataControlPlugin.hh 14.5 KB
Newer Older
1
/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
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.              *
Jan Möbius's avatar
Jan Möbius committed
39
*                                                                            *
40 41
\*===========================================================================*/

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

43 44 45 46




Dirk Wilden's avatar
Dirk Wilden committed
47 48
#ifndef DATACONTROLPLUGIN_HH
#define DATACONTROLPLUGIN_HH
49 50 51 52 53 54 55 56 57


#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>
Dirk Wilden's avatar
Dirk Wilden committed
58
#include <OpenFlipper/BasePlugin/LoadSaveInterface.hh>
59
#include <OpenFlipper/BasePlugin/PythonInterface.hh>
60
#include <OpenFlipper/common/Types.hh>
61
#include <ObjectTypes/Light/Light.hh>
62
#include "Toolbox.hh"
63 64

#include "TreeModel.hh"
65
#include "DefaultObjectMarker.hh"
66 67


68
/** Plugin for controlling the Object data structures (Show,hide Object, Target, Source selection
69
*/
70
class DataControlPlugin : public QObject, BaseInterface, ToolboxInterface, KeyInterface , LoggingInterface, INIInterface, ContextMenuInterface, ScriptInterface, LoadSaveInterface, PythonInterface
71 72 73 74 75 76 77 78
{
  Q_OBJECT
  Q_INTERFACES(BaseInterface)
  Q_INTERFACES(ToolboxInterface)
  Q_INTERFACES(KeyInterface)
  Q_INTERFACES(LoggingInterface)
  Q_INTERFACES(INIInterface)
  Q_INTERFACES(ContextMenuInterface)
79
  Q_INTERFACES(ScriptInterface)
Dirk Wilden's avatar
Dirk Wilden committed
80
  Q_INTERFACES(LoadSaveInterface)
81
  Q_INTERFACES(PythonInterface)
82

83 84
  Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-DataControl")

85
  signals:
Dirk Wilden's avatar
Dirk Wilden committed
86
    // BaseInterface
87
    void updateView();
88
    void updatedObject(int _it, const UpdateType& _type);
89

Dirk Wilden's avatar
Dirk Wilden committed
90 91 92 93
    void setSlotDescription(QString     _slotName,   QString     _slotDescription,
                            QStringList _parameters, QStringList _descriptions);

    // LoggingInterface
94 95
    void log(Logtype _type, QString _message);
    void log(QString _message);
96
    
Dirk Wilden's avatar
Dirk Wilden committed
97
    // ContextMenuInterface
98 99
    void addContextMenuItem(QAction* _action , ContextMenuType _type);
    void addContextMenuItem(QAction* _action , DataType _objectType , ContextMenuType _type );
100
    
101 102
    // LoadSaveInterface
    void deleteObject( int _id );
103
    void emptyObjectAdded( int _id );
104
    void copyObject( int _oldId, int& _newId);
105 106
    
    // ToolboxInterface
107
    void addToolbox( QString _name  , QWidget* _widget, QIcon* _icon, QWidget *_headerAreaWidget);
108

109 110
    void objectsGrouped(IdList);

Dirk Wilden's avatar
Dirk Wilden committed
111 112
  private slots :
    // BaseInterface
113
    void initializePlugin();
Dirk Wilden's avatar
Dirk Wilden committed
114
    void pluginsInitialized();
Dirk Wilden's avatar
Dirk Wilden committed
115 116 117
    void slotVisibilityChanged      ( int _identifier );
    void slotObjectSelectionChanged ( int _identifier );
    void slotObjectPropertiesChanged( int _identifier );
118
    void slotObjectUpdated( int _identifier, const UpdateType& _type );
119

Dirk Wilden's avatar
Dirk Wilden committed
120 121
    // KeyInterface
    void slotKeyEvent( QKeyEvent* _event );
122

Dirk Wilden's avatar
Dirk Wilden committed
123 124 125
    // INIInterface
    void loadIniFileOptionsLast( INIFile& _ini );
    void saveIniFileOptions( INIFile& _ini );
126
    void saveOnExit(INIFile& _ini );
127

Dirk Wilden's avatar
Dirk Wilden committed
128 129 130
    // LoadSaveInterface
    void fileOpened(int _id);
    void addedEmptyObject(int _id);
131
    void objectDeleted(int _id);
Dirk Wilden's avatar
Dirk Wilden committed
132

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

136 137
    void slotObjectsGrouped(IdList _lst);

Dirk Wilden's avatar
Dirk Wilden committed
138
  public :
Jan Möbius's avatar
Jan Möbius committed
139 140 141 142

    /// Constructor
    DataControlPlugin();

Dirk Wilden's avatar
Dirk Wilden committed
143 144
    /// Destructor
    ~DataControlPlugin() {};
145

Dirk Wilden's avatar
Dirk Wilden committed
146 147
    /// Name of the Plugin
    QString name(){ return (QString("DataControl")); };
148

Dirk Wilden's avatar
Dirk Wilden committed
149
    /// Description of the Plugin
150
    QString description() { return (QString(tr("Manages Data Objects"))); };
151

Dirk Wilden's avatar
Dirk Wilden committed
152 153 154
  private :
    /// Widget for Toolbox
    DatacontrolToolboxWidget* tool_;
155
    QIcon* toolIcon_;
156

Dirk Wilden's avatar
Dirk Wilden committed
157 158
    /// Layout for Toolbox
    QGridLayout* MeshDialogLayout_;
159

Dirk Wilden's avatar
Dirk Wilden committed
160 161
    /// Table containing Mesh information and status
    QTableWidget* objectList_;
162

Dirk Wilden's avatar
Dirk Wilden committed
163 164
    /// Flag set to true if meshlist is updated, preventing signal for list udate to be called
    bool locked;
165

Dirk Wilden's avatar
Dirk Wilden committed
166 167
    /// The Treemodel organizing the data
    TreeModel* model_;
168

Dirk Wilden's avatar
Dirk Wilden committed
169 170
    ///Tree view
    QTreeView* view_;
171

Dirk Wilden's avatar
Dirk Wilden committed
172 173
    /// Pointer to the header to the view widget
    QHeaderView * viewHeader_;
174

175 176 177
    /// Default marker to visualize "source" and "target" object flags
    DefaultObjectMarker objectMarker;

Dirk Wilden's avatar
Dirk Wilden committed
178

Dirk Wilden's avatar
Dirk Wilden committed
179 180 181 182
//===========================================================================
/** @name Slots which are called if data changed
* @{ */
//===========================================================================
183

Dirk Wilden's avatar
Dirk Wilden committed
184
  private slots:
185

Dirk Wilden's avatar
Dirk Wilden committed
186
    /// Gets called when the data in the table has changed
187
    void slotDataChanged (int _id, int _column, const QVariant& _value);
188

189 190
    /// Gets called when an object was moved via drag n drop
    void slotMoveBaseObject (int _id, int _newParentId);
191

Dirk Wilden's avatar
Dirk Wilden committed
192
  private:
193 194
    void propagateDownwards(BaseObject* _obj, int _column );
    void propagateUpwards(BaseObject* _obj, int _column );
195

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

Dirk Wilden's avatar
Dirk Wilden committed
203
/** @} */
204

Dirk Wilden's avatar
Dirk Wilden committed
205 206 207 208
//===========================================================================
/** @name Popup Menu related
* @{ */
//===========================================================================
209 210 211
      private slots:
        /// Display a custom context window for the TreeView
        void slotCustomContextMenuRequested ( const QPoint & _pos );
212

213 214
        /// Called by the popup menu to remove an object/group
        void slotPopupRemove( );
215

216 217
        /// Called by the popup menu to ungroup items
        void slotUngroup ( );
218

219 220
        /// Called by the popup menu to group items
        void slotGroup ( );
221

222 223 224
        /// Called by the popup menu to copy items
        void slotCopy();

225 226
        ///Called by the popup menu to rename items
        void slotRename ( );
Dirk Wilden's avatar
Dirk Wilden committed
227 228 229

        ///Called by the popup menu to zoom to an object
        void slotZoomTo();
230 231 232
        
        /// Called by the popup menu in order to turn lights on/off
        void slotSwitchLight();
233 234 235
        
        /// Called by the popup menu in order to edit lights
        void slotEditLight();
236

Dirk Wilden's avatar
Dirk Wilden committed
237 238 239
        ///Called by the popup menu to set material properties
        void slotMaterialProperties();

240 241 242
        ///Called by the popup menu to copy material properties
        void slotCopyMaterialToTargeted();

243 244 245 246 247 248
        ///Called by the popup menu to copy material properties to clipboard
        void slotCopyMaterialToClipboard();

        ///Called by the popup menu to paste material properties from clipboard
        void slotPasteMaterialFromClipboard();

249 250 251 252
        /** \brief Called when the material properties were changed inside the material dialog
         *
         * @param _node unused
         */
Dirk Wilden's avatar
Dirk Wilden committed
253
        void slotNodeChanged( ACG::SceneGraph::BaseNode* _node );
254 255
        
        /// Hide/Show all light sources if checkbox has been checked
256
        void slotShowLightSources( bool _state );
257
        void slotShowLightSources();
Dirk Wilden's avatar
Dirk Wilden committed
258

259 260 261
      private :
        /// Index where a popup has been opened
        QModelIndex popupIndex_;
262

263
      private slots:
264

265 266
        /// Display a custom context window for the TreeViews header
        void slotHeaderCustomContextMenuRequested ( const QPoint & _pos );
267

268 269 270
      private:
        /// Defines the section of the Popup
        int headerPopupType_;
271

Dirk Wilden's avatar
Dirk Wilden committed
272
/** @} */
273

Dirk Wilden's avatar
Dirk Wilden committed
274 275 276 277
//===========================================================================
/** @name GL Area Context Menu related slots
* @{ */
//===========================================================================
278

279
      private slots:
280

281 282
        /// Hide an object
        void slotContextMenuHide( );
283

284 285
        /// Target Selection
        void slotContextMenuTarget( );
286

287 288
        /// Source Selection
        void slotContextMenuSource( );
289 290 291
        
        /// Remove Selected Item
        void slotContextMenuRemove( );
292

293 294
        /// Update the context Menus for the given id
        void slotUpdateContextMenu( int _objectId);
295

296 297 298
      private :
        QAction* targetAction_;
        QAction* sourceAction_;
299
        QAction* removeAction_;
300

301 302
        QToolButton *advancedSettingsBtn_;

Dirk Wilden's avatar
Dirk Wilden committed
303
/** @} */
304

305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
//===========================================================================
/** @name Bounding box related slots/functions
* @{ */
//===========================================================================

      private slots:

        /// Bounding box selection changed
        void slotBoundingBoxChange( );

     private:

        /// Updates bounding box
        void updateBoundingBox(BaseObjectData* _obj);

/** @} */

Dirk Wilden's avatar
Dirk Wilden committed
322 323 324 325
//===========================================================================
/** @name Scripting functions
* @{ */
//===========================================================================
326

Dirk Wilden's avatar
Dirk Wilden committed
327
      private slots:
Jan Möbius's avatar
Jan Möbius committed
328 329 330 331

        /** This function sets the slot descriptions for this plugin
         *  which will be visible in the script editor
         */
Dirk Wilden's avatar
Dirk Wilden committed
332 333
        void setDescriptions();

334 335 336
      public slots:
        /// Get the Objects name from the id
        QString getObjectName( int objectId );
337

338
        /// Delete the given object
339
        void objectDelete(int objectId);
340

Jan Möbius's avatar
Jan Möbius committed
341 342 343
        /// Creates an object copy
        int copyObject( int objectId );

344 345
        /// Get the id of an object by its name
        int getObject( QString _name );
346

347 348 349
        /// Get the DataType of a given object
        DataType dataType( int objectId );

350 351
        /// Hide the given Object
        void hideObject( int objectId );
352

353
        /// Show the given Object
354 355
        void showObject( int objectId );

Dirk Wilden's avatar
Dirk Wilden committed
356 357 358 359 360 361 362 363 364
        /// set the given Object as target
        void setTarget( int objectId, bool _target );

        /// set the given Object as source
        void setSource( int objectId, bool _source );

        /// set the name of the given object
        void setObjectName( int objectId, QString _name );

365 366
        /// Makes all available objects target
        void setAllTarget();
367

368 369
        /// Makes all available objects source
        void setAllSource();
370

371 372
        /// Unselect all objects
        void clearAllTarget();
373

374 375
        /// remove source selection from all objects
        void clearAllSource();
376

377 378
        /// Shows all objects
        void showAll();
379

380 381
        /// Hides all objects
        void hideAll();
382

383 384 385 386 387 388 389 390 391 392 393
		/** Create and add an empty group.
		 *
		 * @param _groupName Name of the new group. If it is an empty string,
		 *        a default name based on group id will be generated.
		 * @param _parentGroupId Parent object under which the new group is
		 *        created. If _parentGroupId is zero, the corresponding object
		 *        does not exist or it is not a group, the new group is created
		 *        as toplevel.
		 */
		int addEmptyGroup(QString _groupName = "", int _parentGroupId = 0);

394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413
		/** Group objects together
		 *
		 * @return object id of new group or -1 if failed
		 */
		int groupObjects(IdList _objectIDs, QString _groupName = "");

		/// add an object to an existing group
		bool addObjectToGroup(int _objectId, int _groupId);

		/** remove an object from its group and place it at the toplevel group
		 *
		 * @return successfull
		 */
		bool unGroupObject(int _id);

		/// Get all target objects of given type
		IdList getTargetObjects(DataType _type);

		/// Get all source objects of given type
		IdList getSourceObjects(DataType _type);
Dirk Wilden's avatar
Dirk Wilden committed
414

415 416
		/// Returns the number of groups
		unsigned int groupCount() const;
417

418
		/// Returns a list of all available DataTypes
419
		QString availableDataTypeNames() const;
420

421 422
		/// Print information about all open objects to the console
		void printObjectInfoToLog();
423

424 425
		/// Get all elements of the given group
		IdList getGroupElements(int _groupId);
426

427 428
		/// Show or hide the extended ui interface in the datacontrol toolbox
		void showReducedUi(bool reduced);
Jan Möbius's avatar
Jan Möbius committed
429

Dirk Wilden's avatar
Dirk Wilden committed
430
/** @} */
431 432

  public slots:
Dirk Wilden's avatar
Dirk Wilden committed
433
    QString version() { return QString("1.03"); };
434 435
};

Dirk Wilden's avatar
Dirk Wilden committed
436
#endif //DATACONTROLPLUGIN_HH