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