- added support for generic 6DOF constraint
[blender.git] / source / gameengine / Physics / common / PHY_IPhysicsEnvironment.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
33 #ifndef _IPHYSICSENVIRONMENT
34 #define _IPHYSICSENVIRONMENT
35
36 #include <vector>
37 #include "PHY_DynamicTypes.h"
38 class PHY_IVehicle;
39
40 /**
41 *       Physics Environment takes care of stepping the simulation and is a container for physics entities (rigidbodies,constraints, materials etc.)
42 *       A derived class may be able to 'construct' entities by loading and/or converting
43 */
44 class PHY_IPhysicsEnvironment
45 {
46         public:
47                 virtual         ~PHY_IPhysicsEnvironment();
48                 virtual void            beginFrame() = 0;
49                 virtual void            endFrame() = 0;
50                 /// Perform an integration step of duration 'timeStep'.
51                 virtual bool            proceedDeltaTime(double curTime,float timeStep)=0;
52                 virtual void            setFixedTimeStep(bool useFixedTimeStep,float fixedTimeStep)=0;
53                 //returns 0.f if no fixed timestep is used
54                 virtual float           getFixedTimeStep()=0;
55
56                 ///setDebugMode is used to support several ways of debug lines, contact point visualization
57                 virtual void            setDebugMode(int debugMode) {}
58                 ///setNumIterations set the number of iterations for iterative solvers
59                 virtual void            setNumIterations(int numIter) {}
60                 ///setNumTimeSubSteps set the number of divisions of the timestep. Tradeoff quality versus performance.
61                 virtual void            setNumTimeSubSteps(int numTimeSubSteps){}
62                 ///setDeactivationTime sets the minimum time that an objects has to stay within the velocity tresholds until it gets fully deactivated
63                 virtual void            setDeactivationTime(float dTime) {}
64                 ///setDeactivationLinearTreshold sets the linear velocity treshold, see setDeactivationTime
65                 virtual void            setDeactivationLinearTreshold(float linTresh) {}
66                 ///setDeactivationAngularTreshold sets the angular velocity treshold, see setDeactivationTime
67                 virtual void            setDeactivationAngularTreshold(float angTresh) {}
68                 ///setContactBreakingTreshold sets tresholds to do with contact point management
69                 virtual void            setContactBreakingTreshold(float contactBreakingTreshold) {}
70                 ///continuous collision detection mode, very experimental for Bullet
71                 virtual void            setCcdMode(int ccdMode) {}
72                 ///successive overrelaxation constant, in case PSOR is used, values in between 1 and 2 guarantee converging behaviour
73                 virtual void            setSolverSorConstant(float sor) {}
74                 ///setSolverType, internal setting, chooses solvertype, PSOR, Dantzig, impulse based, penalty based
75                 virtual void            setSolverType(int solverType) {}
76                 ///setTau sets the spring constant of a penalty based solver
77                 virtual void            setSolverTau(float tau) {}
78                 ///setDamping sets the damper constant of a penalty based solver
79                 virtual void            setSolverDamping(float damping) {}
80                 ///linear air damping for rigidbodies
81                 virtual void            setLinearAirDamping(float damping) {}
82                 /// penetrationdepth setting
83                 virtual void            setUseEpa(bool epa) {}
84
85                 virtual void            setGravity(float x,float y,float z)=0;
86
87                 virtual int                     createConstraint(class PHY_IPhysicsController* ctrl,class PHY_IPhysicsController* ctrl2,PHY_ConstraintType type,
88                         float pivotX,float pivotY,float pivotZ,
89                         float axisX,float axisY,float axisZ)=0;
90                 virtual void            removeConstraint(int    constraintid)=0;
91                 virtual float           getAppliedImpulse(int   constraintid){ return 0.f;}
92
93
94                 //complex constraint for vehicles
95                 virtual PHY_IVehicle*   getVehicleConstraint(int constraintId) =0;
96
97                 virtual PHY_IPhysicsController* rayTest(PHY_IPhysicsController* ignoreClient, float fromX,float fromY,float fromZ, float toX,float toY,float toZ, 
98                                                                                 float& hitX,float& hitY,float& hitZ,float& normalX,float& normalY,float& normalZ)=0;
99
100
101                 //Methods for gamelogic collision/physics callbacks
102                 //todo:
103                 virtual void addSensor(PHY_IPhysicsController* ctrl)=0;
104                 virtual void removeSensor(PHY_IPhysicsController* ctrl)=0;
105                 virtual void addTouchCallback(int response_class, PHY_ResponseCallback callback, void *user)=0;
106                 virtual void requestCollisionCallback(PHY_IPhysicsController* ctrl)=0;
107                 virtual PHY_IPhysicsController* CreateSphereController(float radius,const PHY__Vector3& position) =0;
108                 virtual PHY_IPhysicsController* CreateConeController(float coneradius,float coneheight)=0;
109                 
110                 virtual void    setConstraintParam(int constraintId,int param,float value,float value1) = 0;
111 };
112
113 #endif //_IPHYSICSENVIRONMENT
114