Initial revision
[blender.git] / source / gameengine / Ketsji / KX_ObjectActuator.h
1 /**
2  * Do translation/rotation actions
3  *
4  * $Id$
5  *
6  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version. The Blender
12  * Foundation also sells licenses for use in proprietary software under
13  * the Blender License.  See http://www.blender.org/BL/ for information
14  * about this.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software Foundation,
23  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
24  *
25  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
26  * All rights reserved.
27  *
28  * The Original Code is: all of this file.
29  *
30  * Contributor(s): none yet.
31  *
32  * ***** END GPL/BL DUAL LICENSE BLOCK *****
33  */
34
35 #ifndef __KX_OBJECTACTUATOR
36 #define __KX_OBJECTACTUATOR
37
38 #include "SCA_IActuator.h"
39 #include "MT_Vector3.h"
40
41
42 //
43 // Bitfield that stores the flags for each CValue derived class
44 //
45 struct KX_LocalFlags {
46         KX_LocalFlags() :
47                 Force(false),
48                 Torque(false),
49                 DRot(false),
50                 DLoc(false),
51                 LinearVelocity(false),
52                 AngularVelocity(false),
53                 AddOrSetLinV(false)
54         {
55         }
56
57         unsigned short Force : 1;
58         unsigned short Torque : 1;
59         unsigned short DRot : 1;
60         unsigned short DLoc : 1;
61         unsigned short LinearVelocity : 1;
62         unsigned short AngularVelocity : 1;
63         unsigned short AddOrSetLinV : 1;
64 };
65
66 class KX_ObjectActuator : public SCA_IActuator
67 {
68         Py_Header;
69
70         MT_Vector3              m_force;
71         MT_Vector3              m_torque;
72         MT_Vector3              m_dloc;
73         MT_Vector3              m_drot;
74         MT_Vector3              m_linear_velocity;
75         MT_Vector3              m_angular_velocity;     
76         KX_LocalFlags   m_bitLocalFlag;
77
78         // A hack bool -- oh no sorry everyone
79         // This bool is used to check if we have informed 
80         // the physics object that we are no longer 
81         // setting linear velocity.
82
83         bool m_active_combined_velocity;
84         
85 public:
86         enum KX_OBJECT_ACT_VEC_TYPE {
87                 KX_OBJECT_ACT_NODEF = 0,
88                 KX_OBJECT_ACT_FORCE,
89                 KX_OBJECT_ACT_TORQUE,
90                 KX_OBJECT_ACT_DLOC,
91                 KX_OBJECT_ACT_DROT,
92                 KX_OBJECT_ACT_LINEAR_VELOCITY,
93                 KX_OBJECT_ACT_ANGULAR_VELOCITY,
94                 KX_OBJECT_ACT_MAX
95         };
96                 
97         /**
98          * Check whether this is a valid vector mode 
99          */
100         bool isValid(KX_OBJECT_ACT_VEC_TYPE type);
101
102         KX_ObjectActuator(
103                 SCA_IObject* gameobj,
104                 const MT_Vector3& force,
105                 const MT_Vector3& torque,
106                 const MT_Vector3& dloc,
107                 const MT_Vector3& drot,
108                 const MT_Vector3& linV,
109                 const MT_Vector3& angV,
110                 const KX_LocalFlags& flag,
111                 PyTypeObject* T=&Type
112         );
113
114         CValue* GetReplica();
115
116         void SetForceLoc(const double force[3]) { /*m_force=force;*/ }
117         bool Update(double curtime,double deltatime);
118
119
120
121         /* --------------------------------------------------------------------- */
122         /* Python interface ---------------------------------------------------- */
123         /* --------------------------------------------------------------------- */
124         
125         virtual PyObject*  _getattr(char *attr);
126
127         KX_PYMETHOD(KX_ObjectActuator,GetForce);
128         KX_PYMETHOD(KX_ObjectActuator,SetForce);
129         KX_PYMETHOD(KX_ObjectActuator,GetTorque);
130         KX_PYMETHOD(KX_ObjectActuator,SetTorque);
131         KX_PYMETHOD(KX_ObjectActuator,GetDLoc);
132         KX_PYMETHOD(KX_ObjectActuator,SetDLoc);
133         KX_PYMETHOD(KX_ObjectActuator,GetDRot);
134         KX_PYMETHOD(KX_ObjectActuator,SetDRot);
135         KX_PYMETHOD(KX_ObjectActuator,GetLinearVelocity);
136         KX_PYMETHOD(KX_ObjectActuator,SetLinearVelocity);
137         KX_PYMETHOD(KX_ObjectActuator,GetAngularVelocity);
138         KX_PYMETHOD(KX_ObjectActuator,SetAngularVelocity);
139 };
140 #endif //__KX_OBJECTACTUATOR