RenderInterface.hh 5.93 KB
Newer Older
Jan Möbius's avatar
Jan Möbius committed
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 <http://www.gnu.org/licenses/>.                                       *
*                                                                            *
\*===========================================================================*/

/*===========================================================================*\
*                                                                            *
*   $Revision$                                                       *
*   $LastChangedBy$                                                *
*   $Date$                     *
*                                                                            *
\*===========================================================================*/


#ifndef RENDERINTERFACE_HH
#define RENDERINTERFACE_HH

#include <ACG/Scenegraph/DrawModes.hh>
48
#include <OpenFlipper/common/ViewerProperties.hh>
Jan Möbius's avatar
Jan Möbius committed
49 50 51

/** \file RenderInterface.hh
*
52
* Interface for adding global rendering functions. \ref renderInterfacePage
Jan Möbius's avatar
Jan Möbius committed
53 54 55 56
*/

/** \brief Interface to add additional rendering functions from within plugins.
 *
57
 * \ref renderInterfacePage "Detailed description"
Jan Möbius's avatar
Jan Möbius committed
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's avatar
Jan Möbius committed
72
    /** \brief announce required draw modes
Jan Möbius's avatar
Jan Möbius committed
73
     *
Jan Möbius's avatar
Jan Möbius committed
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
78
     * the drawmode(s), the core will ask the user for its preference.
Jan Möbius's avatar
Jan Möbius committed
79
     *
Jan Möbius's avatar
Jan Möbius committed
80
     * @param _mode Combined list of drawmodes
Jan Möbius's avatar
Jan Möbius committed
81
     */
Jan Möbius's avatar
Jan Möbius committed
82
    virtual void supportedDrawModes(ACG::SceneGraph::DrawModes::DrawMode& _mode) = 0;
Jan Möbius's avatar
Jan Möbius committed
83 84 85 86

    /** \brief announce name for the rendering function
     *
     *
Jan Möbius's avatar
Jan Möbius committed
87
     * @return Name displayed for the rendering function
Jan Möbius's avatar
Jan Möbius committed
88
     */
Jan Möbius's avatar
Jan Möbius committed
89
    virtual QString rendererName() = 0;
Jan Möbius's avatar
Jan Möbius committed
90

Jan Möbius's avatar
Jan Möbius committed
91
  public slots:
Jan Möbius's avatar
Jan Möbius committed
92

Jan Möbius's avatar
Jan Möbius committed
93
    /** \brief rendering function
Jan Möbius's avatar
Jan Möbius committed
94
     *
Jan Möbius's avatar
Jan Möbius committed
95 96 97 98 99
     * 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's avatar
Jan Möbius committed
100
     */
101 102 103 104 105 106 107 108 109 110 111
    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's avatar
Jan Möbius committed
112 113 114

};

115
/** \page renderInterfacePage Render Interface
Jan Möbius's avatar
Jan Möbius committed
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
\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:
<ul>
<li> include RenderInterface.hh in your plugins header file
<li> derive your plugin from the class RenderInterface
<li> add Q_INTERFACES(RenderInterface) to your plugin class
<li> And add the signals or slots you want to use to your plugin class (You don't need to implement all of them)
</ul>

*/


Q_DECLARE_INTERFACE(RenderInterface,"OpenFlipper.RenderInterface/1.0")

#endif // RPCINTERFACE_HH