2.50:
[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 #ifdef USE_SUMO_SOLID
34 #include <SM_Object.h>
35 #endif //USE_SUMO_SOLID
36
37 #include <list>
38
39 class SCA_ISensor;
40 class KX_GameObject;
41 /**
42  * Client Type and Additional Info. This structure can be use instead of a bare void* pointer, for safeness, and additional info for callbacks
43  */
44 struct KX_ClientObjectInfo
45 #ifdef USE_SUMO_SOLID
46   : public SM_ClientObject
47 #endif
48 {
49         enum clienttype {
50                 STATIC,
51                 ACTOR,
52                 RESERVED1,
53                 SENSOR,
54                 OBSENSOR,
55                 OBACTORSENSOR
56         }               m_type;
57         KX_GameObject*  m_gameobject;
58         void*           m_auxilary_info;
59         std::list<SCA_ISensor*> m_sensors;
60 public:
61         KX_ClientObjectInfo(KX_GameObject *gameobject, clienttype type = STATIC, void *auxilary_info = NULL) :
62 #ifdef USE_SUMO_SOLID
63                 SM_ClientObject(),
64 #endif
65                 m_type(type),
66                 m_gameobject(gameobject),
67                 m_auxilary_info(auxilary_info)
68         {}
69         
70         KX_ClientObjectInfo(const KX_ClientObjectInfo &copy) :
71 #ifdef USE_SUMO_SOLID           
72                   SM_ClientObject(copy),
73 #endif
74                   m_type(copy.m_type),
75                   m_gameobject(copy.m_gameobject),
76                   m_auxilary_info(copy.m_auxilary_info)
77         {
78         }
79         
80         virtual ~KX_ClientObjectInfo() {}
81         
82         virtual bool hasCollisionCallback() 
83         {
84                 return m_sensors.size() != 0;
85         }
86         
87         bool isActor() { return m_type <= ACTOR; }
88         bool isSensor() { return m_type >= SENSOR && m_type <= OBACTORSENSOR; }
89 };
90
91 #endif //__KX_CLIENTOBJECT_INFO_H
92