gpu_coverage::AbstractRenderer Class Reference

Abstract superclass for all renderers. More...

#include <AbstractRenderer.h>

Inheritance diagram for gpu_coverage::AbstractRenderer:

Public Member Functions
	AbstractRenderer (const Scene *const scene, const std::string &name)
	Constructor. More...
virtual	~AbstractRenderer ()
	Destructor.
virtual void	display ()=0
	Renders the scene. More...
virtual const GLuint &	getTexture () const =0
	Returns the OpenGL texture ID of the result texture. More...
virtual const int &	getTextureWidth () const =0
	Width of the result texture. More...
virtual const int &	getTextureHeight () const =0
	Height of the result texture. More...
const bool &	isReady () const
	Returns true if the renderer has been initialized correctly. More...
const std::string &	getName () const
	Returns the name of the renderer for logging purposes. More...

Protected Attributes
const Scene *const	scene
	Pointer to the scene to be rendered.
const std::string	name
	Name of the renderer, see getName().
bool	ready
	Set to true when renderer is ready, see isReady().

Detailed Description

Abstract superclass for all renderers.

Subclasses must implement the following methods:

• display(): renders the scene
• getTexture(): returns the OpenGL texture ID of the result
• getTextureWidth() and getTextureHeight(): return the dimensions of the result texture

Constructor & Destructor Documentation

gpu_coverage::AbstractRenderer::AbstractRenderer	(	const Scene *const	scene,
		const std::string &	name
	)

Constructor.

Parameters

[in]	scene	Scene to be rendered.
[in]	name	Human-readable name for this renderer, used for logging.

Member Function Documentation

virtual void gpu_coverage::AbstractRenderer::display ( )

pure virtual

Renders the scene.

This method does the main work of the renderer.

Implemented in gpu_coverage::VisibilityRenderer, gpu_coverage::Renderer, gpu_coverage::PanoEvalRenderer, gpu_coverage::PanoRenderer, gpu_coverage::BellmanFordRenderer, gpu_coverage::CostMapRenderer, and gpu_coverage::BellmanFordXfbRenderer.

const std::string& gpu_coverage::AbstractRenderer::getName ( ) const

inline

Returns the name of the renderer for logging purposes.

Returns

Name of the renderer.

virtual const GLuint& gpu_coverage::AbstractRenderer::getTexture ( ) const

pure virtual

Returns the OpenGL texture ID of the result texture.

Returns

OpenGL texture ID.

Implemented in gpu_coverage::VisibilityRenderer, gpu_coverage::Renderer, gpu_coverage::PanoEvalRenderer, gpu_coverage::PanoRenderer, gpu_coverage::BellmanFordRenderer, gpu_coverage::CostMapRenderer, and gpu_coverage::BellmanFordXfbRenderer.

virtual const int& gpu_coverage::AbstractRenderer::getTextureHeight ( ) const

pure virtual

Height of the result texture.

Returns

Height in pixels.

Implemented in gpu_coverage::VisibilityRenderer, gpu_coverage::Renderer, gpu_coverage::PanoRenderer, gpu_coverage::BellmanFordRenderer, gpu_coverage::CostMapRenderer, gpu_coverage::BellmanFordXfbRenderer, and gpu_coverage::PanoEvalRenderer.

virtual const int& gpu_coverage::AbstractRenderer::getTextureWidth ( ) const

pure virtual

Width of the result texture.

Returns

Width in pixels.

Implemented in gpu_coverage::VisibilityRenderer, gpu_coverage::Renderer, gpu_coverage::PanoRenderer, gpu_coverage::BellmanFordRenderer, gpu_coverage::CostMapRenderer, gpu_coverage::BellmanFordXfbRenderer, and gpu_coverage::PanoEvalRenderer.

const bool& gpu_coverage::AbstractRenderer::isReady ( ) const

inline

Returns true if the renderer has been initialized correctly.

Returns

True if renderer is ready.

---

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

• include/gpu_coverage/AbstractRenderer.h