Developer Documentation
TypeSkeleton.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 * $Revision$ *
45 * $LastChangedBy$ *
46 * $Date$ *
47 * *
48 \*===========================================================================*/
49 
50 
51 
52 
53 #ifndef TYPESKELETONPLUGIN_HH
54 #define TYPESKELETONPLUGIN_HH
55 
56 #include <QObject>
57 
65 
67 {
68  Q_OBJECT
69  Q_INTERFACES(BaseInterface)
70  Q_INTERFACES(LoadSaveInterface)
71  Q_INTERFACES(LoggingInterface)
72  Q_INTERFACES(TypeInterface)
73  Q_INTERFACES(ContextMenuInterface)
74 
75 #if QT_VERSION >= 0x050000
76  Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-TypeSkeleton")
77 #endif
78 
79  signals:
80  // Logging interface
81  void log(Logtype _type, QString _message);
82  void log(QString _message);
83 
84  // LoadSave Interface
85  void emptyObjectAdded( int _id );
86 
87  // ContextMenuInterface
88  void addContextMenuItem(QAction* _action , ContextMenuType _type);
89  void addContextMenuItem(QAction* _action , DataType _objectType , ContextMenuType _type );
90 
91  private slots:
92  void pluginsInitialized();
93  void noguiSupported( ) {} ;
94 
95  void slotUpdateContextMenu( int _objectId );
96 
97  void slotShowIndices();
98  void slotShowCoordFrames();
99  void slotShowMotionPath();
100 
101  private:
102  QAction* showIndicesAction_;
103  QAction* showCoordFramesAction_;
104  QAction* showMotionAction_;
105 
106  public :
107 
108  ~TypeSkeletonPlugin() {};
110 
111  QString name() { return (QString("TypeSkeleton")); };
112  QString description( ) { return (QString(tr("Register Skeleton type"))); };
113 
114  bool registerType();
115 
116  public slots:
117 
118  // Base Interface
119  QString version() { return QString("1.0"); };
120 
121  // Type Interface
122  int addEmpty();
124 
125  // Type Interface
126  void generateBackup( int _id, QString _name, UpdateType _type );
127 
128 };
129 
130 #endif //TYPESKELETONPLUGIN_HH
Interface class for creating custom context menus.
Predefined datatypes.
Definition: DataTypes.hh:96
Logtype
Log types for Message Window.
Interface class for type definitions.
DataType supportedType()
Return your supported object type( e.g. DATA_TRIANGLE_MESH )
Interface class from which all plugins have to be created.
Update type class.
Definition: UpdateType.hh:70
Interface for all Plugins which do logging to the logging window of the framework.
int addEmpty()
Create an empty object.
QString description()
Return a description of what the plugin is doing.
void slotUpdateContextMenu(int _objectId)
Interface for all plugins which want to Load or Save files and create Objects.
void generateBackup(int _id, QString _name, UpdateType _type)
This slot should be implemented in a TypePlugin to generate type specific backups.
#define DATA_SKELETON
Definition: Skeleton.hh:70
void pluginsInitialized()
Second initialization phase.
Definition: TypeSkeleton.cc:68
QString name()
Return a name for the plugin.