migrated NDOF code from soc-2010-merwin, SpaceNavigator now works on Mac blender
[blender-staging.git] / source / gameengine / Ketsji / KX_TimeCategoryLogger.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 /** \file KX_TimeCategoryLogger.h
31  *  \ingroup ketsji
32  */
33
34 #ifndef __KX_TIME_CATEGORY_LOGGER_H
35 #define __KX_TIME_CATEGORY_LOGGER_H
36
37 #if defined(WIN32) && !defined(FREE_WINDOWS)
38 #pragma warning (disable:4786) // suppress stl-MSVC debug info warning
39 #endif
40
41 #include <map>
42
43 #include "KX_TimeLogger.h"
44
45 /**
46  * Stores and manages time measurements by category.
47  * Categories can be added dynamically.
48  * Average measurements can be established for each separate category
49  * or for all categories together.
50  */
51 class KX_TimeCategoryLogger {
52 public:
53         typedef int TimeCategory;
54
55         /**
56          * Constructor.
57          * @param maxNumMesasurements Maximum number of measurements stored (> 1).
58          */
59         KX_TimeCategoryLogger(unsigned int maxNumMeasurements = 10);
60
61         /**
62          * Destructor.
63          */
64         virtual ~KX_TimeCategoryLogger(void);
65
66         /**
67          * Changes the maximum number of measurements that can be stored.
68          */
69         virtual void SetMaxNumMeasurements(unsigned int maxNumMeasurements);
70
71         /**
72          * Changes the maximum number of measurements that can be stored.
73          */
74         virtual unsigned int GetMaxNumMeasurements(void) const;
75
76         /**
77          * Adds a category.
78          * @param category      The new category.
79          */
80         virtual void AddCategory(TimeCategory tc);
81
82         /**
83          * Starts logging in current measurement for the given category.
84          * @param tc                                    The category to log to.
85          * @param now                                   The current time.
86          * @param endOtherCategories    Whether to stop logging to other categories.
87          */
88         virtual void StartLog(TimeCategory tc, double now, bool endOtherCategories = true);
89
90         /**
91          * End logging in current measurement for the given category.
92          * @param tc    The category to log to.
93          * @param now   The current time.
94          */
95         virtual void EndLog(TimeCategory tc, double now);
96
97         /**
98          * End logging in current measurement for all categories.
99          * @param now   The current time.
100          */
101         virtual void EndLog(double now);
102
103         /**
104          * Logs time in next measurement.
105          * @param now   The current time.
106          */
107         virtual void NextMeasurement(double now);
108
109         /**
110          * Returns average of all but the current measurement time.
111          * @return The average of all but the current measurement.
112          */
113         virtual double GetAverage(TimeCategory tc);
114
115         /**
116          * Returns average for grand total.
117          */
118         virtual double GetAverage(void);
119
120 protected:
121         /**  
122          * Disposes loggers.
123          */  
124         virtual void DisposeLoggers(void);
125
126         /** Storage for the loggers. */
127         typedef std::map<TimeCategory, KX_TimeLogger*> KX_TimeLoggerMap;
128         KX_TimeLoggerMap m_loggers;
129         /** Maximum number of measurements. */
130         unsigned int m_maxNumMeasurements;
131
132
133 #ifdef WITH_CXX_GUARDEDALLOC
134 public:
135         void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "GE:KX_TimeCategoryLogger"); }
136         void operator delete( void *mem ) { MEM_freeN(mem); }
137 #endif
138 };
139
140 #endif // __KX_TIME_CATEGORY_LOGGER_H
141