Visualization Library 2.0.0

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

VL     Star     Watch     Fork     Issue

[Download] [Tutorials] [All Classes] [Grouped Classes]
RenderEventCallback.hpp
Go to the documentation of this file.
1 /**************************************************************************************/
2 /* */
3 /* Visualization Library */
4 /* http://visualizationlibrary.org */
5 /* */
6 /* Copyright (c) 2005-2020, Michele Bosi */
7 /* All rights reserved. */
8 /* */
9 /* Redistribution and use in source and binary forms, with or without modification, */
10 /* are permitted provided that the following conditions are met: */
11 /* */
12 /* - Redistributions of source code must retain the above copyright notice, this */
13 /* list of conditions and the following disclaimer. */
14 /* */
15 /* - Redistributions in binary form must reproduce the above copyright notice, this */
16 /* list of conditions and the following disclaimer in the documentation and/or */
17 /* other materials provided with the distribution. */
18 /* */
19 /* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND */
20 /* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED */
21 /* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE */
22 /* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR */
23 /* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES */
24 /* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; */
25 /* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON */
26 /* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT */
27 /* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS */
28 /* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
29 /* */
30 /**************************************************************************************/
31 
32 #ifndef RenderEventCallback_INCLUDE_ONCE
33 #define RenderEventCallback_INCLUDE_ONCE
34 
35 #include <vlCore/Object.hpp>
36 #include <vlCore/vlnamespace.hpp>
37 
38 namespace vl
39 {
40  class RenderingAbstract;
41  class RendererAbstract;
42  //-----------------------------------------------------------------------------
43  // RenderEventCallback
44  //-----------------------------------------------------------------------------
54  {
56 
57  public:
59  {
60  VL_DEBUG_SET_OBJECT_NAME()
61  }
62 
65  virtual bool onRenderingStarted(const RenderingAbstract*) = 0;
66 
69  virtual bool onRenderingFinished(const RenderingAbstract*) = 0;
70 
73  virtual bool onRendererStarted(const RendererAbstract*) = 0;
74 
77  virtual bool onRendererFinished(const RendererAbstract*) = 0;
78 
81  void setRemoveAfterCall(bool remove) { mRemoveAfterCall = remove; }
82 
85  bool removeAfterCall() const { return mRemoveAfterCall; }
86 
88  void setEnabled(bool enabled) { mEnabled = enabled; }
89 
91  bool isEnabled() const { return mEnabled; }
92 
93  protected:
95  bool mEnabled;
96  };
97 }
98 
99 #endif
virtual bool onRenderingFinished(const RenderingAbstract *)=0
Reimplement to react to this event.
The RenderingAbstract class is the base of all the rendering related sub-classes. ...
Visualization Library main namespace.
virtual bool onRendererFinished(const RendererAbstract *)=0
Reimplement to react to this event.
An abstract class used to react to rendering events.
void setEnabled(bool enabled)
Enabled/disabled callback.
bool isEnabled() const
Whether the callback is enabled or not.
The base class for all the reference counted objects.
Definition: Object.hpp:158
Base class providing all the basic funtionalities of a Renderer.
#define VL_INSTRUMENT_ABSTRACT_CLASS(ClassName, BaseClass)
Definition: TypeInfo.hpp:145
virtual bool onRendererStarted(const RendererAbstract *)=0
Reimplement to react to this event.
bool removeAfterCall() const
Defines if the callback shall be removed after being executed.
void setRemoveAfterCall(bool remove)
Defines if the callback shall be removed after being executed.
Visualization Library&#39;s enums in the &#39;vl&#39; namespace.
virtual bool onRenderingStarted(const RenderingAbstract *)=0
Reimplement to react to this event.