Developer Documentation
NoisePlugin.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 #pragma once
44 
54 
55 
56 #include "noiseToolbar.hh"
57 
59 {
60  Q_OBJECT
61  Q_INTERFACES(BaseInterface)
62  Q_INTERFACES(ToolboxInterface)
63  Q_INTERFACES(BackupInterface)
64  Q_INTERFACES(LoggingInterface)
65  Q_INTERFACES(PythonInterface)
66 
67 
68 Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-Noise")
69 
70  signals:
71 
72  void updatedObject(int _id, const UpdateType& _type);
73 
74  void createBackup(int _objectid, QString _name, UpdateType _type = UPDATE_ALL);
75 
76  void log(Logtype _type, QString _message);
77  void log(QString _message);
78 
79  // ToolboxInterface
80  void addToolbox( QString _name , QWidget* _widget, QIcon* _icon );
81 
82 
83  public :
84 
85  ~NoisePlugin() {}
86 
87  QString name() { return (QString("Noise")); }
88  QString description( ) { return (QString("Add Noise to object surfaces")); }
89 
90  private :
91 
94 
95  private slots:
96 
97  // BaseInterface
98  void initializePlugin();
99 
100  void slotAddNoise();
101 
103  void noguiSupported( ) {}
104 
105  public slots:
106  void slotAddNoise(int _objectId, double _maxNoise);
107 
108  private:
109  template< class MeshT >
110  void slotAddNoise( MeshT* _mesh, double _maxNoise);
111 
112  void slotAddNoise( SplatCloud* _splat_cloud, double _maxNoise);
113 
114 
115  public slots:
116  QString version() { return QString("2.0"); }
117 
118 };
119 
Interface class for exporting functions to python.
const UpdateType UPDATE_ALL(UpdateTypeSet(1))
Identifier for all updates.
Plugins can add its own toolbox to the main widget&#39;s toolbox area by using this interface.
Logtype
Log types for Message Window.
QString name()
Return a name for the plugin.
Definition: NoisePlugin.hh:87
Interface for all Plugins which do logging to the logging window of the framework.
Update type class.
Definition: UpdateType.hh:59
QString description()
Return a description of what the plugin is doing.
Definition: NoisePlugin.hh:88
void noguiSupported()
Tell system that this plugin runs without ui.
Definition: NoisePlugin.hh:103
noiseToolbarWidget * tool_
Widget for Toolbox.
Definition: NoisePlugin.hh:93
Interface class from which all plugins have to be created.
Interface class for backup handling.