Developer Documentation

NormalRenderer.cc
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 #include "NormalRenderer.hh"
45
46 #include <OpenFlipper/common/GlobalOptions.hh>
47 #include <OpenFlipper/BasePlugin/PluginFunctions.hh>
48 #include <ACG/GL/ShaderCache.hh>
49
50
51
52 // =================================================
53
54 class NormalFragmentModifier : public ACG::ShaderModifier
55 {
56 public:
57
58 void modifyVertexIO( ACG::ShaderGenerator* _shader )
59 {
60 // request object space normals
61 _shader->addDefine("SG_REQUEST_NORMALOS");
62 }
63
64 void modifyFragmentEndCode(QStringList* _code)
65 {
66 _code->push_back("#ifdef SG_INPUT_NORMALOS");
67 _code->push_back("outFragment = vec4(normalize(SG_INPUT_NORMALOS) * 0.5 + vec3(0.5, 0.5, 0.5),1.0);");
68 _code->push_back("#endif ");
69 }
70
71 static NormalFragmentModifier instance;
72 };
73
74
75 NormalFragmentModifier NormalFragmentModifier::instance;
76
77 // =================================================
78
79 NormalRenderer::NormalRenderer()
80 {
81 ACG::ShaderProgGenerator::registerModifier(&NormalFragmentModifier::instance);
82 }
83
84
85 NormalRenderer::~NormalRenderer()
86 {
87 }
88
89
90 void NormalRenderer::initializePlugin()
91 {
92 ACG::ShaderProgGenerator::setShaderDir(OpenFlipper::Options::shaderDirStr());
93 }
94
95 QString NormalRenderer::renderObjectsInfo(bool _outputShaderInfo) {
96 std::vector<ACG::ShaderModifier*> modifiers;
97 modifiers.push_back(&NormalFragmentModifier::instance);
98 return dumpCurrentRenderObjectsToString(&sortedObjects_[0], _outputShaderInfo, &modifiers);
99 }
100
101 void NormalRenderer::render(ACG::GLState* _glState, Viewer::ViewerProperties& _properties)
102 {
103 // collect renderobjects + prepare OpenGL state
104 prepareRenderingPipeline(_glState, _properties.drawMode(), PluginFunctions::getSceneGraphRootNode());
105
106 // render every object
107 for (int i = 0; i < getNumRenderObjects(); ++i) {
108
109 // Take original shader and modify the output to take only the normal as the color
110 GLSL::Program* prog = ACG::ShaderCache::getInstance()->getProgram(&sortedObjects_[i]->shaderDesc, NormalFragmentModifier::instance);
111 renderObject(sortedObjects_[i],prog);
112 }
113
114 // restore common opengl state
115 // log window remains hidden otherwise
116 finishRenderingPipeline();
117 }
118
119 QString NormalRenderer::checkOpenGL()
120 {
121 if (!ACG::openGLVersion(3,2))
122 return QString("Insufficient OpenGL Version! OpenGL 3.2 or higher required");
123
124 QString missing("");
125 if(!ACG::openGLVersion(1,5)) // extension is part of opengl spec since version 1.5
126 { // i recommend removing this check in favor of restricting
127 // to a more modern version of opengl e.g. 2.1 should be minimum
128 if ( !ACG::checkExtensionSupported("GL_ARB_vertex_buffer_object") )
129 missing += "GL_ARB_vertex_buffer_object extension missing\n";
130 }
131
132 #ifndef __APPLE__
133 if ( !ACG::checkExtensionSupported("GL_ARB_vertex_program") )
134 missing += "GL_ARB_vertex_program extension missing\n";
135 #endif
136
137 return missing;
138 }
139
140
141
Viewer::ViewerProperties
Definition: ViewerProperties.hh:107
ACG::GLState
Definition: GLState.hh:213
GlobalOptions.hh
PluginFunctions::getSceneGraphRootNode
ACG::SceneGraph::BaseNode * getSceneGraphRootNode()
get scenegraph root node
Definition: PluginFunctions.cc:959
Viewer::ViewerProperties::drawMode
void drawMode(ACG::SceneGraph::DrawModes::DrawMode _mode)
set draw mode (No test if this mode is available!)
Definition: ViewerProperties.cc:151
PluginFunctions.hh
ACG::ShaderGenerator::addDefine
void addDefine(const QString &_define)
Add one define.
Definition: ShaderGenerator.cc:470
ACG::ShaderGenerator
Definition: ShaderGenerator.hh:557
NormalFragmentModifier
Definition: NormalRenderer.cc:54
NormalFragmentModifier::modifyFragmentEndCode
void modifyFragmentEndCode(QStringList *_code)
Append code the the fragment shader.
Definition: NormalRenderer.cc:64
GLSL::Program
GLSL program class.
Definition: GLSLShader.hh:211
ACG::ShaderProgGenerator::setShaderDir
static void setShaderDir(QString _dir)
Definition: ShaderGenerator.cc:2446
ACG::ShaderCache::getInstance
static ShaderCache * getInstance()
Return instance of the ShaderCache singleton.
Definition: ShaderCache.cc:84
ACG::ShaderCache::getProgram
GLSL::Program * getProgram(const ShaderGenDesc *_desc, const std::vector< unsigned int > &_mods)
Query a dynamically generated program from cache.
Definition: ShaderCache.cc:102
ACG::openGLVersion
bool openGLVersion(const int _major, const int _minor, bool _verbose)
Definition: gl.cc:129
ACG::ShaderModifier
Definition: ShaderGenerator.hh:969
NormalFragmentModifier::modifyVertexIO
void modifyVertexIO(ACG::ShaderGenerator *_shader)
Add your own inputs/outputs to the vertex shader.
Definition: NormalRenderer.cc:58
ACG::checkExtensionSupported
bool checkExtensionSupported(const std::string &_extension)
Definition: gl.cc:107
ACG::ShaderProgGenerator::registerModifier
static unsigned int registerModifier(ShaderModifier *_modifier)
Shader modifiers have to be registered before they can be used. They also must remain allocated for t...
Definition: ShaderGenerator.cc:2457
NormalRenderer::renderObjectsInfo
QString renderObjectsInfo(bool _outputShaderInfo)
Return a qstring of the current render objects.
Definition: NormalRenderer.cc:95