Speed up the physics engine: hook the SOLID broad phase, so we can either reject...
[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 #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            proceed(double  timeStep)=0;
50                 virtual void            setGravity(float x,float y,float z)=0;
51
52                 virtual int                     createConstraint(class PHY_IPhysicsController* ctrl,class PHY_IPhysicsController* ctrl2,PHY_ConstraintType type,
53                         float pivotX,float pivotY,float pivotZ,
54                         float axisX,float axisY,float axisZ)=0;
55                 virtual void            removeConstraint(int constraintid)=0;
56
57                 virtual PHY_IPhysicsController* rayTest(void* ignoreClient, float fromX,float fromY,float fromZ, float toX,float toY,float toZ, 
58                                                                                 float& hitX,float& hitY,float& hitZ,float& normalX,float& normalY,float& normalZ)=0;
59 };
60
61 #endif //_IPHYSICSENVIRONMENT
62