Developer Documentation

Renderer.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 #pragma once
45
46
47 #include <QObject>
48
49 #include <OpenFlipper/BasePlugin/BaseInterface.hh>
50 #include <OpenFlipper/BasePlugin/RenderInterface.hh>
51 #include <OpenFlipper/BasePlugin/LoggingInterface.hh>
52
53 #include <ACG/GL/IRenderer.hh>
54
55 class Renderer : public QObject, BaseInterface, RenderInterface, LoggingInterface, ACG::IRenderer
56 {
57 Q_OBJECT
58 Q_INTERFACES(BaseInterface)
59 Q_INTERFACES(RenderInterface)
60 Q_INTERFACES(LoggingInterface)
61
62 Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-Render-ShaderPipeline")
63
64 signals:
65 // LoggingInterface
66 void log(Logtype _type, QString _message);
67 void log(QString _message);
68
69
70 public:
71 Renderer();
72 ~Renderer();
73
74 QString name() { return (QString("Shader Pipeline Renderer Plugin")); };
75 QString description( ) { return (QString(tr("Shader Based Rendering Pipeline (Alpha Version!)"))); };
76
77 public slots:
78 QString version() { return QString("1.0"); };
79
80 QString renderObjectsInfo(bool _outputShaderInfo) { return sortedObjects_.empty() ? "" : dumpCurrentRenderObjectsToString(&sortedObjects_[0],_outputShaderInfo); };
81
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("Alpha_Version_ShaderPipeline");}
92 void supportedDrawModes(ACG::SceneGraph::DrawModes::DrawMode& _mode) {_mode = ACG::SceneGraph::DrawModes::DEFAULT;}
93
94 QString checkOpenGL();
95 };
96
ACG::IRenderer::dumpCurrentRenderObjectsToString
virtual QString dumpCurrentRenderObjectsToString(ACG::RenderObject **_list=0, bool _outputShaders=false, std::vector< ACG::ShaderModifier *> *_modifiers=0)
Outputs the current render objects to the string.
Definition: IRenderer.cc:1283
Logtype
Logtype
Log types for Message Window.
Definition: LoggingInterface.hh:92
Renderer::name
QString name()
Return a name for the plugin.
Definition: Renderer.hh:74
RenderInterface.hh
Renderer::description
QString description()
Return a description of what the plugin is doing.
Definition: Renderer.hh:75
LoggingInterface.hh
Renderer
Definition: Renderer.hh:63
Viewer::ViewerProperties
Definition: ViewerProperties.hh:107
Renderer::renderObjectsInfo
QString renderObjectsInfo(bool _outputShaderInfo)
Return a qstring of the current render objects.
Definition: Renderer.hh:80
LoggingInterface
Interface for all Plugins which do logging to the logging window of the framework.
Definition: LoggingInterface.hh:112
ACG::SceneGraph::DrawModes::DEFAULT
DrawMode DEFAULT
use the default (global) draw mode and not the node&#39;s own.
Definition: DrawModes.cc:72
ACG::GLState
Definition: GLState.hh:213
BaseInterface.hh
ACG::IRenderer::sortedObjects_
std::vector< ACG::RenderObject * > sortedObjects_
sorted list of renderobjects without overlay objects (sorted in rendering order)
Definition: IRenderer.hh:517
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::IRenderer
Definition: IRenderer.hh:78