soc-2008-mxcurioni: merged changes to revision 15705
[blender.git] / source / gameengine / Ketsji / KX_IPhysicsController.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_IPHYSICSCONTROLLER_H
30 #define __KX_IPHYSICSCONTROLLER_H
31
32 #include "SG_Controller.h"
33 #include "MT_Vector3.h"
34 #include "MT_Point3.h"
35 #include "MT_Matrix3x3.h"
36
37 struct KX_ClientObjectInfo;
38
39 /**
40         Physics Controller, a special kind of Scene Graph Transformation Controller.
41         It get's callbacks from Physics in case a transformation change took place.
42         Each time the scene graph get's updated, the controller get's a chance
43         in the 'Update' method to reflect changed.
44 */
45
46 class KX_IPhysicsController : public SG_Controller
47                                                          
48 {
49 protected:
50         bool            m_bDyna;
51         bool            m_suspendDynamics;
52         void*           m_userdata;
53 public:
54         KX_IPhysicsController(bool dyna,void* userdata);
55         virtual ~KX_IPhysicsController();
56
57
58         virtual void    applyImpulse(const MT_Point3& attach, const MT_Vector3& impulse)=0;
59         virtual void    SetObject (SG_IObject* object)=0;
60         virtual void    setMargin (float collisionMargin)=0;
61
62         virtual void    RelativeTranslate(const MT_Vector3& dloc,bool local)=0;
63         virtual void    RelativeRotate(const MT_Matrix3x3& drot,bool local)=0;
64         virtual void    ApplyTorque(const MT_Vector3& torque,bool local)=0;
65         virtual void    ApplyForce(const MT_Vector3& force,bool local)=0;
66         virtual MT_Vector3 GetLinearVelocity()=0;
67         virtual MT_Vector3 GetAngularVelocity()=0;
68         virtual MT_Vector3 GetVelocity(const MT_Point3& pos)=0;
69         virtual void    SetAngularVelocity(const MT_Vector3& ang_vel,bool local)=0;
70         virtual void    SetLinearVelocity(const MT_Vector3& lin_vel,bool local)=0;
71         virtual void    resolveCombinedVelocities(float linvelX,float linvelY,float linvelZ,float angVelX,float angVelY,float angVelZ) = 0;
72
73         virtual void    getOrientation(MT_Quaternion& orn)=0;
74         virtual void setOrientation(const MT_Matrix3x3& orn)=0;
75         //virtual       void setOrientation(const MT_Quaternion& orn)=0;
76         virtual void setPosition(const MT_Point3& pos)=0;
77         virtual void setScaling(const MT_Vector3& scaling)=0;
78         virtual MT_Scalar       GetMass()=0;
79         virtual MT_Vector3      getReactionForce()=0;
80         virtual void    setRigidBody(bool rigid)=0;
81
82         virtual void    SuspendDynamics(bool ghost=false)=0;
83         virtual void    RestoreDynamics()=0;
84
85         virtual SG_Controller*  GetReplica(class SG_Node* destnode)=0;
86
87         void    SetDyna(bool isDynamic) {
88                 m_bDyna = isDynamic;
89         }
90
91
92         virtual void    SetSumoTransform(bool nondynaonly)=0;
93         // todo: remove next line !
94         virtual void    SetSimulatedTime(double time)=0;
95         
96         // call from scene graph to update
97         virtual bool Update(double time)=0;
98         void*   GetUserData() { return m_userdata;}
99 };
100
101 #endif //__KX_IPHYSICSCONTROLLER_H
102