PluginConnectionInterface.hh 8.72 KB
Newer Older
1
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.              *
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
*                                                                            *
\*===========================================================================*/

/*===========================================================================*\
*                                                                            *
*   $Revision$                                                       *
*   $LastChangedBy$                                                *
*   $Date$                     *
*                                                                            *
\*===========================================================================*/


#ifndef PLUGINCONNECTIONINTERFACE_HH
#define PLUGINCONNECTIONINTERFACE_HH

#include <QString>

56
57
58
59
60
61
/** \file PluginConnectionInterface.hh
*
* Interface for connecting signals and slots across plugins. \ref pluginConnectionInterfacePage
*/

/**
62
63
  * \brief Allow to connect slots between plugins
  *
64
65
66
  * \ref pluginConnectionInterfacePage "Detailed description"
  * \n
  *
67
68
  * Interface Class which allows to connect signals and slots across plugins
  *
69
70
71
72
73
74
75
  * \n
  *  <b> WARNING! Never connect SIGNALS and SLOTS which are already defined in the Interfaces!! WARNING! </b>
  * \n
  *
  * This might result in endless loops and breaks OpenFlippers control loops. You have to keep track
  * of your connections yourself. If you call slots which call updatedOject which in turn call your original
  * slot you get a loop and OpenFlipper is not responsible for your endless loops! Be careful!
76
77
78
79
80
81
82
83
 */
class PluginConnectionInterface {
  
   signals :
     /** \brief connect signals and slots of plugins across plugins
     *
     * Connect a signal of one plugin to another plugin by its scripting name.
     * _pluginName1 is the scripting name of the plugin containing the signal ( Use script editor to check that name)
84
     * _signal is the signal name. Use it like with regular connect ( <tt>SIGNAL(...)</tt> ) macro
85
     * _pluginName2 is the scripting name of the plugin containing a slot
86
     * _slot is the slot name. Use it like with regular connect ( <tt>SLOT(...)</tt> ) macro
87
88
89
90
     *
     */
     virtual void crossPluginConnect( QString /*_pluginName1*/, const char* /*_signal*/, QString /*_pluginName2*/, const char* /*_slot*/) {};

91
92
93
94
95
96
97
98
99
100
101
     /** \brief connect signals and slots of plugins across plugins using Qt::QueuedConnection
     *
     * Connect a signal of one plugin to another plugin by its scripting name.
     * _pluginName1 is the scripting name of the plugin containing the signal ( Use script editor to check that name)
     * _signal is the signal name. Use it like with regular connect ( <tt>SIGNAL(...)</tt> ) macro
     * _pluginName2 is the scripting name of the plugin containing a slot
     * _slot is the slot name. Use it like with regular connect ( <tt>SLOT(...)</tt> ) macro
     *
     */
     virtual void crossPluginConnectQueued( QString /*_pluginName1*/, const char* /*_signal*/, QString /*_pluginName2*/, const char* /*_slot*/) {};

102
103
104
105
106
107
108
109

   public :

      /// Destructor
      virtual ~PluginConnectionInterface() {};

};

110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
/** \page pluginConnectionInterfacePage Plugin Connection Interface
\n
\image html PluginConnectionInterface.png
\n

The PluginConnectionInterface allows to connect signals and slots across different OpenFlipper plugins.

Usually you should implement the BaseInterface::pluginsInitialized() function from BaseInterface. In this function you can setup
your connections. Don't try to setup your connections earlier as the plugins you try to connect may not exist yet.

\n
 <b> WARNING! Never connect SIGNALS and SLOTS which are already defined in other Interfaces!! WARNING! </b>
\n
This might result in endless loops and breaks OpenFlippers control loops. You have to keep track
of your connections yourself. If you call slots which call updatedOject which in turn call your original
slot you get a loop and OpenFlipper is not responsible for your endless loops! Be careful!

The following code shows a simple example to connect signals and slots. For the signal and slot definition
you have to use the common QT macros SIGNAL and SLOT.
\code
void ExamplePlugin::pluginsInitialized()
{
 // Use the QT macros to generate the signatures
 emit crossPluginConnect(pluginA,SIGNAL(signalA(QString)),pluginB,SLOT(slotB(QString)));
}
\endcode

137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
The next example shows how to use a queued connection between two plugins:
\n
ExamplePlugin.hh:
\code
class ExamplePlugin: public QObject, BaseInterface, PluginConnectionInterface, [...]
{
   Q_OBJECT
   Q_INTERFACES(BaseInterface)
   Q_INTERFACES(PluginConnectionInterface)
   [...]

signals:
   void crossPluginConnectQueued( QString, const char*, QString, const char*);

   /// example signal which can be used to group objects in datacontrol
   void void dataControlGroupObjects(IdList, QString);

   [...]
   void exampleFunction();
}
\endcode

ExamplePlugin.cc:
\code
[...]
void ExamplePlugin::pluginsInitialized()
{
   [...]
   emit crossPluginConnectQueued("exampleplugin",SIGNAL(dataControlGroupObjects(IdList, QString)),"datacontrol",SLOT(groupObjects(IdList, QString)));
}

void ExamplePlugin::exampleFunction()
{
   //do whatever you want, especially use the signals you want, but don't create loops
   // e.g. emit a bazillion addEmptObject signals
   [...]
   // finally group them by emitting the connected signal
   emit dataControlGroupObjects(ids, "fancy group name");
}
\endcode

178
179
180
181
182
183
184
185
186
187
188
To use the ScriptInterface:
<ul>
<li> include PluginConnectionInterface.hh in your plugins header file
<li> derive your plugin from the class PluginConnectionInterface
<li> add Q_INTERFACES(PluginConnectionInterface) to your plugin class
<li> And add the signals or slots you want to use to your plugin class (You don't need to implement all of them)
</ul>

*/


189
190
191
Q_DECLARE_INTERFACE(PluginConnectionInterface,"OpenFlipper.PluginConnectionInterface/1.0")

#endif // PLUGINCONNECTIONINTERFACE_HH