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