BGE guardedalloc, Uses WITH_CXX_GUARDEDALLOC but gives a string to MEM_mallocN for...
[blender.git] / source / gameengine / Ketsji / KX_ClientObjectInfo.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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 #ifndef __KX_CLIENTOBJECT_INFO_H
30 #define __KX_CLIENTOBJECT_INFO_H
31
32 /* Note, the way this works with/without sumo is a bit odd */
33
34 #include <list>
35
36 class SCA_ISensor;
37 class KX_GameObject;
38 /**
39  * Client Type and Additional Info. This structure can be use instead of a bare void* pointer, for safeness, and additional info for callbacks
40  */
41 struct KX_ClientObjectInfo
42 {
43         enum clienttype {
44                 STATIC,
45                 ACTOR,
46                 RESERVED1,
47                 SENSOR,
48                 OBSENSOR,
49                 OBACTORSENSOR
50         }               m_type;
51         KX_GameObject*  m_gameobject;
52         void*           m_auxilary_info;
53         std::list<SCA_ISensor*> m_sensors;
54 public:
55         KX_ClientObjectInfo(KX_GameObject *gameobject, clienttype type = STATIC, void *auxilary_info = NULL) :
56                 m_type(type),
57                 m_gameobject(gameobject),
58                 m_auxilary_info(auxilary_info)
59         {}
60         
61         KX_ClientObjectInfo(const KX_ClientObjectInfo &copy) :
62                   m_type(copy.m_type),
63                   m_gameobject(copy.m_gameobject),
64                   m_auxilary_info(copy.m_auxilary_info)
65         {
66         }
67         
68         virtual ~KX_ClientObjectInfo() {}
69         
70         virtual bool hasCollisionCallback() 
71         {
72                 return m_sensors.size() != 0;
73         }
74         
75         bool isActor() { return m_type <= ACTOR; }
76         bool isSensor() { return m_type >= SENSOR && m_type <= OBACTORSENSOR; }
77         
78         
79 #ifdef WITH_CXX_GUARDEDALLOC
80 public:
81         void *operator new( unsigned int num_bytes) { return MEM_mallocN(num_bytes, "GE:KX_ClientObjectInfo"); }
82         void operator delete( void *mem ) { MEM_freeN(mem); }
83 #endif
84 };
85
86 #endif //__KX_CLIENTOBJECT_INFO_H
87