optionally use guarded alloc for tiles compositor, also replace allocation functions...
[blender.git] / source / gameengine / Ketsji / KX_IPhysicsController.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 KX_IPhysicsController.h
29  *  \ingroup ketsji
30  */
31
32 #ifndef __KX_IPHYSICSCONTROLLER_H__
33 #define __KX_IPHYSICSCONTROLLER_H__
34
35 #include "SG_Controller.h"
36 #include "MT_Vector3.h"
37 #include "MT_Point3.h"
38 #include "MT_Transform.h"
39 #include "MT_Matrix3x3.h"
40
41 struct KX_ClientObjectInfo;
42
43 /**
44  * Physics Controller, a special kind of Scene Graph Transformation Controller.
45  * It get's callbacks from Physics in case a transformation change took place.
46  * Each time the scene graph get's updated, the controller get's a chance
47  * in the 'Update' method to reflect changed.
48  */
49
50 class KX_IPhysicsController : public SG_Controller
51                                                          
52 {
53 protected:
54         bool            m_bDyna;
55         bool            m_bSensor;
56         bool            m_bCharacter;
57         bool            m_bCompound;
58         bool            m_suspendDynamics;
59         void*           m_userdata;
60 public:
61         KX_IPhysicsController(bool dyna,bool sensor,bool character,bool compound, void* userdata);
62         virtual ~KX_IPhysicsController();
63
64
65         virtual void    applyImpulse(const MT_Point3& attach, const MT_Vector3& impulse)=0;
66         virtual void    SetObject (SG_IObject* object)=0;
67         virtual void    setMargin (float collisionMargin)=0;
68
69         virtual void    RelativeTranslate(const MT_Vector3& dloc,bool local)=0;
70         virtual void    RelativeRotate(const MT_Matrix3x3& drot,bool local)=0;
71         virtual void    ApplyTorque(const MT_Vector3& torque,bool local)=0;
72         virtual void    ApplyForce(const MT_Vector3& force,bool local)=0;
73         virtual MT_Vector3 GetLinearVelocity()=0;
74         virtual MT_Vector3 GetAngularVelocity()=0;
75         virtual MT_Vector3 GetVelocity(const MT_Point3& pos)=0;
76         virtual void    SetAngularVelocity(const MT_Vector3& ang_vel,bool local)=0;
77         virtual void    SetLinearVelocity(const MT_Vector3& lin_vel,bool local)=0;
78         virtual void    resolveCombinedVelocities(float linvelX,float linvelY,float linvelZ,float angVelX,float angVelY,float angVelZ) = 0;
79
80         virtual void    getOrientation(MT_Quaternion& orn)=0;
81         virtual void setOrientation(const MT_Matrix3x3& orn)=0;
82         virtual void SetTransform()=0;
83         //virtual       void setOrientation(const MT_Quaternion& orn)=0;
84         virtual void setPosition(const MT_Point3& pos)=0;
85         virtual void setScaling(const MT_Vector3& scaling)=0;
86         virtual MT_Scalar       GetMass()=0;
87         virtual void    SetMass(MT_Scalar newmass)=0;
88         
89         virtual float GetLinVelocityMin()=0;
90         virtual void    SetLinVelocityMin(float newmass)=0;
91         virtual float GetLinVelocityMax()=0;
92         virtual void    SetLinVelocityMax(float newmass)=0;
93         
94         virtual MT_Vector3      GetLocalInertia()=0;
95         virtual MT_Vector3      getReactionForce()=0;
96         virtual void    setRigidBody(bool rigid)=0;
97         virtual void    AddCompoundChild(KX_IPhysicsController* child) = 0;
98         virtual void    RemoveCompoundChild(KX_IPhysicsController* child) = 0;
99
100         virtual void    SuspendDynamics(bool ghost=false)=0;
101         virtual void    RestoreDynamics()=0;
102
103         virtual SG_Controller*  GetReplica(class SG_Node* destnode)=0;
104
105         void    SetDyna(bool isDynamic) {
106                 m_bDyna = isDynamic;
107         }
108
109         void    SetSensor(bool isSensor) {
110                 m_bSensor = isSensor;
111         }
112
113         void    SetCharacter(bool isCharacter) {
114                 m_bCharacter = isCharacter;
115         }
116
117         bool    IsDyna(void) {
118                 return m_bDyna;
119         }
120
121         bool    IsSensor(void) {
122                 return m_bSensor;
123         }
124
125         bool    IsCharacter(void) {
126                 return m_bCharacter;
127         }
128
129         bool    IsCompound(void) {
130                 return m_bCompound;
131         }
132
133         virtual MT_Scalar GetRadius()=0;
134         virtual void    SetSumoTransform(bool nondynaonly)=0;
135         // todo: remove next line !
136         virtual void    SetSimulatedTime(double time)=0;
137         
138         // call from scene graph to update
139         virtual bool Update(double time)=0;
140         void*   GetUserData() { return m_userdata;}
141         
142         
143 #ifdef WITH_CXX_GUARDEDALLOC
144         MEM_CXX_CLASS_ALLOC_FUNCS("GE:KX_IPhysicsController")
145 #endif
146 };
147
148 #endif //__KX_IPHYSICSCONTROLLER_H__
149