Developer Documentation
PolyLineSelectionPlugin.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  * $Author$ *
46  * $Date$ *
47  * *
48 \*===========================================================================*/
49 
50 #ifndef POLYLINESELECTIONPLUGIN_HH
51 #define POLYLINESELECTIONPLUGIN_HH
52 
53 #include <QObject>
54 
62 #include <OpenFlipper/BasePlugin/INIInterface.hh>
67 #include <OpenFlipper/INIFile/INIFile.hh>
68 
70 
73 {
74  Q_OBJECT
75  Q_INTERFACES(BaseInterface)
76  Q_INTERFACES(KeyInterface)
77  Q_INTERFACES(INIInterface)
78  Q_INTERFACES(BackupInterface)
79  Q_INTERFACES(LoggingInterface)
80  Q_INTERFACES(ScriptInterface)
81  Q_INTERFACES(SelectionInterface)
82 
83 #if QT_VERSION >= 0x050000
84  Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-SelectionPolyLine")
85 #endif
86 
87 public:
88 
91 
94 
95 signals:
96 
97  // BaseInterface
98  void updateView();
99  void updatedObject(int, const UpdateType&);
100  void nodeVisibilityChanged(int _identifier);
101  void setSlotDescription(QString _slotName, QString _slotDescription,
102  QStringList _parameters, QStringList _descriptions);
103 
104  // LoggingInterface
105  void log(Logtype _type, QString _message);
106  void log(QString _message);
107 
108  // ScriptInterface
109  void scriptInfo(QString _functionName);
110 
111  // SelectionInterface
112  void addSelectionEnvironment(QString _modeName, QString _description, QString _icon, QString& _handleName);
113  void registerType(QString _handleName, DataType _type);
114  void addPrimitiveType(QString _handleName, QString _name, QString _icon, SelectionInterface::PrimitiveType& _typeHandle);
115  void addSelectionOperations(QString _handleName, QStringList _operationsList, QString _category, SelectionInterface::PrimitiveType _type = 0u);
116  void showToggleSelectionMode(QString _handleName, bool _show, SelectionInterface::PrimitiveType _associatedTypes);
117  void showVolumeLassoSelectionMode(QString _handleName, bool _show, SelectionInterface::PrimitiveType _associatedTypes);
118 
119  void getActiveDataTypes(SelectionInterface::TypeList& _types);
120  void getActivePrimitiveType(SelectionInterface::PrimitiveType& _type);
121  void targetObjectsOnly(bool& _targetsOnly);
122 
123  void registerKeyShortcut(int _key, Qt::KeyboardModifiers _modifiers = Qt::NoModifier);
124 
125 private slots:
126 
127  // INIInterface
128  void loadIniFile(INIFile& _ini, int _id);
129  void saveIniFile(INIFile& _ini, int _id);
130 
131  // BaseInterface
132  void initializePlugin();
133  void pluginsInitialized();
134  void noguiSupported() {};
135 
136  // SelectionInterface
137  void slotSelectionOperation(QString _operation);
138  void slotToggleSelection(QMouseEvent* _event, SelectionInterface::PrimitiveType _currentType, bool _deselect);
139  void slotVolumeLassoSelection(QMouseEvent* _event, SelectionInterface::PrimitiveType _currentType, bool _deselect);
140 
141  void slotLoadSelection(const INIFile& _file);
142  void slotSaveSelection(INIFile& _file);
143 
144  void slotKeyShortcutEvent(int _key, Qt::KeyboardModifiers _modifiers);
145 
146 public slots:
147 
148  // SelectionInterface
149  void loadSelection(int _objId, const QString& _filename);
150 
151 public:
152 
153  // BaseInterface
154  QString name() {
155  return (QString(tr("PolyLine Selection")));
156  };
157 
158  QString description() {
159  return (QString(tr("Allows to select PolyLines")));
160  };
161 
162  //===========================================================================
165  //===========================================================================
166 private:
167 
169  void updateSlotDescriptions();
170 
173 public slots:
174 
175  QString version() {
176  return QString("1.0");
177  };
178 
179  //===========================================================================
182  //===========================================================================
183 
185  void selectAllVertices(int _objectId);
186 
188  void deselectAllVertices(int _objectId);
189 
191  void invertVertexSelection(int _objectId);
192 
194  void deleteSelectedVertices(int _objectId);
195 
197  void selectVertices(int _objectId, const IdList& _ids, bool _deselect = false);
198 
200  IdList getVertexSelection(int _objectId);
201 
202  //===========================================================================
203 
205  void selectAllEdges(int _objectId);
206 
208  void deselectAllEdges(int _objectId);
209 
211  void invertEdgeSelection(int _objectId);
212 
214  void deleteSelectedEdges(int _objectId);
215 
217  void selectEdges(int _objectId, const IdList& _ids, bool _deselect = false);
218 
220  IdList getEdgeSelection(int _objectId);
221 
224  //===========================================================================
227  //===========================================================================
228 
229 private:
230 
233 
235  PrimitiveType vertexType_;
236  PrimitiveType edgeType_;
237 
238  PrimitiveType allSupportedTypes_;
239 
241  QVector<QPoint> volumeLassoPoints_;
242 
245 };
246 
247 //=============================================================================
248 #endif // POLYLINESELECTIONPLUGIN_HH defined
249 //=============================================================================
PolyLineSelectionPlugin()
Default constructor.
IdList getVertexSelection(int _objectId)
Get current vertex selection.
Predefined datatypes.
Definition: DataTypes.hh:96
void updateSlotDescriptions()
Set slot descriptions for scripting functions.
void deleteSelectedVertices(int _objectId)
Delete selected vertices.
void selectAllEdges(int _objectId)
Select all edges of a skeleton.
Logtype
Log types for Message Window.
Keyboard Event Interface.
Definition: KeyInterface.hh:76
~PolyLineSelectionPlugin()
Default destructor.
void selectVertices(int _objectId, const IdList &_ids, bool _deselect=false)
Select specific vertices of a skeleton.
void slotLoadSelection(const INIFile &_file)
Load selection for specific objects in the scene.
Interface for all Plugins which provide scriptable Functions.
Interface class for Plugins which have to store information in ini files.
Definition: INIInterface.hh:81
Interface class from which all plugins have to be created.
PrimitiveType vertexType_
Primitive type handles:
Update type class.
Definition: UpdateType.hh:70
Interface for all Plugins which do logging to the logging window of the framework.
void slotSelectionOperation(QString _operation)
A specific operation is requested.
void slotVolumeLassoSelection(QMouseEvent *_event, SelectionInterface::PrimitiveType _currentType, bool _deselect)
Called whenever the user performs a volume lasso selection.
PrimitiveType allSupportedTypes_
Handle to selection environment.
Class for the handling of simple configuration files.
Definition: INIFile.hh:105
void slotKeyShortcutEvent(int _key, Qt::KeyboardModifiers _modifiers)
One of the previously registered keys has been pressed.
void slotSaveSelection(INIFile &_file)
Save selection for all objects in the scene.
void deselectAllVertices(int _objectId)
Deselect all vertices of a skeleton.
void deselectAllEdges(int _objectId)
Deselect all edges of a skeleton.
PrimitiveType edgeType_
Handle to selection environment.
Interface for all plugins which want to use selection functions.
std::vector< int > IdList
Standard Type for id Lists used for scripting.
Definition: DataTypes.hh:192
void deleteSelectedEdges(int _objectId)
Delete selected edges.
void selectAllVertices(int _objectId)
Select all vertices of a skeleton.
IdList getEdgeSelection(int _objectId)
Get current edge selection.
QString environmentHandle_
Handle to selection environment.
void selectEdges(int _objectId, const IdList &_ids, bool _deselect=false)
Select specific edges of a skeleton.
QString name()
Return a name for the plugin.
void invertVertexSelection(int _objectId)
Invert vertex selection.
void invertEdgeSelection(int _objectId)
Invert edge selection.
void slotToggleSelection(QMouseEvent *_event, SelectionInterface::PrimitiveType _currentType, bool _deselect)
Called whenever the user performs a toggle selection.
Interface class for backup handling.
QString description()
Return a description of what the plugin is doing.
QVector< QPoint > volumeLassoPoints_
Keep volume lasso points.