RenderInterface.hh 7.87 KB
 Jan Möbius committed Sep 06, 2011 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 /*===========================================================================*\ * * * OpenFlipper * * Copyright (C) 2001-2011 by Computer Graphics Group, RWTH Aachen * * www.openflipper.org * * * *--------------------------------------------------------------------------- * * This file is part of OpenFlipper. * * * * OpenFlipper is free software: you can redistribute it and/or modify * * it under the terms of the GNU Lesser General Public License as * * published by the Free Software Foundation, either version 3 of * * the License, or (at your option) any later version with the * * following exceptions: * * * * If other files instantiate templates or use macros * * or inline functions from this file, or you compile this file and * * link it with other files to produce an executable, this file does * * not by itself cause the resulting executable to be covered by the * * GNU Lesser General Public License. This exception does not however * * invalidate any other reasons why the executable file might be * * covered by the GNU Lesser General Public License. * * * * OpenFlipper is distributed in the hope that it will be useful, * * but WITHOUT ANY WARRANTY; without even the implied warranty of * * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * * GNU Lesser General Public License for more details. * * * * You should have received a copy of the GNU LesserGeneral Public * * License along with OpenFlipper. If not, * * see . * * * \*===========================================================================*/ /*===========================================================================*\ * * * $Revision$ * * $LastChangedBy$ * * $Date$ * * * \*===========================================================================*/ #ifndef RENDERINTERFACE_HH #define RENDERINTERFACE_HH #include  Jan Möbius committed Sep 09, 2011 48 #include  Jan Möbius committed Sep 06, 2011 49 50 51  /** \file RenderInterface.hh *  Jan Möbius committed Oct 26, 2011 52 * Interface for adding global rendering functions. \ref renderInterfacePage  Jan Möbius committed Sep 06, 2011 53 54 55 56 */ /** \brief Interface to add additional rendering functions from within plugins. *  Jan Möbius committed Oct 26, 2011 57  * \ref renderInterfacePage "Detailed description"  Jan Möbius committed Sep 06, 2011 58 59 60 61 62 63 64 65 66 67 68 69 70 71  * \n * \n * * Interface for adding and controlling rendering functions from a plugin.\n */ class RenderInterface { public: /// Destructor virtual ~RenderInterface() {}; private slots:  Jan Möbius committed Sep 06, 2011 72  /** \brief announce required draw modes  Jan Möbius committed Sep 06, 2011 73  *  Jan Möbius committed Sep 06, 2011 74 75 76 77  * This function is called by the core to get a list of draw modes that are supported * by this renderer. If such a draw mode is set and the currently active * renderer does not support the given mode, the core will switch to * this renderer automatically. If there are multiple renderers capable of rendering  Jan Möbius committed Sep 06, 2011 78  * the drawmode(s), the core will ask the user for its preference.  Jan Möbius committed Sep 06, 2011 79  *  Jan Möbius committed Sep 06, 2011 80  * @param _mode Combined list of drawmodes  Jan Möbius committed Sep 06, 2011 81  */  Jan Möbius committed Sep 09, 2011 82  virtual void supportedDrawModes(ACG::SceneGraph::DrawModes::DrawMode& _mode) = 0;  Jan Möbius committed Sep 06, 2011 83 84 85 86  /** \brief announce name for the rendering function * *  Jan Möbius committed Feb 29, 2012 87  * @return Name displayed for the rendering function  Jan Möbius committed Sep 06, 2011 88  */  Jan Möbius committed Sep 06, 2011 89  virtual QString rendererName() = 0;  Jan Möbius committed Sep 06, 2011 90   Jan Möbius committed Oct 16, 2012 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124  /** \brief Check OpenGL capabilities * * This function has to be implemented and checks, if all required OpenGL extensions are available. * If this is not the case, the plugin will be refused by the core to avoid crashes due to insufficient * OpenGL support. * * You can get the version information in the following way: * * \code * * // Get version and check * QGLFormat::OpenGLVersionFlags flags = QGLFormat::openGLVersionFlags(); * if ( ! flags.testFlag(QGLFormat::OpenGL_Version_2_1) ) * return QString("Insufficient OpenGL Version! OpenGL 2.1 or higher required"); * * //Get OpenGL extensions * QString glExtensions = QString((const char*)glGetString(GL_EXTENSIONS)); * * // Collect missing extension * QString missing = ""; * * if ( !glExtensions.contains("GL_ARB_vertex_buffer_object") ) * missing += "Missing Extension GL_ARB_vertex_buffer_object\n"; * * if ( !glExtensions.contains("GL_ARB_vertex_program") ) * missing += "Missing Extension GL_ARB_vertex_program\n"; * * return missing; * \endcode * * @return Return an empty string if everything is fine, otherwise return, what features are missing. */ virtual QString checkOpenGL() = 0;  Jan Möbius committed Sep 09, 2011 125  public slots:  Jan Möbius committed Sep 06, 2011 126   Jan Möbius committed Sep 09, 2011 127  /** \brief rendering function  Jan Möbius committed Sep 06, 2011 128  *  Jan Möbius committed Sep 09, 2011 129 130 131 132 133  * Implement this function to render the scene. You have to traverse the * scenegraph in this function. The glContext is made current before this * call. * If you need to initialize something,you can do it within this function. * gl and glew are already setUp here.  Jan Möbius committed Sep 06, 2011 134  */  Jan Möbius committed Sep 09, 2011 135 136 137 138 139 140 141 142 143 144 145  virtual void render(ACG::GLState* _glState, Viewer::ViewerProperties& _properties) {}; /** \brief Return options menu * * If you want an options Menu or menu entry, you can return your action here. * It will be shown on top of the renderer list in the options menu. * * * @return Action for a menu or menu entry */ virtual QAction* optionsAction() { return 0; };  Jan Möbius committed Sep 06, 2011 146   Jan Möbius committed Feb 06, 2013 147 148 149 150 151 152 153 154  /** \brief Return a qstring of the current render objects * * In this function your plugin should return a list of the render objects * (possibly with additional information). It can be used for debugging purposes. * * The IRenderer class already has a function called dumpCurrentRenderObjectsToString() * which can be used to implement this function. *  Jan Möbius committed Feb 08, 2013 155  * @param _outputShaderInfo Output shader code along with the render objects  Jan Möbius committed Feb 06, 2013 156 157  * @return string of render objects */  Jan Möbius committed Feb 08, 2013 158  virtual QString renderObjectsInfo(bool _outputShaderInfo) { return QString("Render object inforation not implemented in this plugin"); };  Jan Möbius committed Feb 06, 2013 159   Jan Möbius committed Oct 16, 2012 160 161   Jan Möbius committed Sep 06, 2011 162 163 };  Jan Möbius committed Oct 26, 2011 164 /** \page renderInterfacePage Render Interface  Jan Möbius committed Sep 06, 2011 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 \image html RenderInterface.png \n The RenderInterface can be used by plugins to add special rendering functions to OpenFlipper. You can create a dedicated rendering function for a drawmode. E.g. when you need to render 4 passes with different shaders you can do that in your rendering function. Example Code for functions: \code TODO \endcode To use the RenderInterface:
*/ Q_DECLARE_INTERFACE(RenderInterface,"OpenFlipper.RenderInterface/1.0") #endif // RPCINTERFACE_HH