vl::RendererAbstract Class Reference

#include <RendererAbstract.hpp>

Inheritance diagram for vl::RendererAbstract:

List of all members.

Public Member Functions
	RendererAbstract ()
RendererAbstract &	operator= (const RendererAbstract &other)
virtual const RenderQueue *	render (const RenderQueue *in_render_queue, Camera *camera, Real frame_clock)=0
	Takes as input the render queue to render and returns a possibly filtered render queue for further processing.
virtual const RenderTarget *	renderTarget () const =0
	The RenderTarget on which the rendering is performed.
virtual RenderTarget *	renderTarget ()=0
	The RenderTarget on which the rendering is performed.
void	dispatchOnRendererStarted ()
void	dispatchOnRendererFinished ()
Collection< RenderEventCallback > *	onFinishedCallbacks ()
	Returns the list of RenderEventCallback objects registered to onRendererFinished() event notification.
const Collection < RenderEventCallback > *	onFinishedCallbacks () const
	Returns the list of RenderEventCallback objects registered to onRendererFinished() event notification.
Collection< RenderEventCallback > *	onStartedCallbacks ()
	Returns the list of RenderEventCallback objects registered to onRendererStarted() event notification.
const Collection < RenderEventCallback > *	onStartedCallbacks () const
	Returns the list of RenderEventCallback objects registered to onRendererStarted() event notification.
unsigned long	renderTick () const
	The current render tick number, equivalent to the number or calls made to the render() method.
void	incrementRenderTick ()
	Increments the rendering tick count.
void	setClearFlags (EClearFlags clear_flags)
EClearFlags	clearFlags () const
void	setEnableMask (unsigned int mask)
unsigned int	enableMask () const
void	setFrameClock (Real t)
Real	frameClock () const
Protected Attributes
ref< Collection < RenderEventCallback > >	mOnFinishedCallbacks
ref< Collection < RenderEventCallback > >	mOnStartedCallbacks
unsigned long	mRenderTick
unsigned int	mEnableMask
EClearFlags	mClearFlags
Real	mFrameClock

---

Constructor & Destructor Documentation

vl::RendererAbstract::RendererAbstract

(

)

[inline]

---

Member Function Documentation

RendererAbstract& vl::RendererAbstract::operator=

(

const RendererAbstract &

other )

[inline]

virtual const RenderQueue* vl::RendererAbstract::render	(	const RenderQueue *	in_render_queue,
		Camera *	camera,
		Real	frame_clock
	)		[pure virtual]

Takes as input the render queue to render and returns a possibly filtered render queue for further processing.

Renderer's implementation of this function always returns in_render_queue.

Implemented in vl::EdgeRenderer, vl::OcclusionCullRenderer, and vl::Renderer.

virtual const RenderTarget* vl::RendererAbstract::renderTarget

(

)

const [pure virtual]

The RenderTarget on which the rendering is performed.

Implemented in vl::OcclusionCullRenderer, and vl::Renderer.

virtual RenderTarget* vl::RendererAbstract::renderTarget

(

)

[pure virtual]

The RenderTarget on which the rendering is performed.

Implemented in vl::OcclusionCullRenderer, and vl::Renderer.

void vl::RendererAbstract::dispatchOnRendererStarted

(

)

[inline]

void vl::RendererAbstract::dispatchOnRendererFinished

(

)

[inline]

Collection<RenderEventCallback>* vl::RendererAbstract::onFinishedCallbacks

(

)

[inline]

Returns the list of RenderEventCallback objects registered to onRendererFinished() event notification.

const Collection<RenderEventCallback>* vl::RendererAbstract::onFinishedCallbacks

(

)

const [inline]

Returns the list of RenderEventCallback objects registered to onRendererFinished() event notification.

Collection<RenderEventCallback>* vl::RendererAbstract::onStartedCallbacks

(

)

[inline]

Returns the list of RenderEventCallback objects registered to onRendererStarted() event notification.

const Collection<RenderEventCallback>* vl::RendererAbstract::onStartedCallbacks

(

)

const [inline]

Returns the list of RenderEventCallback objects registered to onRendererStarted() event notification.

unsigned long vl::RendererAbstract::renderTick

(

)

const [inline]

The current render tick number, equivalent to the number or calls made to the render() method.

void vl::RendererAbstract::incrementRenderTick

(

)

[inline]

Increments the rendering tick count.

void vl::RendererAbstract::setClearFlags

(

EClearFlags

clear_flags )

[inline]

EClearFlags vl::RendererAbstract::clearFlags

(

)

const [inline]

void vl::RendererAbstract::setEnableMask

(

unsigned int

mask )

[inline]

unsigned int vl::RendererAbstract::enableMask

(

)

const [inline]

void vl::RendererAbstract::setFrameClock

(

Real

t )

[inline]

Real vl::RendererAbstract::frameClock

(

)

const [inline]

---

Member Data Documentation

ref< Collection<RenderEventCallback> > vl::RendererAbstract::mOnFinishedCallbacks [protected]

ref< Collection<RenderEventCallback> > vl::RendererAbstract::mOnStartedCallbacks [protected]

unsigned long vl::RendererAbstract::mRenderTick [protected]

unsigned int vl::RendererAbstract::mEnableMask [protected]

EClearFlags vl::RendererAbstract::mClearFlags [protected]

Real vl::RendererAbstract::mFrameClock [protected]

---

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

• C:/VL/BuildSystem/VL_DISTRO/Visualization_Library_SDK/src/vl/RendererAbstract.hpp