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

/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
43 44 45 46 47
*                                                                            *
*   $Revision$                                                       *
*   $LastChangedBy$                                                *
*   $Date$                     *
*                                                                            *
48
\*===========================================================================*/
49 50 51 52




Dirk Wilden's avatar
Dirk Wilden committed
53 54
#ifndef DATACONTROLPLUGIN_HH
#define DATACONTROLPLUGIN_HH
55 56 57 58 59 60 61 62 63


#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
64
#include <OpenFlipper/BasePlugin/LoadSaveInterface.hh>
65
#include <OpenFlipper/common/Types.hh>
66
#include <ObjectTypes/Light/Light.hh>
67
#include "Toolbox.hh"
68 69

#include "TreeModel.hh"
70
#include "DefaultObjectMarker.hh"
71 72


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

87 88
  Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-DataControl")

89
  signals:
Dirk Wilden's avatar
Dirk Wilden committed
90
    // BaseInterface
91
    void updateView();
92
    void updatedObject(int _it, const UpdateType& _type);
93

Dirk Wilden's avatar
Dirk Wilden committed
94 95 96 97
    void setSlotDescription(QString     _slotName,   QString     _slotDescription,
                            QStringList _parameters, QStringList _descriptions);

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

113 114
    void objectsGrouped(IdList);

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

Dirk Wilden's avatar
Dirk Wilden committed
124 125
    // KeyInterface
    void slotKeyEvent( QKeyEvent* _event );
126

Dirk Wilden's avatar
Dirk Wilden committed
127 128 129
    // INIInterface
    void loadIniFileOptionsLast( INIFile& _ini );
    void saveIniFileOptions( INIFile& _ini );
130
    void saveOnExit(INIFile& _ini );
131

Dirk Wilden's avatar
Dirk Wilden committed
132 133 134
    // LoadSaveInterface
    void fileOpened(int _id);
    void addedEmptyObject(int _id);
135
    void objectDeleted(int _id);
Dirk Wilden's avatar
Dirk Wilden committed
136

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

140 141
    void slotObjectsGrouped(IdList _lst);

Dirk Wilden's avatar
Dirk Wilden committed
142
  public :
Jan Möbius's avatar
Jan Möbius committed
143 144 145 146

    /// Constructor
    DataControlPlugin();

Dirk Wilden's avatar
Dirk Wilden committed
147 148
    /// Destructor
    ~DataControlPlugin() {};
149

Dirk Wilden's avatar
Dirk Wilden committed
150 151
    /// Name of the Plugin
    QString name(){ return (QString("DataControl")); };
152

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

Dirk Wilden's avatar
Dirk Wilden committed
156 157 158
  private :
    /// Widget for Toolbox
    DatacontrolToolboxWidget* tool_;
159
    QIcon* toolIcon_;
160

Dirk Wilden's avatar
Dirk Wilden committed
161 162
    /// Layout for Toolbox
    QGridLayout* MeshDialogLayout_;
163

Dirk Wilden's avatar
Dirk Wilden committed
164 165
    /// Table containing Mesh information and status
    QTableWidget* objectList_;
166

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

Dirk Wilden's avatar
Dirk Wilden committed
170 171
    /// The Treemodel organizing the data
    TreeModel* model_;
172

Dirk Wilden's avatar
Dirk Wilden committed
173 174
    ///Tree view
    QTreeView* view_;
175

Dirk Wilden's avatar
Dirk Wilden committed
176 177
    /// Pointer to the header to the view widget
    QHeaderView * viewHeader_;
178

179 180 181
    /// Default marker to visualize "source" and "target" object flags
    DefaultObjectMarker objectMarker;

Dirk Wilden's avatar
Dirk Wilden committed
182

Dirk Wilden's avatar
Dirk Wilden committed
183 184 185 186
//===========================================================================
/** @name Slots which are called if data changed
* @{ */
//===========================================================================
187

Dirk Wilden's avatar
Dirk Wilden committed
188
  private slots:
189

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

193 194
    /// Gets called when an object was moved via drag n drop
    void slotMoveBaseObject (int _id, int _newParentId);
195

Dirk Wilden's avatar
Dirk Wilden committed
196
  private:
197 198
    void propagateDownwards(BaseObject* _obj, int _column );
    void propagateUpwards(BaseObject* _obj, int _column );
199

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

Dirk Wilden's avatar
Dirk Wilden committed
207
/** @} */
208

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

217 218
        /// Called by the popup menu to remove an object/group
        void slotPopupRemove( );
219

220 221
        /// Called by the popup menu to ungroup items
        void slotUngroup ( );
222

223 224
        /// Called by the popup menu to group items
        void slotGroup ( );
225

226 227 228
        /// Called by the popup menu to copy items
        void slotCopy();

229 230
        ///Called by the popup menu to rename items
        void slotRename ( );
Dirk Wilden's avatar
Dirk Wilden committed
231 232 233

        ///Called by the popup menu to zoom to an object
        void slotZoomTo();
234 235 236
        
        /// Called by the popup menu in order to turn lights on/off
        void slotSwitchLight();
237 238 239
        
        /// Called by the popup menu in order to edit lights
        void slotEditLight();
240

Dirk Wilden's avatar
Dirk Wilden committed
241 242 243
        ///Called by the popup menu to set material properties
        void slotMaterialProperties();

244 245 246
        ///Called by the popup menu to copy material properties
        void slotCopyMaterialToTargeted();

247 248 249 250 251 252
        ///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();

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

263 264 265
      private :
        /// Index where a popup has been opened
        QModelIndex popupIndex_;
266

267
      private slots:
268

269 270
        /// Display a custom context window for the TreeViews header
        void slotHeaderCustomContextMenuRequested ( const QPoint & _pos );
271

272 273 274
      private:
        /// Defines the section of the Popup
        int headerPopupType_;
275

Dirk Wilden's avatar
Dirk Wilden committed
276
/** @} */
277

Dirk Wilden's avatar
Dirk Wilden committed
278 279 280 281
//===========================================================================
/** @name GL Area Context Menu related slots
* @{ */
//===========================================================================
282

283
      private slots:
284

285 286
        /// Hide an object
        void slotContextMenuHide( );
287

288 289
        /// Target Selection
        void slotContextMenuTarget( );
290

291 292
        /// Source Selection
        void slotContextMenuSource( );
293 294 295
        
        /// Remove Selected Item
        void slotContextMenuRemove( );
296

297 298
        /// Update the context Menus for the given id
        void slotUpdateContextMenu( int _objectId);
299

300 301 302
      private :
        QAction* targetAction_;
        QAction* sourceAction_;
303
        QAction* removeAction_;
304

305 306
        QToolButton *advancedSettingsBtn_;

Dirk Wilden's avatar
Dirk Wilden committed
307
/** @} */
308

309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
//===========================================================================
/** @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
326 327 328 329
//===========================================================================
/** @name Scripting functions
* @{ */
//===========================================================================
330

Dirk Wilden's avatar
Dirk Wilden committed
331
      private slots:
Jan Möbius's avatar
Jan Möbius committed
332 333 334 335

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

338 339 340
      public slots:
        /// Get the Objects name from the id
        QString getObjectName( int objectId );
341

342
        /// Delete the given object
343
        void objectDelete(int objectId);
344

Jan Möbius's avatar
Jan Möbius committed
345 346 347
        /// Creates an object copy
        int copyObject( int objectId );

348 349
        /// Get the id of an object by its name
        int getObject( QString _name );
350

351 352 353
        /// Get the DataType of a given object
        DataType dataType( int objectId );

354 355
        /// Hide the given Object
        void hideObject( int objectId );
356

357
        /// Show the given Object
358 359
        void showObject( int objectId );

Dirk Wilden's avatar
Dirk Wilden committed
360 361 362 363 364 365 366 367 368
        /// 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 );

369 370
        /// Makes all available objects target
        void setAllTarget();
371

372 373
        /// Makes all available objects source
        void setAllSource();
374

375 376
        /// Unselect all objects
        void clearAllTarget();
377

378 379
        /// remove source selection from all objects
        void clearAllSource();
380

381 382
        /// Shows all objects
        void showAll();
383

384 385
        /// Hides all objects
        void hideAll();
386

387 388 389 390 391 392 393 394 395 396 397
		/** 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);

398 399 400 401
        /** Group objects together
        *
        * @return object id of new group or -1 if failed
        */
Jan Möbius's avatar
Jan Möbius committed
402
        int groupObjects(IdList _objectIDs, QString _groupName = "");
403
        
404
        /// add an object to an existing group
405
        bool addObjectToGroup(int _objectId, int _groupId);
406

407 408 409 410 411
        /** remove an object from its group and place it at the toplevel group
        *
        * @return successfull
        */
        bool unGroupObject(int _id);
412 413 414 415 416 417
        
        /// 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
418

419 420 421
        /// Returns the number of groups
        unsigned int groupCount() const;

422 423 424
        /// Returns a list of all available DataTypes
        QStringList availableDataTypeNames() const;

425 426 427
        /// Print information about all open objects to the console
        void printObjectInfoToLog();

428 429 430
        /// Get all elements of the given group
        IdList getGroupElements(int _groupId);

Jan Möbius's avatar
Jan Möbius committed
431 432
        void showReducedUi(bool reduced);

Dirk Wilden's avatar
Dirk Wilden committed
433
/** @} */
434 435

  public slots:
Dirk Wilden's avatar
Dirk Wilden committed
436
    QString version() { return QString("1.03"); };
437 438
};

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