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