# Visualization Library

A lightweight C++ OpenGL middleware for 2D/3D graphics

[Home] [Tutorials] [All Classes] [Grouped Classes]

Public Member Functions | Protected Attributes

# 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

virtual const char * | className ()
| Returns the name of the class.
| 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.

Definition at line 44 of file RenderingAbstract.hpp.

## Constructor & Destructor Documentation

RenderingAbstract::RenderingAbstract | ( | ) |

Constructor.

Definition at line 39 of file RenderingAbstract.cpp.

References mEnableMask, mFrameClock, mOnFinishedCallbacks, mOnStartedCallbacks, and VL_DEBUG_SET_OBJECT_NAME.

## Member Function Documentation

virtual const char* vl::RenderingAbstract::className | ( | ) | `[inline, virtual]`

Returns the name of the class.

Reimplemented from vl::Object.

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

Definition at line 47 of file RenderingAbstract.hpp.

virtual void vl::RenderingAbstract::render | ( | ) | `[pure virtual]`

Executes the rendering.

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

Referenced by vl::RenderingTree::render(), and vl::Applet::updateEvent().

RenderingAbstract & RenderingAbstract::operator= | ( | const RenderingAbstract & | other ) |

Definition at line 48 of file RenderingAbstract.cpp.

References mEnableMask, mFrameClock, mOnFinishedCallbacks, and mOnStartedCallbacks.

void RenderingAbstract::dispatchOnRenderingStarted | ( | ) |

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

Definition at line 59 of file RenderingAbstract.cpp.

References vl::Collection< T >::eraseAt(), isEnabled(), mOnStartedCallbacks, onStartedCallbacks(), and vl::Collection< T >::size().

Referenced by vl::RenderingTree::render().

void RenderingAbstract::dispatchOnRenderingFinished | ( | ) |

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

Definition at line 72 of file RenderingAbstract.cpp.

References vl::Collection< T >::eraseAt(), isEnabled(), mOnFinishedCallbacks, onFinishedCallbacks(), and vl::Collection< T >::size().

Referenced by vl::RenderingTree::render().

Collection<RenderEventCallback>* vl::RenderingAbstract::onStartedCallbacks | ( | ) | `[inline]`

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

Definition at line 64 of file RenderingAbstract.hpp.

Referenced by dispatchOnRenderingStarted().

const Collection<RenderEventCallback>* vl::RenderingAbstract::onStartedCallbacks | ( | ) | const`[inline]`

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

Definition at line 67 of file RenderingAbstract.hpp.

Collection<RenderEventCallback>* vl::RenderingAbstract::onFinishedCallbacks | ( | ) | `[inline]`

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

Definition at line 70 of file RenderingAbstract.hpp.

Referenced by dispatchOnRenderingFinished(), and vl::Applet::keyReleaseEvent().

const Collection<RenderEventCallback>* vl::RenderingAbstract::onFinishedCallbacks | ( | ) | const`[inline]`

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

Definition at line 73 of file RenderingAbstract.hpp.

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()

Definition at line 78 of file RenderingAbstract.hpp.

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.

Definition at line 81 of file RenderingAbstract.hpp.

Referenced by vl::Rendering::fillRenderQueue(), vl::RenderingTree::render(), and vl::Rendering::render().

bool vl::RenderingAbstract::isEnabled | ( | unsigned int | mask ) | `[inline]`

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

Definition at line 84 of file RenderingAbstract.hpp.

Referenced by dispatchOnRenderingFinished(), dispatchOnRenderingStarted(), vl::Rendering::fillRenderQueue(), and vl::Rendering::render().

void vl::RenderingAbstract::setFrameClock | ( | Real | cur_time ) | `[inline]`

The update time of the current rendering frame.

Definition at line 87 of file RenderingAbstract.hpp.

Referenced by vl::RenderingTree::render(), and vl::Applet::updateEvent().

Real vl::RenderingAbstract::frameClock | ( | ) | const`[inline]`

The update time of the current rendering frame.

Definition at line 90 of file RenderingAbstract.hpp.

Referenced by vl::Rendering::fillRenderQueue(), vl::RenderingTree::render(), and vl::Rendering::render().

## Member Data Documentation

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

Definition at line 93 of file RenderingAbstract.hpp.

Referenced by dispatchOnRenderingStarted(), operator=(), and RenderingAbstract().

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

Definition at line 94 of file RenderingAbstract.hpp.

Referenced by dispatchOnRenderingFinished(), operator=(), and RenderingAbstract().

Real vl::RenderingAbstract::mFrameClock`[protected]`

Definition at line 95 of file RenderingAbstract.hpp.

Referenced by operator=(), and RenderingAbstract().

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

Definition at line 96 of file RenderingAbstract.hpp.

Referenced by operator=(), vl::Rendering::operator=(), and RenderingAbstract().

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

- D:/VL/BuildSystem/VL_DISTRO/Visualization_Library_SDK/src/vlGraphics/RenderingAbstract.hpp
- D:/VL/BuildSystem/VL_DISTRO/Visualization_Library_SDK/src/vlGraphics/RenderingAbstract.cpp

Visualization Library v2011.05.1142 Reference Documentation
Copyright 2005-2011 Michele Bosi. All rights reserved.
Updated on Thu May 26 2011 22:51:44.
Permission is granted to use this page to write and publish articles regarding Visualization Library.