Developer Documentation

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