DataControlPlugin.hh 14.3 KB
Newer Older
1
/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
2 3
*                                                                            *
*                              OpenFlipper                                   *
Jan Möbius's avatar
Jan Möbius committed
4
*      Copyright (C) 2001-2014 by Computer Graphics Group, RWTH Aachen       *
Jan Möbius's avatar
Jan Möbius committed
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
*                           www.openflipper.org                              *
*                                                                            *
*--------------------------------------------------------------------------- *
*  This file is part of OpenFlipper.                                         *
*                                                                            *
*  OpenFlipper is free software: you can redistribute it and/or modify       *
*  it under the terms of the GNU Lesser General Public License as            *
*  published by the Free Software Foundation, either version 3 of            *
*  the License, or (at your option) any later version with the               *
*  following exceptions:                                                     *
*                                                                            *
*  If other files instantiate templates or use macros                        *
*  or inline functions from this file, or you compile this file and          *
*  link it with other files to produce an executable, this file does         *
*  not by itself cause the resulting executable to be covered by the         *
*  GNU Lesser General Public License. This exception does not however        *
*  invalidate any other reasons why the executable file might be             *
*  covered by the GNU Lesser General Public License.                         *
*                                                                            *
*  OpenFlipper is distributed in the hope that it will be useful,            *
*  but WITHOUT ANY WARRANTY; without even the implied warranty of            *
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the             *
*  GNU Lesser General Public License for more details.                       *
*                                                                            *
*  You should have received a copy of the GNU LesserGeneral Public           *
*  License along with OpenFlipper. If not,                                   *
*  see <http://www.gnu.org/licenses/>.                                       *
*                                                                            *
33 34 35
\*===========================================================================*/

/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
36 37 38 39 40
*                                                                            *
*   $Revision$                                                       *
*   $LastChangedBy$                                                *
*   $Date$                     *
*                                                                            *
41
\*===========================================================================*/
Jan Möbius's avatar
 
Jan Möbius committed
42 43 44 45




Dirk Wilden's avatar
Dirk Wilden committed
46 47
#ifndef DATACONTROLPLUGIN_HH
#define DATACONTROLPLUGIN_HH
Jan Möbius's avatar
 
Jan Möbius committed
48 49 50 51 52 53 54 55 56


#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
57
#include <OpenFlipper/BasePlugin/LoadSaveInterface.hh>
Jan Möbius's avatar
 
Jan Möbius committed
58
#include <OpenFlipper/common/Types.hh>
59
#include <ObjectTypes/Light/Light.hh>
60
#include "Toolbox.hh"
Jan Möbius's avatar
 
Jan Möbius committed
61 62

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


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

Matthias Möller's avatar
Matthias Möller committed
80 81 82 83
#if QT_VERSION >= 0x050000
  Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-DataControl")
#endif

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

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

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

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

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

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

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

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

Dirk Wilden's avatar
Dirk Wilden committed
133
  public :
Jan Möbius's avatar
Jan Möbius committed
134 135 136 137

    /// Constructor
    DataControlPlugin();

Dirk Wilden's avatar
Dirk Wilden committed
138 139
    /// Destructor
    ~DataControlPlugin() {};
Jan Möbius's avatar
 
Jan Möbius committed
140

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

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

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

Dirk Wilden's avatar
Dirk Wilden committed
152 153
    /// Layout for Toolbox
    QGridLayout* MeshDialogLayout_;
Jan Möbius's avatar
 
Jan Möbius committed
154

Dirk Wilden's avatar
Dirk Wilden committed
155 156
    /// Table containing Mesh information and status
    QTableWidget* objectList_;
Jan Möbius's avatar
 
Jan Möbius committed
157

Dirk Wilden's avatar
Dirk Wilden committed
158 159
    /// 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
160

Dirk Wilden's avatar
Dirk Wilden committed
161 162
    /// The Treemodel organizing the data
    TreeModel* model_;
Jan Möbius's avatar
 
Jan Möbius committed
163

Dirk Wilden's avatar
Dirk Wilden committed
164 165
    ///Tree view
    QTreeView* view_;
Jan Möbius's avatar
 
Jan Möbius committed
166

Dirk Wilden's avatar
Dirk Wilden committed
167 168
    /// Pointer to the header to the view widget
    QHeaderView * viewHeader_;
Jan Möbius's avatar
 
Jan Möbius committed
169

170 171 172
    /// Default marker to visualize "source" and "target" object flags
    DefaultObjectMarker objectMarker;

Dirk Wilden's avatar
Dirk Wilden committed
173

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

Dirk Wilden's avatar
Dirk Wilden committed
179
  private slots:
Jan Möbius's avatar
 
Jan Möbius committed
180

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

Dirk Wilden's avatar
Dirk Wilden committed
184 185
    /// 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
186

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

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

Dirk Wilden's avatar
Dirk Wilden committed
198
/** @} */
Jan Möbius's avatar
 
Jan Möbius committed
199

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

Jan Möbius's avatar
 
Jan Möbius committed
208 209
        /// Called by the popup menu to remove an object/group
        void slotPopupRemove( );
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 ungroup items
        void slotUngroup ( );
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 group items
        void slotGroup ( );
Jan Möbius's avatar
 
Jan Möbius committed
216

217 218 219
        /// Called by the popup menu to copy items
        void slotCopy();

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

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

Dirk Wilden's avatar
Dirk Wilden committed
232 233 234
        ///Called by the popup menu to set material properties
        void slotMaterialProperties();

235 236 237
        ///Called by the popup menu to copy material properties
        void slotCopyMaterialToTargeted();

238 239 240 241 242 243
        ///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
244 245 246 247
        /** \brief Called when the material properties were changed inside the material dialog
         *
         * @param _node unused
         */
Dirk Wilden's avatar
Dirk Wilden committed
248
        void slotNodeChanged( ACG::SceneGraph::BaseNode* _node );
249 250 251
        
        /// Hide/Show all light sources if checkbox has been checked
        void slotShowLightSources( int _state );
252
        void slotShowLightSources();
Dirk Wilden's avatar
Dirk Wilden committed
253

Jan Möbius's avatar
 
Jan Möbius committed
254 255 256
      private :
        /// Index where a popup has been opened
        QModelIndex popupIndex_;
Jan Möbius's avatar
 
Jan Möbius committed
257

Jan Möbius's avatar
 
Jan Möbius committed
258
      private slots:
Jan Möbius's avatar
 
Jan Möbius committed
259

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

Jan Möbius's avatar
 
Jan Möbius committed
263 264 265
      private:
        /// Defines the section of the Popup
        int headerPopupType_;
Jan Möbius's avatar
 
Jan Möbius committed
266

Dirk Wilden's avatar
Dirk Wilden committed
267
/** @} */
Jan Möbius's avatar
 
Jan Möbius committed
268

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

Jan Möbius's avatar
 
Jan Möbius committed
274
      private slots:
Jan Möbius's avatar
 
Jan Möbius committed
275

Jan Möbius's avatar
 
Jan Möbius committed
276 277
        /// Hide an object
        void slotContextMenuHide( );
Jan Möbius's avatar
 
Jan Möbius committed
278

Jan Möbius's avatar
 
Jan Möbius committed
279 280
        /// Target Selection
        void slotContextMenuTarget( );
Jan Möbius's avatar
 
Jan Möbius committed
281

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

Jan Möbius's avatar
 
Jan Möbius committed
288 289
        /// Update the context Menus for the given id
        void slotUpdateContextMenu( int _objectId);
Jan Möbius's avatar
 
Jan Möbius committed
290

Jan Möbius's avatar
 
Jan Möbius committed
291 292 293
      private :
        QAction* targetAction_;
        QAction* sourceAction_;
Dirk Wilden's avatar
 
Dirk Wilden committed
294
        QAction* removeAction_;
Jan Möbius's avatar
 
Jan Möbius committed
295

Dirk Wilden's avatar
Dirk Wilden committed
296
/** @} */
Jan Möbius's avatar
 
Jan Möbius committed
297

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

Dirk Wilden's avatar
Dirk Wilden committed
320
      private slots:
Jan Möbius's avatar
Jan Möbius committed
321 322 323 324

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

Jan Möbius's avatar
 
Jan Möbius committed
327 328 329
      public slots:
        /// Get the Objects name from the id
        QString getObjectName( int objectId );
Jan Möbius's avatar
 
Jan Möbius committed
330

331
        /// Delete the given object
332
        void objectDelete(int objectId);
333

Jan Möbius's avatar
Jan Möbius committed
334 335 336
        /// Creates an object copy
        int copyObject( int objectId );

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

340 341 342
        /// Get the DataType of a given object
        DataType dataType( int objectId );

Jan Möbius's avatar
 
Jan Möbius committed
343 344
        /// Hide the given Object
        void hideObject( int objectId );
Jan Möbius's avatar
 
Jan Möbius committed
345

Jan Möbius's avatar
 
Jan Möbius committed
346
        /// Show the given Object
Jan Möbius's avatar
 
Jan Möbius committed
347 348
        void showObject( int objectId );

Dirk Wilden's avatar
Dirk Wilden committed
349 350 351 352 353 354 355 356 357
        /// 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
358 359
        /// Makes all available objects target
        void setAllTarget();
Jan Möbius's avatar
 
Jan Möbius committed
360

Jan Möbius's avatar
 
Jan Möbius committed
361 362
        /// Makes all available objects source
        void setAllSource();
Jan Möbius's avatar
 
Jan Möbius committed
363

Jan Möbius's avatar
 
Jan Möbius committed
364 365
        /// Unselect all objects
        void clearAllTarget();
Jan Möbius's avatar
 
Jan Möbius committed
366

Jan Möbius's avatar
 
Jan Möbius committed
367 368
        /// remove source selection from all objects
        void clearAllSource();
Jan Möbius's avatar
 
Jan Möbius committed
369

Jan Möbius's avatar
 
Jan Möbius committed
370 371
        /// Shows all objects
        void showAll();
Jan Möbius's avatar
 
Jan Möbius committed
372

Jan Möbius's avatar
 
Jan Möbius committed
373 374
        /// Hides all objects
        void hideAll();
Jan Möbius's avatar
 
Jan Möbius committed
375

376 377 378 379 380 381 382 383 384 385 386
		/** 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);

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

396 397 398 399 400
        /** remove an object from its group and place it at the toplevel group
        *
        * @return successfull
        */
        bool unGroupObject(int _id);
401 402 403 404 405 406
        
        /// 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
407

408 409 410
        /// Returns the number of groups
        unsigned int groupCount() const;

411 412 413
        /// Returns a list of all available DataTypes
        QStringList availableDataTypeNames() const;

414 415 416
        /// Print information about all open objects to the console
        void printObjectInfoToLog();

417 418 419
        /// Get all elements of the given group
        IdList getGroupElements(int _groupId);

Jan Möbius's avatar
Jan Möbius committed
420 421
        void showReducedUi(bool reduced);

Dirk Wilden's avatar
Dirk Wilden committed
422
/** @} */
Jan Möbius's avatar
 
Jan Möbius committed
423 424

  public slots:
Dirk Wilden's avatar
Dirk Wilden committed
425
    QString version() { return QString("1.03"); };
Jan Möbius's avatar
 
Jan Möbius committed
426 427
};

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