Developer Documentation
RenderInterface.hh
Go to the documentation of this file.
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 #pragma once
43 
44 #include <ACG/Scenegraph/DrawModes.hh>
46 
61 
62  public:
63 
65  virtual ~RenderInterface() {};
66 
67  private slots:
68 
80 
86  virtual QString rendererName() = 0;
87 
117  virtual QString checkOpenGL() = 0;
118 
119  public slots:
120 
129  virtual void render(ACG::GLState* _glState, Viewer::ViewerProperties& _properties) {};
130 
139  virtual QAction* optionsAction() { return 0; };
140 
152  virtual QString renderObjectsInfo(bool _outputShaderInfo) { return QString("Render object inforation not implemented in this plugin"); };
153 
154 
159  virtual void reloadShaders() { };
160 
161 
162 };
163 
190 Q_DECLARE_INTERFACE(RenderInterface,"OpenFlipper.RenderInterface/1.0")
191 
virtual QString renderObjectsInfo(bool _outputShaderInfo)
Return a qstring of the current render objects.
virtual void supportedDrawModes(ACG::SceneGraph::DrawModes::DrawMode &_mode)=0
announce required draw modes
virtual QString checkOpenGL()=0
Check OpenGL capabilities.
Interface to add additional rendering functions from within plugins.
virtual void reloadShaders()
Reload any renderer specific shaders.
virtual QString rendererName()=0
announce name for the rendering function
virtual void render(ACG::GLState *_glState, Viewer::ViewerProperties &_properties)
rendering function
virtual ~RenderInterface()
Destructor.
virtual QAction * optionsAction()
Return options menu.