Developer Documentation

TypeBSplineCurve.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 // CLASS Type BSpline Curve Plugin
47 //
48 // Author: Ellen Dekkers <dekkers@cs.rwth-aachen.de>
49 //
50 // Date: 2009-12-14 19:18:48 +0100 (Mo, 14. Dez 2009)
51 //
52 //=============================================================================
53
54
55 #ifndef TYPEBSPLINECURVEPLUGIN_HH
56 #define TYPEBSPLINECURVEPLUGIN_HH
57
58 #include <QObject>
59
60
61 #include <OpenFlipper/common/Types.hh>
62 #include <OpenFlipper/BasePlugin/BaseInterface.hh>
63 #include <OpenFlipper/BasePlugin/TypeInterface.hh>
64 #include <OpenFlipper/BasePlugin/LoggingInterface.hh>
65 #include <OpenFlipper/BasePlugin/LoadSaveInterface.hh>
66 #include <OpenFlipper/BasePlugin/ContextMenuInterface.hh>
67
68 #include <ObjectTypes/BSplineCurve/BSplineCurve.hh>
69
70
71 class TypeBSplineCurvePlugin : public QObject, BaseInterface, TypeInterface, LoggingInterface, LoadSaveInterface, ContextMenuInterface
72 {
73 Q_OBJECT
74 Q_INTERFACES(BaseInterface)
75 Q_INTERFACES(TypeInterface)
76 Q_INTERFACES(LoggingInterface)
77 Q_INTERFACES(LoadSaveInterface)
78 Q_INTERFACES(ContextMenuInterface)
79
80 Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-TypeBSplineCurve")
81
82 signals:
83
84 // Logging Interface
85 void log(Logtype _type, QString _message);
86 void log(QString _message);
87
88 // LoadSave Interface
89 void emptyObjectAdded( int _id );
90
91 // ContextMenuInterface
92 void addContextMenuItem(QAction* _action , ContextMenuType _type);
93 void addContextMenuItem(QAction* _action , DataType _objectType , ContextMenuType _type );
94
95 private slots:
96
97 // BaseInterface
98 void pluginsInitialized();
99 void noguiSupported( ) {} ;
100
101 // ContextMenuInterface
102 void slotUpdateContextMenu( int _objectId );
103
104 private slots:
105
107 void slotRenderControlPolygon();
108
110 void slotRenderCurve();
111
113 void slotRenderSelection(QAction* _action);
114
115 public :
116
117 ~TypeBSplineCurvePlugin() {};
118 TypeBSplineCurvePlugin();
119
120 QString name() { return (QString("TypeBSplineCurve")); };
121 QString description( ) { return (QString(tr("Register BSpline Curve type "))); };
122
123 bool registerType();
124
125 DataType supportedType();
126
127 int addEmpty( );
128
129 public slots:
130
131 // Type Interface
132 void generateBackup( int _id, QString _name, UpdateType _type );
133
134 public slots:
135
136 QString version() { return QString("1.1"); };
137
138 private:
140 QAction* renderControlPolygonAction_;
141
143 QAction* renderCurveAction_;
144
146 QAction* renderCPSelectionAction_;
147 QAction* renderKnotSelectionAction_;
148 QAction* renderNoSelectionAction_;
149
150 };
151
152 #endif //TYPEBSPLINECURVEPLUGIN_HH
TypeInterface
Interface class for type definitions.
Definition: TypeInterface.hh:63
TypeBSplineCurvePlugin::addEmpty
int addEmpty()
Create an empty object.
Definition: TypeBSplineCurve.cc:268
LoadSaveInterface.hh
TypeBSplineCurvePlugin::pluginsInitialized
void pluginsInitialized()
Second initialization phase.
Definition: TypeBSplineCurve.cc:82
TypeBSplineCurvePlugin::name
QString name()
Return a name for the plugin.
Definition: TypeBSplineCurve.hh:120
Logtype
Logtype
Log types for Message Window.
Definition: LoggingInterface.hh:92
TypeBSplineCurvePlugin
Definition: TypeBSplineCurve.hh:71
TypeBSplineCurvePlugin::renderCPSelectionAction_
QAction * renderCPSelectionAction_
Context menu action (render selection texture)
Definition: TypeBSplineCurve.hh:146
TypeBSplineCurvePlugin::description
QString description()
Return a description of what the plugin is doing.
Definition: TypeBSplineCurve.hh:121
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
TypeBSplineCurvePlugin::renderControlPolygonAction_
QAction * renderControlPolygonAction_
Context menu action.
Definition: TypeBSplineCurve.hh:136
TypeBSplineCurvePlugin::slotRenderControlPolygon
void slotRenderControlPolygon()
Slot triggered from context menu, if the control polygon should be rendered.
Definition: TypeBSplineCurve.cc:171
TypeInterface.hh
ContextMenuType
ContextMenuType
Definition: ContextMenuInterface.hh:56
UpdateType
Update type class.
Definition: UpdateType.hh:60
TypeBSplineCurvePlugin::slotRenderSelection
void slotRenderSelection(QAction *_action)
Slot triggered from context menu, if the selection rendering should be altered.
Definition: TypeBSplineCurve.cc:215
TypeBSplineCurvePlugin::slotUpdateContextMenu
void slotUpdateContextMenu(int _objectId)
Definition: TypeBSplineCurve.cc:150
BSplineCurve.hh
TypeBSplineCurvePlugin::slotRenderCurve
void slotRenderCurve()
Slot triggered from context menu, if the curve should be rendered.
Definition: TypeBSplineCurve.cc:193
Types.hh
ContextMenuInterface.hh
ContextMenuInterface
Interface class for creating custom context menus.
Definition: ContextMenuInterface.hh:85
TypeBSplineCurvePlugin::renderCurveAction_
QAction * renderCurveAction_
Context menu action.
Definition: TypeBSplineCurve.hh:143
TypeBSplineCurvePlugin::supportedType
DataType supportedType()
Return your supported object type( e.g. DATA_TRIANGLE_MESH )
Definition: TypeBSplineCurve.cc:258
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