Developer Documentation

TypeSphere.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
44
45
46
47 #ifndef TYPESPHEREPLUGIN_HH
48 #define TYPESPHEREPLUGIN_HH
49
50 #include <QObject>
51
52 #include <OpenFlipper/common/Types.hh>
53 #include <ObjectTypes/Sphere/Sphere.hh>
54 #include <OpenFlipper/BasePlugin/BaseInterface.hh>
55 #include <OpenFlipper/BasePlugin/LoadSaveInterface.hh>
56 #include <OpenFlipper/BasePlugin/LoggingInterface.hh>
57 #include <OpenFlipper/BasePlugin/TypeInterface.hh>
58
59 class TypeSpherePlugin : public QObject, BaseInterface, LoadSaveInterface, LoggingInterface, TypeInterface
60 {
61 Q_OBJECT
62 Q_INTERFACES(BaseInterface)
63 Q_INTERFACES(LoadSaveInterface)
64 Q_INTERFACES(LoggingInterface)
65 Q_INTERFACES(TypeInterface)
66
67
68 Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-TypeSphere")
69
70
71 signals:
72 // Logging interface
73 void log(Logtype _type, QString _message);
74 void log(QString _message);
75
76 // LoadSave Interface
77 void emptyObjectAdded( int _id );
78
79 private slots:
80
81 void noguiSupported( ) {} ;
82
83 public :
84
85 ~TypeSpherePlugin() {};
86 TypeSpherePlugin();
87
88 QString name() { return (QString("TypeSphere")); };
89 QString description( ) { return (QString(tr("Register Sphere type"))); };
90
91 bool registerType();
92
93 public slots:
94
95 // Base Interface
96 QString version() { return QString("1.0"); };
97
98 // Type Interface
99 int addEmpty();
100 DataType supportedType() { return DATA_SPHERE; };
101
102 };
103
104 #endif //TYPESPHEREPLUGIN_HH
TypeInterface
Interface class for type definitions.
Definition: TypeInterface.hh:63
LoadSaveInterface.hh
Logtype
Logtype
Log types for Message Window.
Definition: LoggingInterface.hh:92
TypeSpherePlugin::addEmpty
int addEmpty()
Create an empty object.
Definition: TypeSphere.cc:64
DataType
Predefined datatypes.
Definition: DataTypes.hh:83
LoggingInterface
Interface for all Plugins which do logging to the logging window of the framework.
Definition: LoggingInterface.hh:112
LoggingInterface.hh
Sphere.hh
TypeSpherePlugin::name
QString name()
Return a name for the plugin.
Definition: TypeSphere.hh:88
TypeInterface.hh
TypeSpherePlugin
Definition: TypeSphere.hh:59
TypeSpherePlugin::description
QString description()
Return a description of what the plugin is doing.
Definition: TypeSphere.hh:89
Types.hh
DATA_SPHERE
#define DATA_SPHERE
Definition: Sphere.hh:58
TypeSpherePlugin::supportedType
DataType supportedType()
Return your supported object type( e.g. DATA_TRIANGLE_MESH )
Definition: TypeSphere.hh:100
BaseInterface
Interface class from which all plugins have to be created.
Definition: BaseInterface.hh:65
BaseInterface.hh
LoadSaveInterface
Interface for all plugins which want to Load or Save files and create Objects.
Definition: LoadSaveInterface.hh:59