Spelling Cleanup
[blender.git] / source / gameengine / Physics / common / PHY_IPhysicsEnvironment.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 PHY_IPhysicsEnvironment.h
29  *  \ingroup phys
30  */
31
32 #ifndef __PHY_IPHYSICSENVIRONMENT_H__
33 #define __PHY_IPHYSICSENVIRONMENT_H__
34
35 #include <vector>
36 #include "PHY_DynamicTypes.h"
37
38 #ifdef WITH_CXX_GUARDEDALLOC
39 #include "MEM_guardedalloc.h"
40 #endif
41
42 class PHY_IVehicle;
43 class RAS_MeshObject;
44 class PHY_IPhysicsController;
45
46 /**
47  * pass back information from rayTest
48  */
49 struct PHY_RayCastResult
50 {
51         PHY_IPhysicsController* m_controller;   
52         PHY__Vector3                    m_hitPoint;
53         PHY__Vector3                    m_hitNormal;
54         const RAS_MeshObject*   m_meshObject;   // !=NULL for mesh object (only for Bullet controllers) 
55         int                                             m_polygon;              // index of the polygon hit by the ray,
56                                                                                         // only if m_meshObject != NULL
57         int                     m_hitUVOK;              // !=0 if UV coordinate in m_hitUV is valid
58         PHY__Vector2                    m_hitUV;                // UV coordinates of hit point
59 };
60
61 /**
62  * This class replaces the ignoreController parameter of rayTest function. 
63  * It allows more sophisticated filtering on the physics controller before computing the ray intersection to save CPU. 
64  * It is only used to its full extend by the Ccd physics environment (Bullet).
65  */
66 class PHY_IRayCastFilterCallback
67 {
68 public:
69         PHY_IPhysicsController* m_ignoreController;
70         bool                                    m_faceNormal;
71         bool                                    m_faceUV;
72
73         virtual         ~PHY_IRayCastFilterCallback()
74         {
75         }
76
77         virtual bool needBroadphaseRayCast(PHY_IPhysicsController* controller)
78         {
79                 return true;
80         }
81
82         virtual void reportHit(PHY_RayCastResult* result) = 0;
83
84         PHY_IRayCastFilterCallback(PHY_IPhysicsController* ignoreController, bool faceNormal=false, bool faceUV=false) 
85                 :m_ignoreController(ignoreController),
86                 m_faceNormal(faceNormal),
87                 m_faceUV(faceUV)
88         {
89         }
90         
91 #ifdef WITH_CXX_GUARDEDALLOC
92 public:
93         void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "GE:PHY_IRayCastFilterCallback"); }
94         void operator delete( void *mem ) { MEM_freeN(mem); }
95 #endif
96 };
97
98 /**
99 *       Physics Environment takes care of stepping the simulation and is a container for physics entities (rigidbodies,constraints, materials etc.)
100 *       A derived class may be able to 'construct' entities by loading and/or converting
101 */
102 class PHY_IPhysicsEnvironment
103 {
104         public:
105                 virtual         ~PHY_IPhysicsEnvironment();
106                 virtual void            beginFrame() = 0;
107                 virtual void            endFrame() = 0;
108                 /// Perform an integration step of duration 'timeStep'.
109                 virtual bool            proceedDeltaTime(double curTime,float timeStep,float interval)=0;
110                 ///draw debug lines (make sure to call this during the render phase, otherwise lines are not drawn properly)
111                 virtual void            debugDrawWorld(){}
112                 virtual void            setFixedTimeStep(bool useFixedTimeStep,float fixedTimeStep)=0;
113                 //returns 0.f if no fixed timestep is used
114                 virtual float           getFixedTimeStep()=0;
115
116                 ///setDebugMode is used to support several ways of debug lines, contact point visualization
117                 virtual void            setDebugMode(int debugMode) {}
118                 ///setNumIterations set the number of iterations for iterative solvers
119                 virtual void            setNumIterations(int numIter) {}
120                 ///setNumTimeSubSteps set the number of divisions of the timestep. Tradeoff quality versus performance.
121                 virtual void            setNumTimeSubSteps(int numTimeSubSteps){}
122                 ///setDeactivationTime sets the minimum time that an objects has to stay within the velocity tresholds until it gets fully deactivated
123                 virtual void            setDeactivationTime(float dTime) {}
124                 ///setDeactivationLinearTreshold sets the linear velocity treshold, see setDeactivationTime
125                 virtual void            setDeactivationLinearTreshold(float linTresh) {}
126                 ///setDeactivationAngularTreshold sets the angular velocity treshold, see setDeactivationTime
127                 virtual void            setDeactivationAngularTreshold(float angTresh) {}
128                 ///setContactBreakingTreshold sets tresholds to do with contact point management
129                 virtual void            setContactBreakingTreshold(float contactBreakingTreshold) {}
130                 ///continuous collision detection mode, very experimental for Bullet
131                 virtual void            setCcdMode(int ccdMode) {}
132                 ///successive overrelaxation constant, in case PSOR is used, values in between 1 and 2 guarantee converging behavior
133                 virtual void            setSolverSorConstant(float sor) {}
134                 ///setSolverType, internal setting, chooses solvertype, PSOR, Dantzig, impulse based, penalty based
135                 virtual void            setSolverType(int solverType) {}
136                 ///setTau sets the spring constant of a penalty based solver
137                 virtual void            setSolverTau(float tau) {}
138                 ///setDamping sets the damper constant of a penalty based solver
139                 virtual void            setSolverDamping(float damping) {}
140                 ///linear air damping for rigidbodies
141                 virtual void            setLinearAirDamping(float damping) {}
142                 /// penetrationdepth setting
143                 virtual void            setUseEpa(bool epa) {}
144
145                 virtual void            setGravity(float x,float y,float z)=0;
146
147                 virtual int                     createConstraint(class PHY_IPhysicsController* ctrl,class PHY_IPhysicsController* ctrl2,PHY_ConstraintType type,
148                         float pivotX,float pivotY,float pivotZ,
149                         float axis0X,float axis0Y,float axis0Z,
150                         float axis1X=0,float axis1Y=0,float axis1Z=0,
151                         float axis2X=0,float axis2Y=0,float axis2Z=0,int flag=0
152                 )=0;
153                 virtual void            removeConstraint(int    constraintid)=0;
154                 virtual float           getAppliedImpulse(int   constraintid){ return 0.f;}
155
156
157                 //complex constraint for vehicles
158                 virtual PHY_IVehicle*   getVehicleConstraint(int constraintId) =0;
159
160                 virtual PHY_IPhysicsController* rayTest(PHY_IRayCastFilterCallback &filterCallback, float fromX,float fromY,float fromZ, float toX,float toY,float toZ)=0;
161
162                 //culling based on physical broad phase
163                 // the plane number must be set as follow: near, far, left, right, top, botton
164                 // the near plane must be the first one and must always be present, it is used to get the direction of the view
165                 virtual bool cullingTest(PHY_CullingCallback callback, void *userData, PHY__Vector4* planeNormals, int planeNumber, int occlusionRes) = 0;
166
167                 //Methods for gamelogic collision/physics callbacks
168                 //todo:
169                 virtual void addSensor(PHY_IPhysicsController* ctrl)=0;
170                 virtual void removeSensor(PHY_IPhysicsController* ctrl)=0;
171                 virtual void addTouchCallback(int response_class, PHY_ResponseCallback callback, void *user)=0;
172                 virtual bool requestCollisionCallback(PHY_IPhysicsController* ctrl)=0;
173                 virtual bool removeCollisionCallback(PHY_IPhysicsController* ctrl)=0;
174                 //These two methods are *solely* used to create controllers for sensor! Don't use for anything else
175                 virtual PHY_IPhysicsController* CreateSphereController(float radius,const PHY__Vector3& position) =0;
176                 virtual PHY_IPhysicsController* CreateConeController(float coneradius,float coneheight)=0;
177                 
178                 virtual void    setConstraintParam(int constraintId,int param,float value,float value1) = 0;
179                 virtual float   getConstraintParam(int constraintId,int param) = 0;
180                 
181                 virtual void    exportFile(const char* filename) {};
182                 
183 #ifdef WITH_CXX_GUARDEDALLOC
184 public:
185         void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "GE:PHY_IPhysicsEnvironment"); }
186         void operator delete( void *mem ) { MEM_freeN(mem); }
187 #endif
188 };
189
190 #endif //__PHY_IPHYSICSENVIRONMENT_H__
191