Initial revision
[blender.git] / source / gameengine / Physics / common / PHY_IPhysicsController.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL/BL DUAL 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. The Blender
10  * Foundation also sells licenses for use in proprietary software under
11  * the Blender License.  See http://www.blender.org/BL/ for information
12  * about this.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22  *
23  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
24  * All rights reserved.
25  *
26  * The Original Code is: all of this file.
27  *
28  * Contributor(s): none yet.
29  *
30  * ***** END GPL/BL DUAL LICENSE BLOCK *****
31  */
32 #ifndef PHY_IPHYSICSCONTROLLER_H
33 #define PHY_IPHYSICSCONTROLLER_H
34
35 /**
36         PHY_IPhysicsController is the abstract simplified Interface to a physical object.
37         It contains the IMotionState and IDeformableMesh Interfaces.
38 */
39
40
41 class PHY_IPhysicsController    
42 {
43
44         public:
45                 
46                 virtual ~PHY_IPhysicsController();
47                 /**
48                         SynchronizeMotionStates ynchronizes dynas, kinematic and deformable entities (and do 'late binding')
49                 */
50                 virtual bool            SynchronizeMotionStates(float time)=0;
51                 /**
52                         WriteMotionStateToDynamics ynchronizes dynas, kinematic and deformable entities (and do 'late binding')
53                 */
54                 
55                 virtual void            WriteMotionStateToDynamics(bool nondynaonly)=0;
56                 virtual void            WriteDynamicsToMotionState()=0;
57                 // controller replication
58                 virtual void            PostProcessReplica(class PHY_IMotionState* motionstate,class PHY_IPhysicsController* parentctrl)=0;
59
60                 // kinematic methods
61                 virtual void            RelativeTranslate(float dlocX,float dlocY,float dlocZ,bool local)=0;
62                 virtual void            RelativeRotate(const float drot[9],bool local)=0;
63                 virtual void            getOrientation(float &quatImag0,float &quatImag1,float &quatImag2,float &quatReal)=0;
64                 virtual void            setOrientation(float quatImag0,float quatImag1,float quatImag2,float quatReal)=0;
65                 virtual void            setPosition(float posX,float posY,float posZ)=0;
66                 virtual void            setScaling(float scaleX,float scaleY,float scaleZ)=0;
67                 
68                 // physics methods
69                 virtual void            ApplyTorque(float torqueX,float torqueY,float torqueZ,bool local)=0;
70                 virtual void            ApplyForce(float forceX,float forceY,float forceZ,bool local)=0;
71                 virtual void            SetAngularVelocity(float ang_velX,float ang_velY,float ang_velZ,bool local)=0;
72                 virtual void            SetLinearVelocity(float lin_velX,float lin_velY,float lin_velZ,bool local)=0;
73                 virtual void            applyImpulse(float attachX,float attachY,float attachZ, float impulseX,float impulseY,float impulseZ)=0;
74                 virtual void            SetActive(bool active)=0;
75
76                 // reading out information from physics
77                 virtual void            GetLinearVelocity(float& linvX,float& linvY,float& linvZ)=0;
78                 virtual void            GetVelocity(const float posX,const float posY,const float posZ,float& linvX,float& linvY,float& linvZ)=0; 
79                 virtual void            getReactionForce(float& forceX,float& forceY,float& forceZ)=0;
80
81                 // dyna's that are rigidbody are free in orientation, dyna's with non-rigidbody are restricted 
82                 virtual void            setRigidBody(bool rigid)=0;
83
84                 // clientinfo for raycasts for example
85                 virtual void*                           getClientInfo()=0;
86                 virtual void                            setClientInfo(void* clientinfo)=0;
87 };
88
89 #endif //PHY_IPHYSICSCONTROLLER_H