Visualization Library v1.0.3

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

VL     Star     Watch     Fork     Issue

[Download] [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:
vl::Object vl::Rendering vl::RenderingTree

List of all members.

Public Member Functions

 RenderingAbstract ()
 Constructor.
virtual void render ()=0
 Executes the rendering.
RenderingAbstractoperator= (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 (  )

Member Function Documentation

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 )
void RenderingAbstract::dispatchOnRenderingStarted (  )
void RenderingAbstract::dispatchOnRenderingFinished (  )
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

Definition at line 93 of file RenderingAbstract.hpp.

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

Definition at line 94 of file RenderingAbstract.hpp.

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

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:

Visualization Library v1.0.3 Reference Documentation
Copyright Michele Bosi. All rights reserved.
Updated on Tue Feb 7 2017 00:55:11.
Permission is granted to use this page to write and publish articles regarding Visualization Library.