Developer Documentation

RenderPickingPlugin.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 #include <QObject>
43 #include <QAction>
44
45 #include <OpenFlipper/BasePlugin/BaseInterface.hh>
46 #include <OpenFlipper/BasePlugin/RenderInterface.hh>
47
48 #include <ACG/Scenegraph/SceneGraph.hh>
49
50 class RenderPickingPlugin : public QObject, BaseInterface, RenderInterface
51 {
52 Q_OBJECT
53 Q_INTERFACES(BaseInterface)
54 Q_INTERFACES(RenderInterface)
55
56 Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-Render-Picking")
57
58
59 public :
60 RenderPickingPlugin() : pickRendererMode_(ACG::SceneGraph::PICK_ANYTHING) {};
61
62 QString name() { return (QString("Picking Rendering Plugin")); };
63 QString description( ) { return (QString(tr("Print the picking color buffer to the current viewer"))); };
64
65
66 public slots:
67 QString version() { return QString("1.0"); };
68
69 // RenderInterface
70 QAction* optionsAction();
71
72 private slots:
73
74 //BaseInterface
75 void initializePlugin();
76
77 // RenderInterface
78 void render(ACG::GLState* _glState, Viewer::ViewerProperties& _properties);
79 QString rendererName();
80 void supportedDrawModes(ACG::SceneGraph::DrawModes::DrawMode& _mode);
81 QString checkOpenGL();
82
83
84 // The picking target has been changed
85 void slotPickTargetChanged( QAction * );
86
87 private:
88 //TODO : Move this to per viewer modes!
89 ACG::SceneGraph::PickTarget pickRendererMode_;
90
91 };
92
ACG::SceneGraph::PICK_ANYTHING
pick any of the prior targets (should be implemented for all nodes)
Definition: PickTarget.hh:84
RenderInterface.hh
Viewer::ViewerProperties
Definition: ViewerProperties.hh:107
RenderPickingPlugin::description
QString description()
Return a description of what the plugin is doing.
Definition: RenderPickingPlugin.hh:63
RenderPickingPlugin::optionsAction
QAction * optionsAction()
Return options menu.
Definition: RenderPickingPlugin.cc:59
ACG::GLState
Definition: GLState.hh:213
BaseInterface.hh
RenderPickingPlugin::name
QString name()
Return a name for the plugin.
Definition: RenderPickingPlugin.hh:62
BaseInterface
Interface class from which all plugins have to be created.
Definition: BaseInterface.hh:65
RenderInterface
Interface to add additional rendering functions from within plugins.
Definition: RenderInterface.hh:60
ACG::SceneGraph::DrawModes::DrawMode
Specifies a DrawMode.
Definition: DrawModes.hh:288
ACG::SceneGraph::PickTarget
PickTarget
What target to use for picking.
Definition: PickTarget.hh:73
RenderPickingPlugin
Definition: RenderPickingPlugin.hh:50
SceneGraph.hh