Om  1.0.0
A universal framework for multimedia simulation
Classes | Public Member Functions | Protected Attributes | List of all members
om::graphics::renderers::SceneRenderer Class Referenceabstract

An interface for classes that draw graphics scenes. More...

#include <omGraphicsSceneRenderer.h>

Inheritance diagram for om::graphics::renderers::SceneRenderer:
om::graphics::renderers::Renderer om::graphics::renderers::ForwardRenderer om::graphics::renderers::RayRenderer

Classes

class  Delegate
 A class that contains function objects that respond to scene renderer events. More...
 

Public Member Functions

virtual Bool renderScene (const SceneRenderRequest &request)=0
 Render a scene to the current framebuffer using the parameters of the specified request. More...
 
DelegategetDelegate ()
 Return an object that handles events for this context renderer. More...
 
const DelegategetDelegate () const
 Return an object that handles events for this context renderer. More...
 
void setDelegate (const Delegate &newDelegate)
 Set an object that handles events for this context renderer. More...
 
- Public Member Functions inherited from om::graphics::renderers::Renderer
virtual ~Renderer ()
 Destroy a renderer object. More...
 
virtual void render ()
 Do the main rendering for this renderer. More...
 
GraphicsContextgetContext () const
 Return a pointer to the graphics context that the renderer is using. More...
 
virtual void setContext (GraphicsContext *newContext)
 Set a pointer to the graphics context that this renderer should use. More...
 
void clearContext ()
 Clear the previous context from this object. More...
 

Protected Attributes

Delegate delegate
 An object that responds to events for this scene renderer. More...
 
- Protected Attributes inherited from om::graphics::renderers::Renderer
GraphicsContextcontext
 A pointer to the graphics context this object is using. More...
 

Additional Inherited Members

- Protected Member Functions inherited from om::graphics::renderers::Renderer
 Renderer ()
 Create a new graphics renderer that doesn't have an associated graphics context. More...
 
 Renderer (GraphicsContext *newContext)
 Create a new graphics renderer that uses the specified context for rendering. More...
 

Detailed Description

An interface for classes that draw graphics scenes.

Member Function Documentation

virtual Bool om::graphics::renderers::SceneRenderer::renderScene ( const SceneRenderRequest request)
pure virtual

Render a scene to the current framebuffer using the parameters of the specified request.

The method returns whether or not the rendering was successful.

Implemented in om::graphics::renderers::ForwardRenderer, and om::graphics::renderers::RayRenderer.

Delegate& om::graphics::renderers::SceneRenderer::getDelegate ( )
inline

Return an object that handles events for this context renderer.

const Delegate& om::graphics::renderers::SceneRenderer::getDelegate ( ) const
inline

Return an object that handles events for this context renderer.

void om::graphics::renderers::SceneRenderer::setDelegate ( const Delegate newDelegate)
inline

Set an object that handles events for this context renderer.

Member Data Documentation

Delegate om::graphics::renderers::SceneRenderer::delegate
protected

An object that responds to events for this scene renderer.


The documentation for this class was generated from the following file: