Synchronise game engine with Tuhopuu2 tree.
[blender.git] / source / gameengine / Physics / Sumo / Fuzzics / include / SM_Object.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 SM_OBJECT_H
33 #define SM_OBJECT_H
34
35 #include <vector>
36
37 #include <SOLID/SOLID.h>
38
39 #include "SM_Callback.h"
40 #include "SM_MotionState.h"
41 #include <stdio.h>
42
43 class SM_FhObject;
44
45 /** Properties of dynamic objects */
46 struct SM_ShapeProps {
47         MT_Scalar  m_mass;                  ///< Total mass
48         MT_Scalar  m_radius;                ///< Bound sphere size
49         MT_Vector3 m_inertia;               ///< Inertia, should be a tensor some time 
50         MT_Scalar  m_lin_drag;              ///< Linear drag (air, water) 0 = concrete, 1 = vacuum 
51         MT_Scalar  m_ang_drag;              ///< Angular drag
52         MT_Scalar  m_friction_scaling[3];   ///< Scaling for anisotropic friction. Component in range [0, 1]   
53         bool       m_do_anisotropic;        ///< Should I do anisotropic friction? 
54         bool       m_do_fh;                 ///< Should the object have a linear Fh spring?
55         bool       m_do_rot_fh;             ///< Should the object have an angular Fh spring?
56 };
57
58
59 /** Properties of collidable objects (non-ghost objects) */
60 struct SM_MaterialProps {
61         MT_Scalar m_restitution;           ///< restitution of energy after a collision 0 = inelastic, 1 = elastic
62         MT_Scalar m_friction;              ///< Coulomb friction (= ratio between the normal en maximum friction force)
63         MT_Scalar m_fh_spring;             ///< Spring constant (both linear and angular)
64         MT_Scalar m_fh_damping;            ///< Damping factor (linear and angular) in range [0, 1]
65         MT_Scalar m_fh_distance;           ///< The range above the surface where Fh is active.    
66         bool      m_fh_normal;             ///< Should the object slide off slopes?
67 };
68
69
70 /**
71  * SM_Object is an internal part of the Sumo physics engine.
72  *
73  * It encapsulates an object in the physics scene, and is responsible
74  * for calculating the collision response of objects.
75  */
76 class SM_Object : public SM_MotionState {
77 public:
78         SM_Object() ;
79         SM_Object(
80                 DT_ShapeHandle shape, 
81                 const SM_MaterialProps *materialProps,
82                 const SM_ShapeProps *shapeProps,
83                 SM_Object *dynamicParent
84         );
85         virtual ~SM_Object();
86
87         bool isDynamic() const;  
88
89         /* nzc experimental. There seem to be two places where kinematics
90          * are evaluated: proceedKinematic (called from SM_Scene) and
91          * proceed() in this object. I'll just try and bunge these out for
92          * now.  */
93
94         void suspend(void);
95         void resume(void);
96
97         void suspendDynamics();
98         
99         void restoreDynamics();
100         
101         bool isGhost() const;
102
103         void suspendMaterial();
104         
105         void restoreMaterial();
106         
107         SM_FhObject *getFhObject() const;
108         
109         void registerCallback(SM_Callback& callback);
110
111         void calcXform();
112         void notifyClient();
113         void updateInvInertiaTensor();
114
115     
116         // Save the current state information for use in the 
117         // velocity computation in the next frame.  
118
119         void proceedKinematic(MT_Scalar timeStep);
120
121         void saveReactionForce(MT_Scalar timeStep) ;
122         
123         void clearForce() ;
124
125         void clearMomentum() ;
126         
127         void setMargin(MT_Scalar margin) ;
128         
129         MT_Scalar getMargin() const ;
130         
131         const SM_MaterialProps *getMaterialProps() const ;
132         
133         const SM_ShapeProps *getShapeProps() const ;
134         
135         void setPosition(const MT_Point3& pos);
136         void setOrientation(const MT_Quaternion& orn);
137         void setScaling(const MT_Vector3& scaling);
138         
139
140         /**
141          * set an external velocity. This velocity complements
142          * the physics velocity. So setting it does not override the
143          * physics velocity. It is your responsibility to clear 
144          * this external velocity. This velocity is not subject to 
145          * friction or damping.
146          */
147         void setExternalLinearVelocity(const MT_Vector3& lin_vel) ;
148         void addExternalLinearVelocity(const MT_Vector3& lin_vel) ;
149
150         /** Override the physics velocity */
151         void addLinearVelocity(const MT_Vector3& lin_vel);
152         void setLinearVelocity(const MT_Vector3& lin_vel);
153
154         /**
155          * Set an external angular velocity. This velocity complemetns
156          * the physics angular velocity so does not override it. It is
157          * your responsibility to clear this velocity. This velocity
158          * is not subject to friction or damping.
159          */
160         void setExternalAngularVelocity(const MT_Vector3& ang_vel) ;
161         void addExternalAngularVelocity(const MT_Vector3& ang_vel);
162
163         /** Override the physics angular velocity */
164         void addAngularVelocity(const MT_Vector3& ang_vel);
165         void setAngularVelocity(const MT_Vector3& ang_vel);
166
167         /** Clear the external velocities */
168         void clearCombinedVelocities();
169
170         /** 
171          * Tell the physics system to combine the external velocity
172          * with the physics velocity. 
173          */
174         void resolveCombinedVelocities(
175                 const MT_Vector3 & lin_vel,
176                 const MT_Vector3 & ang_vel
177         ) ;
178
179
180
181         MT_Scalar getInvMass() const;
182
183         const MT_Vector3& getInvInertia() const ;
184         
185         const MT_Matrix3x3& getInvInertiaTensor() const;
186
187         void applyForceField(const MT_Vector3& accel) ;
188         
189         void applyCenterForce(const MT_Vector3& force) ;
190         
191         void applyTorque(const MT_Vector3& torque) ;
192         
193         /**
194          * Apply an impulse to the object.  The impulse will be split into
195          * angular and linear components.
196          * @param attach point to apply the impulse to (in world coordinates)
197          */
198         void applyImpulse(const MT_Point3& attach, const MT_Vector3& impulse) ;
199         
200         /**
201          * Applies an impulse through the centre of this object. (ie the angular
202          * velocity will not change.
203          */
204         void applyCenterImpulse(const MT_Vector3& impulse);
205         /**
206          * Applies an angular impulse.
207          */
208         void applyAngularImpulse(const MT_Vector3& impulse);
209         
210         MT_Point3 getWorldCoord(const MT_Point3& local) const;
211         MT_Point3 getLocalCoord(const MT_Point3& world) const;
212     
213         MT_Vector3 getVelocity(const MT_Point3& local) const;
214
215
216         const MT_Vector3& getReactionForce() const ;
217
218         void getMatrix(double *m) const ;
219
220         const double *getMatrix() const ;
221
222         // Still need this???
223         const MT_Transform&  getScaledTransform()  const; 
224
225         DT_ObjectHandle getObjectHandle() const ;
226         DT_ShapeHandle getShapeHandle() const ;
227
228         SM_Object *getDynamicParent() ;
229
230         void integrateForces(MT_Scalar timeStep);
231         void integrateMomentum(MT_Scalar timeSteo);
232
233         void setRigidBody(bool is_rigid_body) ;
234
235         bool isRigidBody() const ;
236
237         // This is the callback for handling collisions of dynamic objects
238         static 
239                 DT_Bool 
240         boing(
241                 void *client_data,  
242                 void *object1,
243                 void *object2,
244                 const DT_CollData *coll_data
245         );
246
247         static 
248                 DT_Bool 
249         fix(
250                 void *client_data,  
251                 void *object1,
252                 void *object2,
253                 const DT_CollData *coll_data
254         );
255         
256         
257         void *getClientObject() { return m_client_object; }
258         void setClientObject(void *client_object) { m_client_object = client_object; }
259         
260         void relax();
261         
262         void backup() {
263                 m_pos = m_prev_state.getPosition();
264                 m_orn = m_prev_state.getOrientation();
265                 m_xform = m_prev_xform;
266         }
267 private:
268
269         // return the actual linear_velocity of this object this 
270         // is the addition of m_combined_lin_vel and m_lin_vel.
271
272         const 
273                 MT_Vector3
274         actualLinVelocity(
275         ) const ;
276
277         const 
278                 MT_Vector3
279         actualAngVelocity(
280         ) const ;
281         
282         void dynamicCollision(const MT_Point3 &local2, 
283                 const MT_Vector3 &normal, 
284                 MT_Scalar dist, 
285                 const MT_Vector3 &rel_vel,
286                 MT_Scalar restitution,
287                 MT_Scalar friction_factor,
288                 MT_Scalar invMass
289         );
290
291         typedef std::vector<SM_Callback *> T_CallbackList;
292
293
294         T_CallbackList          m_callbackList;    // Each object can have multiple callbacks from the client (=game engine)
295         SM_Object              *m_dynamicParent;   // Collisions between parent and children are ignored
296
297     // as the collision callback now has only information
298         // on an SM_Object, there must be a way that the SM_Object client
299         // can identify it's clientdata after a collision
300         void                   *m_client_object;
301
302         DT_ShapeHandle          m_shape;                 // Shape for collision detection
303
304         // Material and shape properties are not owned by this class.
305
306         const SM_MaterialProps *m_materialProps;         
307         const SM_MaterialProps *m_materialPropsBackup;   // Backup in case the object temporarily becomes a ghost.
308         const SM_ShapeProps    *m_shapeProps;           
309         const SM_ShapeProps    *m_shapePropsBackup;      // Backup in case the object's dynamics is temporarily suspended
310         DT_ObjectHandle         m_object;                // A handle to the corresponding object in SOLID.
311         MT_Scalar               m_margin;                // Offset for the object's shape (also for collision detection)
312         MT_Vector3              m_scaling;               // Non-uniform scaling of the object's shape
313
314         double                  m_ogl_matrix[16];        // An OpenGL-type 4x4 matrix      
315         MT_Transform            m_xform;                 // The object's local coordinate system
316         MT_Transform            m_prev_xform;            // The object's local coordinate system in the previous frame
317         SM_MotionState          m_prev_state;            // The object's motion state in the previous frame
318         MT_Scalar               m_timeStep;              // The duration of the last frame 
319
320         MT_Vector3              m_reaction_impulse;      // The accumulated impulse resulting from collisions
321         MT_Vector3              m_reaction_force;        // The reaction force derived from the reaction impulse   
322
323         unsigned int            m_kinematic      : 1;    // Have I been displaced (translated, rotated, scaled) in this frame? 
324         unsigned int            m_prev_kinematic : 1;    // Have I been displaced (translated, rotated, scaled) in the previous frame? 
325         unsigned int            m_is_rigid_body  : 1;    // Should friction give me a change in angular momentum?
326
327         MT_Vector3              m_lin_mom;               // Linear momentum (linear velocity times mass)
328         MT_Vector3              m_ang_mom;               // Angular momentum (angualr velocity times inertia)
329         MT_Vector3              m_force;                 // Force on center of mass (afffects linear momentum)
330         MT_Vector3              m_torque;                // Torque around center of mass (affects angualr momentum)
331         
332         MT_Vector3              m_error;                 // Error in position:- amount object must be moved to prevent intersection with scene
333
334         // Here are the values of externally set linear and angular
335         // velocity. These are updated from the outside
336         // (actuators and python) each frame and combined with the
337         // physics values. At the end of each frame (at the end of a
338         // call to proceed) they are set to zero. This allows the
339         // outside world to contribute to the velocity of an object
340         // but still have it react to physics. 
341
342         MT_Vector3                              m_combined_lin_vel;
343         MT_Vector3                              m_combined_ang_vel;
344
345         // The force and torque are the accumulated forces and torques applied by the client (game logic, python).
346
347         SM_FhObject            *m_fh_object;             // The ray object used for Fh
348         bool                    m_suspended;             // Is this object frozen?
349         
350         // Mass properties
351         MT_Scalar               m_inv_mass;              // 1/mass
352         MT_Vector3              m_inv_inertia;           // [1/inertia_x, 1/inertia_y, 1/inertia_z]
353         MT_Matrix3x3            m_inv_inertia_tensor;    // Inverse Inertia Tensor
354 };
355
356 #endif
357