PluginCommunication.cc 20.6 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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62




//=============================================================================
//
//  CLASS Core - IMPLEMENTATION of Comunication with plugins
//
//=============================================================================


//== INCLUDES =================================================================

#include "Core.hh"

#include <QToolBox>

#include "OpenFlipper/BasePlugin/BaseInterface.hh"
#include "OpenFlipper/BasePlugin/ToolboxInterface.hh"
#include "OpenFlipper/BasePlugin/TextureInterface.hh"

63
#include "OpenFlipper/BasePlugin/PluginFunctionsCore.hh"
64

65
66
#include <OpenFlipper/common/RendererInfo.hh>

67
68
#include <stdexcept>

Jan Möbius's avatar
Jan Möbius committed
69
//== IMPLEMENTATION ==========================================================
Jan Möbius's avatar
 
Jan Möbius committed
70
71
72

//========================================================================================
// ===             Object List Communication                       =======================
Jan Möbius's avatar
Jan Möbius committed
73
74
//========================================================================================

Jan Möbius's avatar
Jan Möbius committed
75
76
77
78
79
/** \brief Handle object updates by plugins
 *
 * This function is called by a plugin if it changed something in the object list (source,target, or other properties ).
 * The information is passed to all plugins.
 *
Jan Möbius's avatar
 
Jan Möbius committed
80
 * @param _identifier Id of the updated object
81
 * @param _type       What part of the object has been updated
Jan Möbius's avatar
 
Jan Möbius committed
82
 */
83
void Core::slotObjectUpdated(int _identifier, const UpdateType& _type) {
Jan Möbius's avatar
Jan Möbius committed
84
85
86
  if ( OpenFlipper::Options::doSlotDebugging() ) {
    if ( sender() != 0 ) {
      if ( sender()->metaObject() != 0 ) {
Dirk Wilden's avatar
Dirk Wilden committed
87
88
        emit log(LOGINFO,"updatedObject( " + QString::number(_identifier) + ", " + updateTypeName(_type)
                 + tr(" ) called by ") + QString( sender()->metaObject()->className() ) );
Jan Möbius's avatar
Jan Möbius committed
89
      }
90
    } else {
Dirk Wilden's avatar
Dirk Wilden committed
91
      emit log(LOGINFO,"updatedObject( " + QString::number(_identifier) + ", " + updateTypeName(_type) + tr(" ) called by Core") );
Jan Möbius's avatar
Jan Möbius committed
92
93
94
    }
  }

95
96
97
  // Disable redraws as everything here has to update the object only once
  OpenFlipper::Options::redrawDisabled(true);

98
  // If we are called for a special object, we update it ourself so the Plugins dont need to do that.
99
  BaseObject* object = 0;
100
  if ( _identifier != -1 ) {
Jan Möbius's avatar
   
Jan Möbius committed
101
    if ( !PluginFunctions::getObject(_identifier,object) ) {
102
      emit log(LOGERR,tr("updated_objects called for non existing object with id : ") + QString::number(_identifier) );
103
104
105
106
      return;
    }
  }

107

108
109
110
  // If the identifier is -1 we force an update of all objects in the scene (Bad idea for scenes with many objects)
  if ( _identifier == -1 ) {

111
112
113
114
115
116
117
118
    if ( sender() != 0 ) {
      if ( sender()->metaObject() != 0 ) {
        emit log(LOGWARN,"updatedObject( " + QString::number(_identifier) + ", " + updateTypeName(_type)
            + tr(" ) called by ") + QString( sender()->metaObject()->className() + tr(" which is inefficient)") ) );
      }
    } else {
      emit log(LOGWARN,"updatedObject( " + QString::number(_identifier) + ", " + updateTypeName(_type) + tr(" ) called by Core, which is inefficient!") );
    }
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

    for ( PluginFunctions::ObjectIterator o_it(PluginFunctions::ALL_OBJECTS,DATA_ALL ) ;  o_it != PluginFunctions::objectsEnd(); ++o_it) {

      // just inform the plugins as we don't do anything else (Do deprecated and new updatedObjects here)
      emit signalObjectUpdated(o_it->id());
      emit signalObjectUpdated(o_it->id(), _type);

      // Call the objects update function
      o_it->update();

    }
  } else {
    // just inform the plugins as we don't do anything else (Do deprecated and new updatedObjects here)
    emit signalObjectUpdated(_identifier);
    emit signalObjectUpdated(_identifier, _type);
  }


  // If we have an single object, call it's update function
138
  if ( object != 0 )
Dirk Wilden's avatar
Dirk Wilden committed
139
    object->update(_type);
140
141
142
143

  // Reenable redraws
  OpenFlipper::Options::redrawDisabled(false);

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

145
146
  // Reset scenegraph but keep scene center!
  resetScenegraph(false);
147

148
  updateView();
Jan Möbius's avatar
Jan Möbius committed
149
150
}

151
void Core::slotVisibilityChanged( int _id ) {
152

153
154
  // tell plugins
  emit visibilityChanged( _id );
155

156
157
158
  // Reset scenegraph but keep scene center!
  resetScenegraph(false);
  
159
  updateView();
160
161
162
163
164
165
}

/** This function is called if the active object has changed. The information is passed to all plugins.
*/
void Core::slotObjectSelectionChanged( int _id )
{
166
  // just inform the plugins as we don't do anything else
167
168
  emit objectSelectionChanged(_id);

169
  // Send via second interface
Jan Möbius's avatar
Jan Möbius committed
170
  emit signalObjectUpdated(_id,UPDATE_STATE);
171

172
  updateView();
173
}
Jan Möbius's avatar
 
Jan Möbius committed
174

Jan Möbius's avatar
Jan Möbius committed
175
176
177
178
179
void Core::slotObjectPropertiesChanged( int _id )
{
  emit objectPropertiesChanged(_id);
}

Jan Möbius's avatar
 
Jan Möbius committed
180
181
182
183
184
//========================================================================================
// ===             Texture Communication                       ===========================
//========================================================================================


Dirk Wilden's avatar
Dirk Wilden committed
185
186
187
188
/** Called by a plugin if it created a texture. The information is passed to all plugins. If a texture control plugin is available it has to react on the signal.\n
 * See in the documentation of the texture plugin interfaces for further detail.
*/
void Core::slotAddTexture( QString _textureName , QString _filename, uint _dimension, int _id) {
Jan Möbius's avatar
Jan Möbius committed
189
190
191
192
193
194
195
196
197
198
199
  if ( OpenFlipper::Options::doSlotDebugging() ) {
    if ( sender() != 0 ) {
      if ( sender()->metaObject() != 0 ) {
        emit log(LOGINFO,"addTexture( " + _textureName + "," + _filename + ","  +  QString::number(_dimension) + ", " + QString::number(_id) +  tr(" ) called by ") +
        QString( sender()->metaObject()->className() ) );
      }
    } else {
      emit log(LOGINFO,"addTexture( " + _textureName + "," + _filename + "," +  QString::number(_dimension) + ", " + QString::number(_id) +  tr(" ) called by Core") );
    }
  }
  
Dirk Wilden's avatar
Dirk Wilden committed
200
201
202
  emit addTexture(_textureName , _filename,_dimension,_id);
}

Jan Möbius's avatar
 
Jan Möbius committed
203
204
205
206
/** Called by a plugin if it created a texture. The information is passed to all plugins. If a texture control plugin is available it has to react on the signal.\n
 * See in the documentation of the texture plugin interfaces for further detail.
*/
void Core::slotAddTexture( QString _textureName , QString _filename, uint _dimension) {
Jan Möbius's avatar
Jan Möbius committed
207
208
209
210
211
212
213
214
215
216
217
218
  
  if ( OpenFlipper::Options::doSlotDebugging() ) {
    if ( sender() != 0 ) {
      if ( sender()->metaObject() != 0 ) {
        emit log(LOGINFO,"slotAddTexture( " + _textureName + "," + _filename + ","  +  QString::number(_dimension)  +  tr(" ) called by ") +
        QString( sender()->metaObject()->className() ) );
      }
    } else {
      emit log(LOGINFO,"slotAddTexture( " + _textureName + "," + _filename + "," +", " +  QString::number(_dimension) + tr(" ) called by Core") );
    }
  }
  
Jan Möbius's avatar
Jan Möbius committed
219
  emit addTexture(_textureName , _filename,_dimension);
Jan Möbius's avatar
 
Jan Möbius committed
220
221
222
223
224
225
}

/** Called by a plugin if a texture has to be updated. The information is passed to all plugins. The Plugin providing the given Texture should react on this event.\n
 * See in the documentation of the texture plugin interfaces for further detail.
*/
void Core::slotUpdateTexture( QString _name , int _identifier){
226
227
228
229

  if ( OpenFlipper::Options::doSlotDebugging() ) {
    if ( sender() != 0 ) {
      if ( sender()->metaObject() != 0 ) {
230
        emit log(LOGINFO,"slotUpdateTexture( "  + _name + " , " + QString::number(_identifier) + tr(" ) called by ") +
231
232
233
234
235
                 QString( sender()->metaObject()->className() ) );
      }
    }
  }

Jan Möbius's avatar
Jan Möbius committed
236
  emit updateTexture(_name, _identifier);
Jan Möbius's avatar
 
Jan Möbius committed
237
238
}

239
240

void Core::slotMultiTextureAdded( QString _textureGroup , QString _name , QString _filename , int _id , int& _textureId ) {
Jan Möbius's avatar
Jan Möbius committed
241
242
243
244
245
246
247
248
249
250
251
252
  
  if ( OpenFlipper::Options::doSlotDebugging() ) {
    if ( sender() != 0 ) {
      if ( sender()->metaObject() != 0 ) {
        emit log(LOGINFO,"slotMultiTextureAdded( " + _textureGroup + ", " + _name + "," + _filename + ","  + QString::number(_id) + tr(" ) called by ") +
        QString( sender()->metaObject()->className() ) );
      }
    } else {
      emit log(LOGINFO,"slotMultiTextureAdded( " + _textureGroup + ", " + _name + "," + _filename + ","  + QString::number(_id) + tr(" ) called by Core") );
    }
  }
  
253
254
255
  emit addMultiTexture( _textureGroup , _name , _filename , _id , _textureId  );
}

Jan Möbius's avatar
 
Jan Möbius committed
256
257
258
259
/** Called by a plugin if all textures should be updated. The information is passed to all plugins. All plugins providing textures should react on this event.\n
 * See in the documentation of the texture plugin interfaces for further detail.
*/
void Core::slotUpdateAllTextures( ){
Jan Möbius's avatar
Jan Möbius committed
260
  emit updateAllTextures();
Jan Möbius's avatar
 
Jan Möbius committed
261
262
}

Dirk Wilden's avatar
Dirk Wilden committed
263
264
265
266
267
268
269
270
/** Called by a plugin if the parameters of a texture should be changed. The information is passed to all plugins. A Texturecontrol plugin should react on this event.\n
 * See in the documentation of the texture plugin interfaces for further detail.
*/
void Core::slotSetTextureMode(QString _textureName, QString _mode, int _id) {

  if ( OpenFlipper::Options::doSlotDebugging() ) {
    if ( sender() != 0 ) {
      if ( sender()->metaObject() != 0 ) {
271
        emit log(LOGINFO,"slotSetTextureMode( " + _textureName + " , " + _mode + " , " + QString::number(_id) + tr(" ) called by ") +
Dirk Wilden's avatar
Dirk Wilden committed
272
273
274
275
276
277
278
279
                 QString( sender()->metaObject()->className() ) );
      }
    }
  }

  emit setTextureMode(_textureName,_mode,_id);
}

Jan Möbius's avatar
 
Jan Möbius committed
280
281
282
283
/** Called by a plugin if the parameters of a texture should be changed. The information is passed to all plugins. A Texturecontrol plugin should react on this event.\n
 * See in the documentation of the texture plugin interfaces for further detail.
*/
void Core::slotSetTextureMode(QString _textureName ,QString _mode) {
284
285
286
287

  if ( OpenFlipper::Options::doSlotDebugging() ) {
    if ( sender() != 0 ) {
      if ( sender()->metaObject() != 0 ) {
288
        emit log(LOGINFO,"slotSetTextureMode( " + _textureName + " , " + _mode + tr(" ) called by ") +
289
290
291
292
293
                 QString( sender()->metaObject()->className() ) );
      }
    }
  }

Jan Möbius's avatar
Jan Möbius committed
294
  emit setTextureMode(_textureName,_mode);
Jan Möbius's avatar
 
Jan Möbius committed
295
296
297
298
299
300
}

/** Called by a plugin if it updated a texture. The information is passed to all plugins. If a texture control plugin is available it has to react on the signal and update the visualization of the texture.\n
 * See in the documentation of the texture plugin interfaces for further detail.
*/
void Core::slotTextureUpdated( QString _textureName , int _identifier ) {
301
302
303
  if ( OpenFlipper::Options::doSlotDebugging() ) {
    if ( sender() != 0 ) {
      if ( sender()->metaObject() != 0 ) {
304
        emit log(LOGINFO,"slotTextureUpdated( " + _textureName + " , " + QString::number(_identifier) + tr(" ) called by ") +
305
306
307
308
                 QString( sender()->metaObject()->className() ) );
      }
    }
  }
Jan Möbius's avatar
Jan Möbius committed
309
  emit updatedTextures(_textureName,_identifier);
Jan Möbius's avatar
 
Jan Möbius committed
310
311
}

Dirk Wilden's avatar
Dirk Wilden committed
312
313
314
315
316
317
/** Called by plugins if texture mode should be switched
 */
void Core::slotSwitchTexture( QString _textureName, int _id ) {
  emit switchTexture(_textureName, _id);
}

Jan Möbius's avatar
 
Jan Möbius committed
318
319
320
321
322
323
/** Called by plugins if texture mode should be switched
 */
void Core::slotSwitchTexture( QString _textureName ) {
  emit switchTexture(_textureName);
}

324
325
326
327
328
329
330
331
332
333
334
335
336

/** Called by plugins if texture image should be changed
 */
void Core::slotTextureChangeImage( QString _textureName , QImage& _image ) {
  emit textureChangeImage( _textureName ,_image );
}

/** Called by plugins if texture image should be changed
 */
void Core::slotTextureChangeImage( QString _textureName , QImage& _image , int _id )  {
  emit textureChangeImage( _textureName , _image , _id );
}

337
338
339
340
341
342
343
344
345
346
347
348
/** Called by plugins if texture image should be fetched
 */
void Core::slotTextureGetImage( QString _textureName , QImage& _image ) {
  emit textureGetImage( _textureName ,_image );
}

/** Called by plugins if texture image should be fetched
 */
void Core::slotTextureGetImage( QString _textureName , QImage& _image , int _id )  {
  emit textureGetImage( _textureName , _image , _id );
}

349
350
351
352
353
354
/** Called by plugins if texture index should be fetched
 */
void Core::slotTextureIndex( QString _textureName, int _id, int& _index){
  emit textureIndex( _textureName, _id, _index);
}

355
356
357
358
359
360
/** Called by plugins if texture index property name should be fetched
 */
void Core::slotTextureIndexPropertyName( int _id, QString& _propertyName){
  emit textureIndexPropertyName( _id, _propertyName);
}

361
362
363
364
365
366
/** Called by plugins if texture name should be fetched
 */
void Core::slotTextureName( int _id, int _textureIndex, QString& _textureName){
  emit textureName( _id, _textureIndex, _textureName);
}

367
368
369
370
371
372
/** Called by plugins if texture filename should be fetched
 */
void Core::slotTextureFilename( int _id, QString _textureName, QString& _textureFilename){
  emit textureFilename( _id, _textureName, _textureFilename);
}

373
374
375
376
377
378
379
380
381
382
383
384
/** Called by plugins if current texture name should be returned
 */
void Core::slotGetCurrentTexture( int _id, QString& _textureName ){
  emit getCurrentTexture( _id, _textureName );
}

/** Called by plugins if texture image should be fetched
 */
void Core::slotGetSubTextures( int _id, QString _multiTextureName, QStringList& _subTextures ){
  emit getSubTextures( _id, _multiTextureName, _subTextures );
}

Jan Möbius's avatar
Jan Möbius committed
385
386
387
//========================================================================================
// ===            Object Manager                              ============================
//========================================================================================
Jan Möbius's avatar
 
Jan Möbius committed
388

Jan Möbius's avatar
Jan Möbius committed
389
390
/// This slot is called by the object manager when a new object is created
void Core::newObject(int _objectId) {
391
  
392
393
394
395
   BaseObject* baseObject = 0;
   PluginFunctions::getObject(_objectId,baseObject);
   
   if ( baseObject ) {
396
397
398
    connect( baseObject, SIGNAL(visibilityChanged(int)),       this, SLOT(slotVisibilityChanged(int)),       Qt::DirectConnection) ;
    connect( baseObject, SIGNAL(objectSelectionChanged(int)),  this, SLOT(slotObjectSelectionChanged(int)),  Qt::DirectConnection );
    connect( baseObject, SIGNAL(objectPropertiesChanged(int)), this, SLOT(slotObjectPropertiesChanged(int)), Qt::DirectConnection );
399
400
   } else {
     emit log(LOGERR,tr("newObject received from objectManager with invalid id! This should not happen. The new Object will not work correctly!"));
401
402
   }
   
Jan Möbius's avatar
Jan Möbius committed
403
}
Jan Möbius's avatar
 
Jan Möbius committed
404

Jan Möbius's avatar
Jan Möbius committed
405
/// This slot is called by the object manager when a object is deleted
Dirk Wilden's avatar
Dirk Wilden committed
406
void Core::deletedObject(int /*_objectId*/) {
Jan Möbius's avatar
Jan Möbius committed
407
408
}

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

410
411
412
413
414
415
416
//========================================================================================
// ===            Cross Plugin connections                    ============================
//========================================================================================
void Core::slotCrossPluginConnect( QString _pluginName1, const char* _signal, QString _pluginName2, const char* _slot) {
  QObject* plugin1 = 0;
  QObject* plugin2 = 0;
  
Jan Möbius's avatar
Jan Möbius committed
417
418
419
  for ( int i = 0 ; i < (int)plugins_.size(); ++i ) {
    if ( plugins_[i].rpcName == _pluginName1 ) {
      plugin1 = plugins_[i].plugin;
420
    }
Jan Möbius's avatar
Jan Möbius committed
421
422
    if ( plugins_[i].rpcName == _pluginName2 ) {
      plugin2 = plugins_[i].plugin;
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
    }
  }

  if (  plugin1 == 0 ) {
    emit log(LOGERR,tr("Cross Plugin Interconnection failed because plugin %1 was not found!").arg(_pluginName1)); 
    return;
  }

  if (  plugin2 == 0 ) {
    emit log(LOGERR,tr("Cross Plugin Interconnection failed because plugin %1 was not found!").arg(_pluginName2)); 
    return;
  }
  
  // now connect them
  connect(plugin1,_signal,plugin2,_slot);
}

440
441
442
443
444
445
//========================================================================================
// ===            Renderer Settings                    ============================
//========================================================================================
void Core::slotSetRenderer(unsigned int _viewer, QString _rendererName) {
  renderManager().setActive(_rendererName,_viewer);
}
Jan Möbius's avatar
 
Jan Möbius committed
446

Jan Möbius's avatar
Jan Möbius committed
447
448
449
450
void Core::slotGetCurrentRenderer(unsigned int _viewer, QString& _rendererName) {
  _rendererName = renderManager().active(_viewer)->name;
}

451
452
453
454
455
456
457
458
459
460
461
void Core::slotMetadataDeserialized(
        const QVector<QPair<QString, QString> > &data) {

    QString obj_metadata;
    for (QVector<QPair<QString, QString> >::const_iterator
            it = data.begin(); it != data.end(); ++it) {
        if (it->first == "Mesh Comments")
            obj_metadata = it->second;

        emit genericMetadataDeserialized(it->first, it->second);
    }
Jan Möbius's avatar
Jan Möbius committed
462

463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
    /*
     * Now handle object metadata.
     */
    QRegExp re_begin("BEGIN Comments for object \"([^\\n]*)\"");
    QRegExp re_end("\\nEND Comments for object \"([^\\n]*)\"");
    enum STATE {
        STATE_SEARCH_BEGIN,
        STATE_CONSUME_INNER,
        STATE_EOS,
    };

    int cursor = 0;
    QString current_object_name;
    for (STATE state = STATE_SEARCH_BEGIN; state != STATE_EOS; ) {
        switch (state) {
            case STATE_SEARCH_BEGIN:
                cursor = re_begin.indexIn(obj_metadata, cursor);
                if (cursor == -1) {
                    state = STATE_EOS;
                    break;
                }
                current_object_name = re_begin.cap(1);
                cursor += re_begin.matchedLength();
                state = STATE_CONSUME_INNER;
                break;
            case STATE_CONSUME_INNER:
            {
                int next = re_end.indexIn(obj_metadata, cursor);
                if (next == -1) {
                    state = STATE_EOS;
                    break;
                }

                const QStringRef value = obj_metadata.midRef(cursor, next - cursor);

                emit objectMetadataDeserialized(current_object_name, value.toString());
#if QT_VERSION >= 0x050000
                QJsonParseError json_error;
                QJsonDocument json_doc =
                        QJsonDocument::fromJson(value.toUtf8(), &json_error);
                if (json_error.error == QJsonParseError::NoError) {
                    emit objectMetadataDeserializedJson(
                            current_object_name, json_doc);
                }
#endif
                cursor = next + re_end.matchedLength();
                state = STATE_SEARCH_BEGIN;
                break;
            }
            default:
                throw std::logic_error("metadataDeserialized(): Invalid state.");
        }
    }
}
Jan Möbius's avatar
Jan Möbius committed
517

Jan Möbius's avatar
 
Jan Möbius committed
518
//=============================================================================