Visualization Library 2.0.0-b3

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 | List of all members
vl::RenderEventCallback Class Referenceabstract

An abstract class used to react to rendering events. More...

#include <RenderEventCallback.hpp>

+ Inheritance diagram for vl::RenderEventCallback:

Public Member Functions

 RenderEventCallback ()
 
virtual bool onRenderingStarted (const RenderingAbstract *)=0
 Reimplement to react to this event. More...
 
virtual bool onRenderingFinished (const RenderingAbstract *)=0
 Reimplement to react to this event. More...
 
virtual bool onRendererStarted (const RendererAbstract *)=0
 Reimplement to react to this event. More...
 
virtual bool onRendererFinished (const RendererAbstract *)=0
 Reimplement to react to this event. More...
 
void setRemoveAfterCall (bool remove)
 Defines if the callback shall be removed after being executed. More...
 
bool removeAfterCall () const
 Defines if the callback shall be removed after being executed. More...
 
void setEnabled (bool enabled)
 Enabled/disabled callback. More...
 
bool isEnabled () const
 Whether the callback is enabled or not. More...
 
- Public Member Functions inherited from vl::Object
 Object ()
 Constructor. More...
 
 Object (const Object &other)
 Copy constructor: copies the name, ref count mutex and user data. More...
 
Objectoperator= (const Object &other)
 Copy operator: copies the object's name, ref count mutex and user data. More...
 
const std::string & objectName () const
 The name of the object, by default set to the object's class name. More...
 
void setObjectName (const char *name)
 The name of the object, by default set to the object's class name in debug builds. More...
 
void setObjectName (const std::string &name)
 The name of the object, by default set to the object's class name in debug builds. More...
 
void setRefCountMutex (IMutex *mutex)
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
IMutexrefCountMutex ()
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
const IMutexrefCountMutex () const
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
int referenceCount () const
 Returns the number of references of an object. More...
 
void incReference () const
 Increments the reference count of an object. More...
 
void decReference ()
 Decrements the reference count of an object and deletes it if both automaticDelete() is true the count reaches 0. More...
 
void setAutomaticDelete (bool autodel_on)
 If set to true the Object is deleted when its reference count reaches 0. More...
 
bool automaticDelete () const
 If set to true the Object is deleted when its reference count reaches 0. More...
 
template<class T >
T * as ()
 Casts an Object to the specified class. More...
 
template<class T >
const T * as () const
 Casts an Object to the specified class. More...
 

Protected Attributes

bool mRemoveAfterCall
 
bool mEnabled
 
- Protected Attributes inherited from vl::Object
std::string mObjectName
 
IMutexmRefCountMutex
 
int mReferenceCount
 
bool mAutomaticDelete
 

Additional Inherited Members

- Protected Member Functions inherited from vl::Object
virtual ~Object ()
 

Detailed Description

An abstract class used to react to rendering events.

You can bind a callback to both Rendering and Renderer. The callbacks are executed in the same order in which they appear in the containing collection.

See also

Definition at line 53 of file RenderEventCallback.hpp.

Constructor & Destructor Documentation

◆ RenderEventCallback()

vl::RenderEventCallback::RenderEventCallback ( )
inline

Member Function Documentation

◆ isEnabled()

bool vl::RenderEventCallback::isEnabled ( ) const
inline

Whether the callback is enabled or not.

Disabled callbacks won't be notified of any event.

Definition at line 91 of file RenderEventCallback.hpp.

References mEnabled.

◆ onRendererFinished()

virtual bool vl::RenderEventCallback::onRendererFinished ( const RendererAbstract )
pure virtual

Reimplement to react to this event.

Returns
true if the callback reacted to the given event.

Implemented in vl::ReadPixels, vl::BlitFramebuffer, and vl::CopyTexSubImage.

Referenced by RenderEventCallback().

◆ onRendererStarted()

virtual bool vl::RenderEventCallback::onRendererStarted ( const RendererAbstract )
pure virtual

Reimplement to react to this event.

Returns
true if the callback reacted to the given event.

Implemented in vl::ReadPixels, vl::BlitFramebuffer, and vl::CopyTexSubImage.

Referenced by RenderEventCallback().

◆ onRenderingFinished()

virtual bool vl::RenderEventCallback::onRenderingFinished ( const RenderingAbstract )
pure virtual

Reimplement to react to this event.

Returns
true if the callback reacted to the given event.

Implemented in vl::ReadPixels, vl::BlitFramebuffer, and vl::CopyTexSubImage.

Referenced by RenderEventCallback().

◆ onRenderingStarted()

virtual bool vl::RenderEventCallback::onRenderingStarted ( const RenderingAbstract )
pure virtual

Reimplement to react to this event.

Returns
true if the callback reacted to the given event.

Implemented in vl::ReadPixels, vl::BlitFramebuffer, and vl::CopyTexSubImage.

Referenced by RenderEventCallback().

◆ removeAfterCall()

bool vl::RenderEventCallback::removeAfterCall ( ) const
inline

Defines if the callback shall be removed after being executed.

Note that the callback is removed only if the renderingCallback() method returns true.

Definition at line 85 of file RenderEventCallback.hpp.

References mRemoveAfterCall.

◆ setEnabled()

void vl::RenderEventCallback::setEnabled ( bool  enabled)
inline

Enabled/disabled callback.

Disabled callbacks won't be notified of any event.

Definition at line 88 of file RenderEventCallback.hpp.

References mEnabled.

◆ setRemoveAfterCall()

void vl::RenderEventCallback::setRemoveAfterCall ( bool  remove)
inline

Defines if the callback shall be removed after being executed.

Note that the callback is removed only if the renderingCallback() method returns true.

Definition at line 81 of file RenderEventCallback.hpp.

References mRemoveAfterCall.

Member Data Documentation

◆ mEnabled

bool vl::RenderEventCallback::mEnabled
protected

Definition at line 95 of file RenderEventCallback.hpp.

Referenced by isEnabled(), and setEnabled().

◆ mRemoveAfterCall

bool vl::RenderEventCallback::mRemoveAfterCall
protected

Definition at line 94 of file RenderEventCallback.hpp.

Referenced by removeAfterCall(), and setRemoveAfterCall().


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