DataControlPlugin.hh 14.5 KB
Newer Older
1
/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
2 3
*                                                                            *
*                              OpenFlipper                                   *
Martin Schultz's avatar
Martin Schultz committed
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

Jan Möbius's avatar
 
Jan Möbius committed
43 44 45 46




Dirk Wilden's avatar
Dirk Wilden committed
47 48
#ifndef DATACONTROLPLUGIN_HH
#define DATACONTROLPLUGIN_HH
Jan Möbius's avatar
 
Jan Möbius committed
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>
Jan Möbius's avatar
 
Jan Möbius committed
59
#include <OpenFlipper/common/Types.hh>
60
#include <ObjectTypes/Light/Light.hh>
61
#include "Toolbox.hh"
Jan Möbius's avatar
 
Jan Möbius committed
62 63

#include "TreeModel.hh"
64
#include "DefaultObjectMarker.hh"
Jan Möbius's avatar
 
Jan Möbius committed
65 66


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

Matthias Möller's avatar
Matthias Möller committed
81 82
  Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-DataControl")

Jan Möbius's avatar
 
Jan Möbius committed
83
  signals:
Dirk Wilden's avatar
Dirk Wilden committed
84
    // BaseInterface
Jan Möbius's avatar
 
Jan Möbius committed
85
    void updateView();
86
    void updatedObject(int _it, const UpdateType& _type);
Jan Möbius's avatar
 
Jan Möbius committed
87

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

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

107 108
    void objectsGrouped(IdList);

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

Dirk Wilden's avatar
Dirk Wilden committed
118 119
    // KeyInterface
    void slotKeyEvent( QKeyEvent* _event );
Jan Möbius's avatar
 
Jan Möbius committed
120

Dirk Wilden's avatar
Dirk Wilden committed
121 122 123
    // INIInterface
    void loadIniFileOptionsLast( INIFile& _ini );
    void saveIniFileOptions( INIFile& _ini );
124
    void saveOnExit(INIFile& _ini );
Jan Möbius's avatar
 
Jan Möbius committed
125

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

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

134 135
    void slotObjectsGrouped(IdList _lst);

Dirk Wilden's avatar
Dirk Wilden committed
136
  public :
Jan Möbius's avatar
Jan Möbius committed
137 138 139 140

    /// Constructor
    DataControlPlugin();

Dirk Wilden's avatar
Dirk Wilden committed
141 142
    /// Destructor
    ~DataControlPlugin() {};
Jan Möbius's avatar
 
Jan Möbius committed
143

Dirk Wilden's avatar
Dirk Wilden committed
144 145
    /// Name of the Plugin
    QString name(){ return (QString("DataControl")); };
Jan Möbius's avatar
 
Jan Möbius committed
146

Dirk Wilden's avatar
Dirk Wilden committed
147
    /// Description of the Plugin
Jan Möbius's avatar
Jan Möbius committed
148
    QString description() { return (QString(tr("Manages Data Objects"))); };
Jan Möbius's avatar
 
Jan Möbius committed
149

Dirk Wilden's avatar
Dirk Wilden committed
150 151 152
  private :
    /// Widget for Toolbox
    DatacontrolToolboxWidget* tool_;
Dirk Wilden's avatar
Dirk Wilden committed
153
    QIcon* toolIcon_;
Jan Möbius's avatar
 
Jan Möbius committed
154

Dirk Wilden's avatar
Dirk Wilden committed
155 156
    /// Layout for Toolbox
    QGridLayout* MeshDialogLayout_;
Jan Möbius's avatar
 
Jan Möbius committed
157

Dirk Wilden's avatar
Dirk Wilden committed
158 159
    /// Table containing Mesh information and status
    QTableWidget* objectList_;
Jan Möbius's avatar
 
Jan Möbius committed
160

Dirk Wilden's avatar
Dirk Wilden committed
161 162
    /// Flag set to true if meshlist is updated, preventing signal for list udate to be called
    bool locked;
Jan Möbius's avatar
 
Jan Möbius committed
163

Dirk Wilden's avatar
Dirk Wilden committed
164 165
    /// The Treemodel organizing the data
    TreeModel* model_;
Jan Möbius's avatar
 
Jan Möbius committed
166

Dirk Wilden's avatar
Dirk Wilden committed
167 168
    ///Tree view
    QTreeView* view_;
Jan Möbius's avatar
 
Jan Möbius committed
169

Dirk Wilden's avatar
Dirk Wilden committed
170 171
    /// Pointer to the header to the view widget
    QHeaderView * viewHeader_;
Jan Möbius's avatar
 
Jan Möbius committed
172

173 174 175
    /// Default marker to visualize "source" and "target" object flags
    DefaultObjectMarker objectMarker;

Dirk Wilden's avatar
Dirk Wilden committed
176

Dirk Wilden's avatar
Dirk Wilden committed
177 178 179 180
//===========================================================================
/** @name Slots which are called if data changed
* @{ */
//===========================================================================
Jan Möbius's avatar
 
Jan Möbius committed
181

Dirk Wilden's avatar
Dirk Wilden committed
182
  private slots:
Jan Möbius's avatar
 
Jan Möbius committed
183

Dirk Wilden's avatar
Dirk Wilden committed
184
    /// Gets called when the data in the table has changed
Dirk Wilden's avatar
Dirk Wilden committed
185
    void slotDataChanged (int _id, int _column, const QVariant& _value);
Jan Möbius's avatar
 
Jan Möbius committed
186

Dirk Wilden's avatar
Dirk Wilden committed
187 188
    /// Gets called when an object was moved via drag n drop
    void slotMoveBaseObject (int _id, int _newParentId);
Jan Möbius's avatar
 
Jan Möbius committed
189

Dirk Wilden's avatar
Dirk Wilden committed
190
  private:
Dirk Wilden's avatar
Dirk Wilden committed
191 192
    void propagateDownwards(BaseObject* _obj, int _column );
    void propagateUpwards(BaseObject* _obj, int _column );
Jan Möbius's avatar
 
Jan Möbius committed
193

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

Dirk Wilden's avatar
Dirk Wilden committed
201
/** @} */
Jan Möbius's avatar
 
Jan Möbius committed
202

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

Jan Möbius's avatar
 
Jan Möbius committed
211 212
        /// Called by the popup menu to remove an object/group
        void slotPopupRemove( );
Jan Möbius's avatar
 
Jan Möbius committed
213

Jan Möbius's avatar
 
Jan Möbius committed
214 215
        /// Called by the popup menu to ungroup items
        void slotUngroup ( );
Jan Möbius's avatar
 
Jan Möbius committed
216

Jan Möbius's avatar
 
Jan Möbius committed
217 218
        /// Called by the popup menu to group items
        void slotGroup ( );
Jan Möbius's avatar
 
Jan Möbius committed
219

220 221 222
        /// Called by the popup menu to copy items
        void slotCopy();

Jan Möbius's avatar
 
Jan Möbius committed
223 224
        ///Called by the popup menu to rename items
        void slotRename ( );
Dirk Wilden's avatar
Dirk Wilden committed
225 226 227

        ///Called by the popup menu to zoom to an object
        void slotZoomTo();
228 229 230
        
        /// Called by the popup menu in order to turn lights on/off
        void slotSwitchLight();
231 232 233
        
        /// Called by the popup menu in order to edit lights
        void slotEditLight();
Jan Möbius's avatar
 
Jan Möbius committed
234

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

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

241 242 243 244 245 246
        ///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();

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

Jan Möbius's avatar
 
Jan Möbius committed
257 258 259
      private :
        /// Index where a popup has been opened
        QModelIndex popupIndex_;
Jan Möbius's avatar
 
Jan Möbius committed
260

Jan Möbius's avatar
 
Jan Möbius committed
261
      private slots:
Jan Möbius's avatar
 
Jan Möbius committed
262

Jan Möbius's avatar
 
Jan Möbius committed
263 264
        /// Display a custom context window for the TreeViews header
        void slotHeaderCustomContextMenuRequested ( const QPoint & _pos );
Jan Möbius's avatar
 
Jan Möbius committed
265

Jan Möbius's avatar
 
Jan Möbius committed
266 267 268
      private:
        /// Defines the section of the Popup
        int headerPopupType_;
Jan Möbius's avatar
 
Jan Möbius committed
269

Dirk Wilden's avatar
Dirk Wilden committed
270
/** @} */
Jan Möbius's avatar
 
Jan Möbius committed
271

Dirk Wilden's avatar
Dirk Wilden committed
272 273 274 275
//===========================================================================
/** @name GL Area Context Menu related slots
* @{ */
//===========================================================================
Jan Möbius's avatar
 
Jan Möbius committed
276

Jan Möbius's avatar
 
Jan Möbius committed
277
      private slots:
Jan Möbius's avatar
 
Jan Möbius committed
278

Jan Möbius's avatar
 
Jan Möbius committed
279 280
        /// Hide an object
        void slotContextMenuHide( );
Jan Möbius's avatar
 
Jan Möbius committed
281

Jan Möbius's avatar
 
Jan Möbius committed
282 283
        /// Target Selection
        void slotContextMenuTarget( );
Jan Möbius's avatar
 
Jan Möbius committed
284

Jan Möbius's avatar
 
Jan Möbius committed
285 286
        /// Source Selection
        void slotContextMenuSource( );
Dirk Wilden's avatar
 
Dirk Wilden committed
287 288 289
        
        /// Remove Selected Item
        void slotContextMenuRemove( );
Jan Möbius's avatar
 
Jan Möbius committed
290

Jan Möbius's avatar
 
Jan Möbius committed
291 292
        /// Update the context Menus for the given id
        void slotUpdateContextMenu( int _objectId);
Jan Möbius's avatar
 
Jan Möbius committed
293

Jan Möbius's avatar
 
Jan Möbius committed
294 295 296
      private :
        QAction* targetAction_;
        QAction* sourceAction_;
Dirk Wilden's avatar
 
Dirk Wilden committed
297
        QAction* removeAction_;
Jan Möbius's avatar
 
Jan Möbius committed
298

299 300
        QToolButton *advancedSettingsBtn_;

Dirk Wilden's avatar
Dirk Wilden committed
301
/** @} */
Jan Möbius's avatar
 
Jan Möbius committed
302

303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
//===========================================================================
/** @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
320 321 322 323
//===========================================================================
/** @name Scripting functions
* @{ */
//===========================================================================
Jan Möbius's avatar
 
Jan Möbius committed
324

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

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

Jan Möbius's avatar
 
Jan Möbius committed
332 333 334
      public slots:
        /// Get the Objects name from the id
        QString getObjectName( int objectId );
Jan Möbius's avatar
 
Jan Möbius committed
335

336
        /// Delete the given object
337
        void objectDelete(int objectId);
338

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

Jan Möbius's avatar
 
Jan Möbius committed
342 343
        /// Get the id of an object by its name
        int getObject( QString _name );
Jan Möbius's avatar
 
Jan Möbius committed
344

345 346 347
        /// Get the DataType of a given object
        DataType dataType( int objectId );

Jan Möbius's avatar
 
Jan Möbius committed
348 349
        /// Hide the given Object
        void hideObject( int objectId );
Jan Möbius's avatar
 
Jan Möbius committed
350

Jan Möbius's avatar
 
Jan Möbius committed
351
        /// Show the given Object
Jan Möbius's avatar
 
Jan Möbius committed
352 353
        void showObject( int objectId );

Dirk Wilden's avatar
Dirk Wilden committed
354 355 356 357 358 359 360 361 362
        /// 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 );

Jan Möbius's avatar
 
Jan Möbius committed
363 364
        /// Makes all available objects target
        void setAllTarget();
Jan Möbius's avatar
 
Jan Möbius committed
365

Jan Möbius's avatar
 
Jan Möbius committed
366 367
        /// Makes all available objects source
        void setAllSource();
Jan Möbius's avatar
 
Jan Möbius committed
368

Jan Möbius's avatar
 
Jan Möbius committed
369 370
        /// Unselect all objects
        void clearAllTarget();
Jan Möbius's avatar
 
Jan Möbius committed
371

Jan Möbius's avatar
 
Jan Möbius committed
372 373
        /// remove source selection from all objects
        void clearAllSource();
Jan Möbius's avatar
 
Jan Möbius committed
374

Jan Möbius's avatar
 
Jan Möbius committed
375 376
        /// Shows all objects
        void showAll();
Jan Möbius's avatar
 
Jan Möbius committed
377

Jan Möbius's avatar
 
Jan Möbius committed
378 379
        /// Hides all objects
        void hideAll();
Jan Möbius's avatar
 
Jan Möbius committed
380

381 382 383 384 385 386 387 388 389 390 391
		/** 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);

392 393 394 395
        /** Group objects together
        *
        * @return object id of new group or -1 if failed
        */
Jan Möbius's avatar
Jan Möbius committed
396
        int groupObjects(IdList _objectIDs, QString _groupName = "");
397
        
398
        /// add an object to an existing group
Matthias Möller's avatar
Matthias Möller committed
399
        bool addObjectToGroup(int _objectId, int _groupId);
400

401 402 403 404 405
        /** remove an object from its group and place it at the toplevel group
        *
        * @return successfull
        */
        bool unGroupObject(int _id);
406 407 408 409 410 411
        
        /// 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
412

413 414 415
        /// Returns the number of groups
        unsigned int groupCount() const;

416 417 418
        /// Returns a list of all available DataTypes
        QStringList availableDataTypeNames() const;

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

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

Jan Möbius's avatar
Jan Möbius committed
425 426
        void showReducedUi(bool reduced);

Dirk Wilden's avatar
Dirk Wilden committed
427
/** @} */
Jan Möbius's avatar
 
Jan Möbius committed
428 429

  public slots:
Dirk Wilden's avatar
Dirk Wilden committed
430
    QString version() { return QString("1.03"); };
Jan Möbius's avatar
 
Jan Möbius committed
431 432
};

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