fde27e822d6fe37d7ad08c8602a0694198794182
[blender-staging.git] / source / gameengine / Physics / Dummy / DummyPhysicsEnvironment.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 _DUMMYPHYSICSENVIRONMENT
33 #define _DUMMYPHYSICSENVIRONMENT
34
35 #include "PHY_IPhysicsEnvironment.h"
36
37 /**
38 *       DummyPhysicsEnvironment  is an empty placeholder
39 *   Alternatives are ODE,Sumo and Dynamo PhysicsEnvironments
40 *       Use DummyPhysicsEnvironment as a base to integrate your own physics engine
41 *       Physics Environment takes care of stepping the simulation and is a container for physics entities (rigidbodies,constraints, materials etc.)
42 *
43 *       A derived class may be able to 'construct' entities by loading and/or converting
44 */
45 class DummyPhysicsEnvironment  : public PHY_IPhysicsEnvironment
46 {
47
48 public:
49         DummyPhysicsEnvironment ();
50         virtual         ~DummyPhysicsEnvironment ();
51         virtual void            beginFrame();
52         virtual void            endFrame();
53 // Perform an integration step of duration 'timeStep'.
54         virtual bool            proceedDeltaTime(double  curTime,float timeStep);
55         virtual void            setFixedTimeStep(bool useFixedTimeStep,float fixedTimeStep);
56         virtual float           getFixedTimeStep();
57
58         virtual void            setGravity(float x,float y,float z);
59
60         virtual int                     createConstraint(class PHY_IPhysicsController* ctrl,class PHY_IPhysicsController* ctrl2,PHY_ConstraintType type,
61                         float pivotX,float pivotY,float pivotZ,
62                         float axisX,float axisY,float axisZ);
63
64         virtual void            removeConstraint(int constraintid);
65         virtual PHY_IPhysicsController* rayTest(PHY_IPhysicsController* ignoreClient, float fromX,float fromY,float fromZ, float toX,float toY,float toZ, 
66                                                                         float& hitX,float& hitY,float& hitZ,float& normalX,float& normalY,float& normalZ);
67
68
69         //gamelogic callbacks
70                 virtual void addSensor(PHY_IPhysicsController* ctrl) {}
71                 virtual void removeSensor(PHY_IPhysicsController* ctrl) {}
72                 virtual void addTouchCallback(int response_class, PHY_ResponseCallback callback, void *user)
73                 {
74                 }
75                 virtual void requestCollisionCallback(PHY_IPhysicsController* ctrl) {}
76                 virtual PHY_IPhysicsController* CreateSphereController(float radius,const PHY__Vector3& position) {return 0;}
77                 virtual PHY_IPhysicsController* CreateConeController(float coneradius,float coneheight) { return 0;}
78
79
80 };
81
82 #endif //_DUMMYPHYSICSENVIRONMENT
83