vl::RenderingAbstract Class Reference

The RenderingAbstract class is the base of all the rendering related sub-classes. More...

#include <RenderingAbstract.hpp>

Inheritance diagram for vl::RenderingAbstract:

List of all members.

Public Member Functions
	RenderingAbstract ()
	Constructor.
virtual void	render ()=0
	Executes the rendering.
RenderingAbstract &	operator= (const RenderingAbstract &other)
void	dispatchOnRenderingStarted ()
	Calls the RenderEventCallback::onRenderingStarted() method of all the active callback objects.
void	dispatchOnRenderingFinished ()
	Calls the RenderEventCallback::onRenderingFinished() method of all the active callback objects.
Collection< RenderEventCallback > *	onStartedCallbacks ()
	Returns the list of RenderEventCallback objects registered to the onRenderingStarted() event notification.
const Collection < RenderEventCallback > *	onStartedCallbacks () const
	Returns the list of RenderEventCallback objects registered to the onRenderingStarted() event notification.
Collection< RenderEventCallback > *	onFinishedCallbacks ()
	Returns the list of RenderEventCallback objects registered to the onRenderingFinished() event notification.
const Collection < RenderEventCallback > *	onFinishedCallbacks () const
	Returns the list of RenderEventCallback objects registered to the onRenderingFinished() event notification.
void	setEnableMask (unsigned int mask)
	The enable mask of the Rendering, used to define wheter the rendering is enabled or not, and which objects should be rendered.
unsigned int	enableMask () const
	The enable mask of the Rendering, used to define wheter the rendering is enabled or not, and which objects should be rendered.
bool	isEnabled (unsigned int mask)
	Utility function equivalent to "(mask & mEnableMask) != 0".
void	setFrameClock (Real cur_time)
	The update time of the current rendering frame.
Real	frameClock () const
	The update time of the current rendering frame.
Protected Attributes
ref< Collection < RenderEventCallback > >	mOnStartedCallbacks
ref< Collection < RenderEventCallback > >	mOnFinishedCallbacks
Real	mFrameClock
unsigned int	mEnableMask

---

Detailed Description

The RenderingAbstract class is the base of all the rendering related sub-classes.

---

Constructor & Destructor Documentation

RenderingAbstract::RenderingAbstract

(

)

Constructor.

---

Member Function Documentation

virtual void vl::RenderingAbstract::render

(

)

[pure virtual]

Executes the rendering.

Implemented in vl::Rendering, and vl::RenderingTree.

RenderingAbstract & RenderingAbstract::operator=

(

const RenderingAbstract &

other )

void RenderingAbstract::dispatchOnRenderingStarted

(

)

Calls the RenderEventCallback::onRenderingStarted() method of all the active callback objects.

void RenderingAbstract::dispatchOnRenderingFinished

(

)

Calls the RenderEventCallback::onRenderingFinished() method of all the active callback objects.

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

(

)

[inline]

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

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

(

)

const [inline]

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

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

(

)

[inline]

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

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

(

)

const [inline]

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

void vl::RenderingAbstract::setEnableMask

(

unsigned int

mask )

[inline]

The enable mask of the Rendering, used to define wheter the rendering is enabled or not, and which objects should be rendered.

See also:

vl::Actor::setEnableMask()

unsigned int vl::RenderingAbstract::enableMask

(

)

const [inline]

The enable mask of the Rendering, used to define wheter the rendering is enabled or not, and which objects should be rendered.

bool vl::RenderingAbstract::isEnabled

(

unsigned int

mask )

[inline]

Utility function equivalent to "(mask & mEnableMask) != 0".

void vl::RenderingAbstract::setFrameClock

(

Real

cur_time )

[inline]

The update time of the current rendering frame.

Real vl::RenderingAbstract::frameClock

(

)

const [inline]

The update time of the current rendering frame.

---

Member Data Documentation

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

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

Real vl::RenderingAbstract::mFrameClock [protected]

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

---

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

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