Developer Documentation
TestPlugin.hh
1/*===========================================================================*\
2* *
3 * OpenFlipper *
4 * Copyright (c) 2001-2015, RWTH-Aachen University *
5 * Department of Computer Graphics and Multimedia *
6 * All rights reserved. *
7 * www.openflipper.org *
8 * *
9 *---------------------------------------------------------------------------*
10 * This file is part of OpenFlipper. *
11 *---------------------------------------------------------------------------*
12 * *
13 * Redistribution and use in source and binary forms, with or without *
14 * modification, are permitted provided that the following conditions *
15 * are met: *
16 * *
17 * 1. Redistributions of source code must retain the above copyright notice, *
18 * this list of conditions and the following disclaimer. *
19 * *
20 * 2. Redistributions in binary form must reproduce the above copyright *
21 * notice, this list of conditions and the following disclaimer in the *
22 * documentation and/or other materials provided with the distribution. *
23 * *
24 * 3. Neither the name of the copyright holder nor the names of its *
25 * contributors may be used to endorse or promote products derived from *
26 * this software without specific prior written permission. *
27 * *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39 * *
40 \*===========================================================================*/
41
42
43#ifndef TESTPLUGIN_HH
44#define TESTPLUGIN_HH
45
50
52 Q_OBJECT
53 Q_INTERFACES(BaseInterface)
54 Q_INTERFACES(LoggingInterface)
55 Q_INTERFACES(PythonInterface)
56
57 Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-Test")
58
59 signals:
60 //BaseInterface
61 void updateView();
62 void updatedObject(int _id, const UpdateType& _type);
63
64 //LoggingInterface
65 void log(Logtype _type, QString _message);
66 void log(QString _message);
67
68public:
69
70 // BaseInterface
71 QString name() { return (QString("Test")); } ;
72 QString description() { return (QString("Plugin used for testing OpenFlipper functions")); } ;
73
74 std::vector<ACG::Vec3d> getBoundingBoxTest();
75
76private slots:
77
79 void initializePlugin();
80 void pluginsInitialized();
81
83 void noguiSupported( ) {} ;
84
85public slots:
86
87 QString version() { return QString("1.0"); };
88
89};
90
91#endif //TESTPLUGIN_HH
Logtype
Log types for Message Window.
Interface class from which all plugins have to be created.
Interface for all Plugins which do logging to the logging window of the framework.
Interface class for exporting functions to python.
QString name()
Return a name for the plugin.
Definition: TestPlugin.hh:71
QString description()
Return a description of what the plugin is doing.
Definition: TestPlugin.hh:72
void initializePlugin()
BaseInterface.
Definition: TestPlugin.cc:53
void noguiSupported()
Tell system that this plugin runs without ui.
Definition: TestPlugin.hh:83
Update type class.
Definition: UpdateType.hh:59