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