Cleanup: style, whitespace, doxy filepaths
[blender-staging.git] / source / gameengine / Physics / common / PHY_IController.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file PHY_IController.h
29  *  \ingroup phys
30  */
31
32 #ifndef __PHY_ICONTROLLER_H__
33 #define __PHY_ICONTROLLER_H__
34
35 #include "PHY_DynamicTypes.h"
36
37 class PHY_IPhysicsEnvironment;
38
39 #ifdef WITH_CXX_GUARDEDALLOC
40 #include "MEM_guardedalloc.h"
41 #endif
42
43 /**
44  * PHY_IController is the abstract simplified Interface to objects
45  * controlled by the physics engine. This includes the physics objects
46  * and the graphics object for view frustrum and occlusion culling.
47  */
48 class PHY_IController
49 {
50         public:
51                 virtual ~PHY_IController() {};
52                 // clientinfo for raycasts for example
53                 virtual void*   GetNewClientInfo()=0;
54                 virtual void    SetNewClientInfo(void* clientinfo)=0;
55                 virtual void    SetPhysicsEnvironment(class PHY_IPhysicsEnvironment *env)=0;
56
57         
58 #ifdef WITH_CXX_GUARDEDALLOC
59         MEM_CXX_CLASS_ALLOC_FUNCS("GE:PHY_IController")
60 #endif
61 };
62
63 #endif  /* __PHY_ICONTROLLER_H__ */