Nla Sound Strips + Add Speaker
[blender.git] / source / gameengine / Physics / Dummy / DummyPhysicsEnvironment.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL 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.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 /** \file DummyPhysicsEnvironment.h
31  *  \ingroup physdummy
32  */
33
34 #ifndef _DUMMYPHYSICSENVIRONMENT
35 #define _DUMMYPHYSICSENVIRONMENT
36
37 #include "PHY_IPhysicsEnvironment.h"
38
39 /**
40 *       DummyPhysicsEnvironment  is an empty placeholder
41 *   Alternatives are ODE,Sumo and Dynamo PhysicsEnvironments
42 *       Use DummyPhysicsEnvironment as a base to integrate your own physics engine
43 *       Physics Environment takes care of stepping the simulation and is a container for physics entities (rigidbodies,constraints, materials etc.)
44 *
45 *       A derived class may be able to 'construct' entities by loading and/or converting
46 */
47 class DummyPhysicsEnvironment  : public PHY_IPhysicsEnvironment
48 {
49
50 public:
51         DummyPhysicsEnvironment ();
52         virtual         ~DummyPhysicsEnvironment ();
53         virtual void            beginFrame();
54         virtual void            endFrame();
55 // Perform an integration step of duration 'timeStep'.
56         virtual bool            proceedDeltaTime(double  curTime,float timeStep,float interval);
57         virtual void            setFixedTimeStep(bool useFixedTimeStep,float fixedTimeStep);
58         virtual float           getFixedTimeStep();
59
60         virtual void            setGravity(float x,float y,float z);
61
62         virtual int                     createConstraint(class PHY_IPhysicsController* ctrl,class PHY_IPhysicsController* ctrl2,PHY_ConstraintType type,
63                         float pivotX,float pivotY,float pivotZ,
64                         float axisX,float axisY,float axisZ,
65                         float axis1X=0,float axis1Y=0,float axis1Z=0,
66                         float axis2X=0,float axis2Y=0,float axis2Z=0,int flag=0
67                         );
68
69         virtual void            removeConstraint(int    constraintid);
70
71                 //complex constraint for vehicles
72         virtual PHY_IVehicle*   getVehicleConstraint(int constraintId)
73         {
74                 return 0;
75         }
76
77         virtual PHY_IPhysicsController* rayTest(PHY_IRayCastFilterCallback &filterCallback, float fromX,float fromY,float fromZ, float toX,float toY,float toZ);
78         virtual bool cullingTest(PHY_CullingCallback callback, void* userData, PHY__Vector4* planes, int nplanes, int occlusionRes) { return false; }
79
80
81         //gamelogic callbacks
82                 virtual void addSensor(PHY_IPhysicsController* ctrl) {}
83                 virtual void removeSensor(PHY_IPhysicsController* ctrl) {}
84                 virtual void addTouchCallback(int response_class, PHY_ResponseCallback callback, void *user)
85                 {
86                 }
87                 virtual bool requestCollisionCallback(PHY_IPhysicsController* ctrl) { return false; }
88                 virtual bool removeCollisionCallback(PHY_IPhysicsController* ctrl) { return false;}
89                 virtual PHY_IPhysicsController* CreateSphereController(float radius,const PHY__Vector3& position) {return 0;}
90                 virtual PHY_IPhysicsController* CreateConeController(float coneradius,float coneheight) { return 0;}
91
92                 virtual void    setConstraintParam(int constraintId,int param,float value,float value1)
93                 {
94                 }
95
96                 virtual float   getConstraintParam(int constraintId,int param)
97                 {
98                         return 0.f;
99                 }
100
101                 
102 #ifdef WITH_CXX_GUARDEDALLOC
103 public:
104         void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "GE:DummyPhysicsEnvironment"); }
105         void operator delete( void *mem ) { MEM_freeN(mem); }
106 #endif
107 };
108
109 #endif //_DUMMYPHYSICSENVIRONMENT
110