OGRE  1.9
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
OgreFrameListener.h
Go to the documentation of this file.
1 /*
2 -----------------------------------------------------------------------------
3 This source file is part of OGRE
4  (Object-oriented Graphics Rendering Engine)
5 For the latest info, see http://www.ogre3d.org/
6 
7 Copyright (c) 2000-2014 Torus Knot Software Ltd
8 
9 Permission is hereby granted, free of charge, to any person obtaining a copy
10 of this software and associated documentation files (the "Software"), to deal
11 in the Software without restriction, including without limitation the rights
12 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 copies of the Software, and to permit persons to whom the Software is
14 furnished to do so, subject to the following conditions:
15 
16 The above copyright notice and this permission notice shall be included in
17 all copies or substantial portions of the Software.
18 
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 THE SOFTWARE.
26 -----------------------------------------------------------------------------
27 */
28 #ifndef __FrameListener_H__
29 #define __FrameListener_H__
30 
31 
32 #include "OgrePrerequisites.h"
33 
34 namespace Ogre {
35 
44  struct FrameEvent
45  {
61  };
62 
63 
80  {
81  /*
82  Note that this could have been an abstract class, but I made
83  the explicit choice not to do this, because I wanted to give
84  people the option of only implementing the methods they wanted,
85  rather than having to create 'do nothing' implementations for
86  those they weren't interested in. As such this class follows
87  the 'Adapter' classes in Java rather than pure interfaces.
88  */
89  public:
97  virtual bool frameStarted(const FrameEvent& evt)
98  { (void)evt; return true; }
99 
116  virtual bool frameRenderingQueued(const FrameEvent& evt)
117  { (void)evt; return true; }
118 
127  virtual bool frameEnded(const FrameEvent& evt)
128  { (void)evt; return true; }
129 
130  virtual ~FrameListener() {}
131 
132  };
135 }
136 
137 #endif
virtual bool frameEnded(const FrameEvent &evt)
Called just after a frame has been rendered.
float Real
Software floating point type.
#define _OgreExport
Definition: OgrePlatform.h:260
virtual bool frameRenderingQueued(const FrameEvent &evt)
Called after all render targets have had their rendering commands issued, but before render windows h...
Real timeSinceLastEvent
Elapsed time in seconds since the last event.
A interface class defining a listener which can be used to receive notifications of frame events...
Struct containing information about a frame event.
virtual bool frameStarted(const FrameEvent &evt)
Called when a frame is about to begin rendering.
Real timeSinceLastFrame
Elapsed time in seconds since the last event of the same type, i.e.