Developer Documentation
ToonRenderer.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: 18127 $ *
45 * $LastChangedBy: moebius $ *
46 * $Date: 2014-02-05 10:12:54 +0100 (Wed, 05 Feb 2014) $ *
47 * *
48 \*===========================================================================*/
49 
50 #pragma once
51 
52 #include <QObject>
53 
56 
57 #include <ACG/GL/IRenderer.hh>
58 #include <ACG/GL/FBO.hh>
59 
61 {
62  Q_OBJECT
63  Q_INTERFACES(BaseInterface)
64  Q_INTERFACES(RenderInterface)
65 
66 #if QT_VERSION >= 0x050000
67  Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-Render-Toon")
68 #endif
69 
70 public:
71  ToonRenderer();
72  ~ToonRenderer();
73 
74  QString name() { return (QString("Toon Renderer Plugin")); };
75  QString description( ) { return (QString(tr("Render with cel shading and edge outlining"))); };
76 
77 public slots:
78  QString version() { return QString("1.0"); };
79  QString renderObjectsInfo(bool _outputShaderInfo);
80 
81  QAction* optionsAction();
82 
83 private slots:
84 
85  //BaseInterface
86  void initializePlugin();
87  void exit(){}
88 
89  // RenderInterface
90  void render(ACG::GLState* _glState, Viewer::ViewerProperties& _properties);
91  QString rendererName() {return QString("Toon_Renderer");}
92  void supportedDrawModes(ACG::SceneGraph::DrawModes::DrawMode& _mode) {_mode = ACG::SceneGraph::DrawModes::DEFAULT;}
93 
94  QString checkOpenGL();
95 
96 
97  void actionDialog( bool );
98  void paletteSizeChanged( int );
99  void outlineColorChanged( QColor );
100 
101 private:
102 
103  void loadShader();
104 
107 
110 
113 
116  {
117  ViewerResources() : scene_(0) {}
118  ~ViewerResources() {delete scene_;}
119 
120  void resize( int _newWidth, int _newHeight );
121 
122  ACG::FBO* scene_;
123  };
124 
129  std::map<int, ViewerResources> viewerRes_;
130 };
131 
std::map< int, ViewerResources > viewerRes_
ACG::Vec3f outlineCol_
outline color
DrawMode DEFAULT
use the default (global) draw mode and not the node&#39;s own.
Definition: DrawModes.cc:78
QString name()
Return a name for the plugin.
Definition: ToonRenderer.hh:74
Collection of fbos for each viewport.
QString renderObjectsInfo(bool _outputShaderInfo)
Return a qstring of the current render objects.
QAction * optionsAction()
Return options menu.
QString description()
Return a description of what the plugin is doing.
Definition: ToonRenderer.hh:75
GLSL::Program * progOutline_
outline shader: multiply scene color with edge factor derived from edges in depth buffer ...
Definition: FBO.hh:83
Interface class from which all plugins have to be created.
Interface to add additional rendering functions from within plugins.
float paletteSize_
size of cel shading palette
GLSL program class.
Definition: GLSLShader.hh:217