optionally use guarded alloc for tiles compositor, also replace allocation functions...
[blender.git] / source / gameengine / Physics / Dummy / DummyPhysicsEnvironment.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file DummyPhysicsEnvironment.h
29  *  \ingroup physdummy
30  */
31
32 #ifndef __DUMMYPHYSICSENVIRONMENT_H__
33 #define __DUMMYPHYSICSENVIRONMENT_H__
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,float interval);
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                         float axis1X=0,float axis1Y=0,float axis1Z=0,
64                         float axis2X=0,float axis2Y=0,float axis2Z=0,int flag=0
65                         );
66
67         virtual void            removeConstraint(int    constraintid);
68
69                 //complex constraint for vehicles
70         virtual PHY_IVehicle*   getVehicleConstraint(int constraintId)
71         {
72                 return 0;
73         }
74
75         virtual PHY_IPhysicsController* rayTest(PHY_IRayCastFilterCallback &filterCallback, float fromX,float fromY,float fromZ, float toX,float toY,float toZ);
76         virtual bool cullingTest(PHY_CullingCallback callback, void* userData, PHY__Vector4* planes, int nplanes, int occlusionRes) { return false; }
77
78
79         //gamelogic callbacks
80                 virtual void addSensor(PHY_IPhysicsController* ctrl) {}
81                 virtual void removeSensor(PHY_IPhysicsController* ctrl) {}
82                 virtual void addTouchCallback(int response_class, PHY_ResponseCallback callback, void *user)
83                 {
84                 }
85                 virtual bool requestCollisionCallback(PHY_IPhysicsController* ctrl) { return false; }
86                 virtual bool removeCollisionCallback(PHY_IPhysicsController* ctrl) { return false;}
87                 virtual PHY_IPhysicsController* CreateSphereController(float radius,const PHY__Vector3& position) {return 0;}
88                 virtual PHY_IPhysicsController* CreateConeController(float coneradius,float coneheight) { return 0;}
89
90                 virtual void    setConstraintParam(int constraintId,int param,float value,float value1)
91                 {
92                 }
93
94                 virtual float   getConstraintParam(int constraintId,int param)
95                 {
96                         return 0.f;
97                 }
98
99                 
100 #ifdef WITH_CXX_GUARDEDALLOC
101         MEM_CXX_CLASS_ALLOC_FUNCS("GE:DummyPhysicsEnvironment")
102 #endif
103 };
104
105 #endif //__DUMMYPHYSICSENVIRONMENT_H__
106