Equalizer  2.0.0
Parallel Rendering Framework
renderer.h
1 
2 /* Copyright (c) 2011-2016, Stefan Eilemann <eile@eyescale.ch>
3  * Daniel Nachbaur <danielnachbaur@gmail.com>
4  * Petros Kataras <petroskataras@gmail.com>
5  *
6  * This library is free software; you can redistribute it and/or modify it under
7  * the terms of the GNU Lesser General Public License version 2.1 as published
8  * by the Free Software Foundation.
9  *
10  * This library is distributed in the hope that it will be useful, but WITHOUT
11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12  * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
13  * details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * along with this library; if not, write to the Free Software Foundation, Inc.,
17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18  */
19 
20 #ifndef EQSEQUEL_RENDERER_H
21 #define EQSEQUEL_RENDERER_H
22 
23 #include <co/objectFactory.h> // interface
24 #include <seq/types.h>
25 
26 namespace seq
27 {
34 class Renderer : public co::ObjectFactory
35 {
36 public:
38  SEQ_API explicit Renderer( Application& application );
39 
41  SEQ_API virtual ~Renderer();
42 
56  SEQ_API virtual bool init( co::Object* initData LB_UNUSED )
57  { return true; }
58 
68  SEQ_API virtual bool exit() { return true; }
69 
81  SEQ_API virtual bool initContext( co::Object* initData );
82 
91  SEQ_API virtual bool exitContext();
92 
100  SEQ_API virtual void clear( co::Object* frameData );
101 
109  virtual void draw( co::Object* frameData ) = 0;
110 
112  SEQ_API void requestRedraw();
113 
120  SEQ_API void updateNearFar( const Vector4f& boundingSphere );
121 
132  SEQ_API void setNearFar( const float nearPlane, const float farPlane );
133 
143  SEQ_API virtual void applyRenderContext();
144 
150  SEQ_API void bindDrawFrameBuffer();
151 
153  SEQ_API const RenderContext& getRenderContext() const;
154 
164  SEQ_API virtual void applyModelMatrix();
165 
173  SEQ_API virtual void applyScreenFrustum();
174 
179  SEQ_API virtual void applyPerspectiveFrustum();
180 
185  virtual bool processEvent( EventType ) { return false; }
186  virtual bool processEvent( EventType, const SizeEvent& ) { return false; }
187  virtual bool processEvent( EventType, const PointerEvent& ){ return false; }
188  virtual bool processEvent( EventType, const KeyEvent& ) { return false; }
189  virtual bool processEvent( EventType, const AxisEvent& ) { return false; }
190  virtual bool processEvent( EventType, const ButtonEvent& ) { return false; }
192 
195  detail::Renderer* getImpl() { return _impl; }
196 
202  SEQ_API co::Object* getFrameData();
203 
205  Application& getApplication() { return app_; }
206 
208  const Application& getApplication() const { return app_; }
209 
211  SEQ_API const ObjectManager& getObjectManager() const;
212 
214  SEQ_API ObjectManager& getObjectManager();
215 
227  SEQ_API virtual ViewData* createViewData( View& view );
228 
230  SEQ_API virtual void destroyViewData( ViewData* viewData );
231 
233  SEQ_API const ViewData* getViewData() const;
234 
248  SEQ_API const GLEWContext* glewGetContext() const;
249 
251  SEQ_API const Frustumf& getFrustum() const;
252 
254  SEQ_API const Matrix4f& getViewMatrix() const;
255 
257  SEQ_API const Matrix4f& getModelMatrix() const;
258 
260  SEQ_API const PixelViewport& getPixelViewport() const;
261 
266  SEQ_API uint32_t getWindowID() const;
268 
272  SEQ_API virtual co::Object* createObject( const uint32_t type );
273 
275  SEQ_API virtual void destroyObject( co::Object* object,
276  const uint32_t type );
277 
287  SEQ_API co::Object* mapObject( const uint128_t& identifier,
288  co::Object* instance );
289 
298  SEQ_API bool unmap( co::Object* object );
300 
301 private:
302  detail::Renderer* const _impl;
303  Application& app_;
304 };
305 }
306 #endif // EQSEQUEL_RENDERER_H
const Application & getApplication() const
Definition: renderer.h:208
virtual SEQ_API void clear(co::Object *frameData)
Clear the frame buffer.
SEQ_API void bindDrawFrameBuffer()
Bind the window draw buffer, which can be (multisampled) FBO or window buffer.
SEQ_API const Matrix4f & getModelMatrix() const
virtual void draw(co::Object *frameData)=0
Render the scene.
SEQ_API const ViewData * getViewData() const
virtual bool processEvent(EventType)
Definition: renderer.h:185
virtual SEQ_API ~Renderer()
Destruct this renderer.
The main application object.
Definition: application.h:29
SEQ_API void updateNearFar(const Vector4f &boundingSphere)
Update the near and far planes to tightly enclose the given sphere.
SEQ_API co::Object * getFrameData()
SEQ_API const Frustumf & getFrustum() const
SEQ_API void setNearFar(const float nearPlane, const float farPlane)
Set the near and far planes.
virtual SEQ_API bool initContext(co::Object *initData)
Initialize a rendering context.
SEQ_API const GLEWContext * glewGetContext() const
Get the GLEW context for this renderer.
virtual SEQ_API ViewData * createViewData(View &view)
Create a new per-view data instance.
SEQ_API bool unmap(co::Object *object)
Unmap an object from the object map.
virtual SEQ_API void applyPerspectiveFrustum()
Apply the perspective frustum matrix for the current rendering task.
A renderer instance.
Definition: renderer.h:34
Stores per-view data.
Definition: viewData.h:30
virtual SEQ_API bool init(co::Object *initData)
Initialize the renderer.
Definition: renderer.h:56
virtual SEQ_API void applyRenderContext()
Apply the current rendering parameters to the rendering context.
SEQ_API const PixelViewport & getPixelViewport() const
virtual SEQ_API co::Object * createObject(const uint32_t type)
A View is a 2D area of a Layout.
Definition: view.h:42
Application & getApplication()
Definition: renderer.h:205
SEQ_API Renderer(Application &application)
Construct a new renderer.
SEQ_API const RenderContext & getRenderContext() const
SEQ_API uint32_t getWindowID() const
Sequel - A simple interface to the Equalizer parallel rendering framework.
Definition: application.h:26
virtual SEQ_API void destroyViewData(ViewData *viewData)
Delete the given view data.
A facility class to manage OpenGL objects across shared contexts.
Definition: objectManager.h:53
SEQ_API co::Object * mapObject(const uint128_t &identifier, co::Object *instance)
Map and return an object.
SEQ_API const Matrix4f & getViewMatrix() const
virtual SEQ_API bool exit()
De-initialize the renderer.
Definition: renderer.h:68
virtual SEQ_API void applyScreenFrustum()
Apply an orthographic frustum for pixel-based 2D operations.
virtual SEQ_API void destroyObject(co::Object *object, const uint32_t type)
virtual SEQ_API bool exitContext()
De-initialize a rendering context.
SEQ_API void requestRedraw()
Request another call to draw().
The context applied to a channel during rendering operations.
Definition: renderContext.h:37
SEQ_API const ObjectManager & getObjectManager() const
virtual SEQ_API void applyModelMatrix()
Apply the current model matrix to the rendering context.