update Bullet 2.x with latest changes, notice that the integration is not finished...
[blender.git] / extern / bullet2 / src / BulletCollision / CollisionDispatch / btCollisionWorld.h
1 /*
2 Bullet Continuous Collision Detection and Physics Library
3 Copyright (c) 2003-2006 Erwin Coumans  http://continuousphysics.com/Bullet/
4
5 This software is provided 'as-is', without any express or implied warranty.
6 In no event will the authors be held liable for any damages arising from the use of this software.
7 Permission is granted to anyone to use this software for any purpose, 
8 including commercial applications, and to alter it and redistribute it freely, 
9 subject to the following restrictions:
10
11 1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.
12 2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
13 3. This notice may not be removed or altered from any source distribution.
14 */
15
16
17 /**
18  * @mainpage Bullet Documentation
19  *
20  * @section intro_sec Introduction
21  * Bullet Collision Detection & Physics SDK
22  *
23  * Bullet is a Collision Detection and Rigid Body Dynamics Library. The Library is Open Source and free for commercial use, under the ZLib license ( http://opensource.org/licenses/zlib-license.php ).
24  *
25  * There is the Physics Forum for Feedback and bteral Collision Detection and Physics discussions.
26  * Please visit http://www.continuousphysics.com/Bullet/phpBB2/index.php
27  *
28  * @section install_sec Installation
29  *
30  * @subsection step1 Step 1: Download
31  * You can download the Bullet Physics Library from our website: http://www.continuousphysics.com/Bullet/
32  * @subsection step2 Step 2: Building
33  * Bullet comes with autogenerated Project Files for Microsoft Visual Studio 6, 7, 7.1 and 8.
34  * The main Workspace/Solution is located in Bullet/msvc/8/wksbullet.sln (replace 8 with your version).
35  * 
36  * Under other platforms, like Linux or Mac OS-X, Bullet can be build using either using cmake, http://www.cmake.org, or jam, http://www.perforce.com/jam/jam.html . cmake can autogenerate Xcode, KDevelop, MSVC and other build systems. just run cmake . in the root of Bullet.
37  * Jam is a build system that can build the library, demos and also autogenerate the MSVC Project Files.
38  * So if you are not using MSVC, you can run configure and jam .
39  * If you don't have jam installed, you can make jam from the included jam-2.5 sources, or download jam from ftp://ftp.perforce.com/pub/jam/
40  * 
41  * @subsection step3 Step 3: Testing demos
42  * Try to run and experiment with CcdPhysicsDemo executable as a starting point.
43  * Bullet can be used in several ways, as Full Rigid Body simulation, as Collision Detector Library or Low Level / Snippets like the GJK Closest Point calculation.
44  * The Dependencies can be seen in this documentation under Directories
45  * 
46  * @subsection step4 Step 4: Integrating in your application, Full Rigid Body Simulation
47  * Check out CcdPhysicsDemo how to create a btDynamicsWorld, btRigidBody and btCollisionShape, Stepping the simulation and synchronizing your graphics object transform.
48  * PLEASE NOTE THE CcdPhysicsEnvironment and CcdPhysicsController is obsolete and will be removed. It has been replaced by classes derived frmo btDynamicsWorld and btRididBody
49  * @subsection step5 Step 5 : Integrate the Collision Detection Library (without Dynamics and other Extras)
50  * Bullet Collision Detection can also be used without the Dynamics/Extras.
51  * Check out btCollisionWorld and btCollisionObject, and the CollisionInterfaceDemo. Also in Extras/test_BulletOde.cpp there is a sample Collision Detection integration with Open Dynamics Engine, ODE, http://www.ode.org
52  * @subsection step6 Step 6 : Use Snippets like the GJK Closest Point calculation.
53  * Bullet has been designed in a modular way keeping dependencies to a minimum. The ConvexHullDistance demo demonstrates direct use of btGjkPairDetector.
54  *
55  * @section copyright Copyright
56  * Copyright (C) 2005-2006 Erwin Coumans, some contributions Copyright Gino van den Bergen, Christer Ericson, Simon Hobbs, Ricardo Padrela, F Richter(res), Stephane Redon
57  * Special thanks to all visitors of the Bullet Physics forum, and in particular above contributors, Dave Eberle, Dirk Gregorius, Erin Catto, Dave Eberle, Adam Moravanszky,
58  * Pierre Terdiman, Kenny Erleben, Russell Smith, Oliver Strunk, Jan Paul van Waveren.
59  * 
60  */
61  
62  
63
64 #ifndef COLLISION_WORLD_H
65 #define COLLISION_WORLD_H
66
67
68 class btCollisionShape;
69 class btBroadphaseInterface;
70 #include "LinearMath/btVector3.h"
71 #include "LinearMath/btTransform.h"
72 #include "btCollisionObject.h"
73 #include "btCollisionDispatcher.h" //for definition of btCollisionObjectArray
74 #include "BulletCollision/BroadphaseCollision/btOverlappingPairCache.h"
75
76 #include <vector>
77
78
79
80 ///CollisionWorld is interface and container for the collision detection
81 class btCollisionWorld
82 {
83
84         
85 protected:
86
87         std::vector<btCollisionObject*> m_collisionObjects;
88         
89         btDispatcher*   m_dispatcher1;
90
91         btOverlappingPairCache* m_broadphasePairCache;
92         
93         bool    m_ownsDispatcher;
94         bool    m_ownsBroadphasePairCache;
95
96 public:
97
98         //this constructor will create and own a dispatcher and paircache and delete it at destruction
99         btCollisionWorld();
100
101         //this constructor doesn't own the dispatcher and paircache/broadphase
102         btCollisionWorld(btDispatcher* dispatcher,btOverlappingPairCache* pairCache);
103
104         virtual ~btCollisionWorld();
105
106
107         btBroadphaseInterface*  getBroadphase()
108         {
109                 return m_broadphasePairCache;
110         }
111
112         btOverlappingPairCache* getPairCache()
113         {
114                 return m_broadphasePairCache;
115         }
116
117
118         btDispatcher*   getDispatcher()
119         {
120                 return m_dispatcher1;
121         }
122
123         ///LocalShapeInfo gives extra information for complex shapes
124         ///Currently, only btTriangleMeshShape is available, so it just contains triangleIndex and subpart
125         struct  LocalShapeInfo
126         {
127                 int     m_shapePart;
128                 int     m_triangleIndex;
129                 
130                 //const btCollisionShape*       m_shapeTemp;
131                 //const btTransform*    m_shapeLocalTransform;
132         };
133
134         struct  LocalRayResult
135         {
136                 LocalRayResult(btCollisionObject*       collisionObject, 
137                         LocalShapeInfo* localShapeInfo,
138                         const btVector3&                hitNormalLocal,
139                         float hitFraction)
140                 :m_collisionObject(collisionObject),
141                 m_localShapeInfo(m_localShapeInfo),
142                 m_hitNormalLocal(hitNormalLocal),
143                 m_hitFraction(hitFraction)
144                 {
145                 }
146
147                 btCollisionObject*      m_collisionObject;
148                 LocalShapeInfo*                 m_localShapeInfo;
149                 const btVector3&                m_hitNormalLocal;
150                 float                                   m_hitFraction;
151
152         };
153
154         ///RayResultCallback is used to report new raycast results
155         struct  RayResultCallback
156         {
157                 virtual ~RayResultCallback()
158                 {
159                 }
160                 float   m_closestHitFraction;
161                 bool    HasHit()
162                 {
163                         return (m_closestHitFraction < 1.f);
164                 }
165
166                 RayResultCallback()
167                         :m_closestHitFraction(1.f)
168                 {
169                 }
170                 virtual float   AddSingleResult(LocalRayResult& rayResult) = 0;
171         };
172
173         struct  ClosestRayResultCallback : public RayResultCallback
174         {
175                 ClosestRayResultCallback(btVector3      rayFromWorld,btVector3  rayToWorld)
176                 :m_rayFromWorld(rayFromWorld),
177                 m_rayToWorld(rayToWorld),
178                 m_collisionObject(0)
179                 {
180                 }
181
182                 btVector3       m_rayFromWorld;//used to calculate hitPointWorld from hitFraction
183                 btVector3       m_rayToWorld;
184
185                 btVector3       m_hitNormalWorld;
186                 btVector3       m_hitPointWorld;
187                 btCollisionObject*      m_collisionObject;
188                 
189                 virtual float   AddSingleResult(LocalRayResult& rayResult)
190                 {
191
192 //caller already does the filter on the m_closestHitFraction
193                         assert(rayResult.m_hitFraction <= m_closestHitFraction);
194                         
195                         m_closestHitFraction = rayResult.m_hitFraction;
196                         m_collisionObject = rayResult.m_collisionObject;
197                         m_hitNormalWorld = m_collisionObject->m_worldTransform.getBasis()*rayResult.m_hitNormalLocal;
198                         m_hitPointWorld.setInterpolate3(m_rayFromWorld,m_rayToWorld,rayResult.m_hitFraction);
199                         return rayResult.m_hitFraction;
200                 }
201         };
202
203
204         
205
206         int     getNumCollisionObjects() const
207         {
208                 return int(m_collisionObjects.size());
209         }
210
211         /// rayTest performs a raycast on all objects in the btCollisionWorld, and calls the resultCallback
212         /// This allows for several queries: first hit, all hits, any hit, dependent on the value returned by the callback.
213         void    rayTest(const btVector3& rayFromWorld, const btVector3& rayToWorld, RayResultCallback& resultCallback);
214
215         /// rayTestSingle performs a raycast call and calls the resultCallback. It is used internally by rayTest.
216         /// In a future implementation, we consider moving the ray test as a virtual method in btCollisionShape.
217         /// This allows more customization.
218         void    rayTestSingle(const btTransform& rayFromTrans,const btTransform& rayToTrans,
219                                           btCollisionObject* collisionObject,
220                                           const btCollisionShape* collisionShape,
221                                           const btTransform& colObjWorldTransform,
222                                           RayResultCallback& resultCallback);
223
224         void    addCollisionObject(btCollisionObject* collisionObject,short int collisionFilterGroup=1,short int collisionFilterMask=1);
225
226         btCollisionObjectArray& getCollisionObjectArray()
227         {
228                 return m_collisionObjects;
229         }
230
231         const btCollisionObjectArray& getCollisionObjectArray() const
232         {
233                 return m_collisionObjects;
234         }
235
236
237         void    removeCollisionObject(btCollisionObject* collisionObject);
238
239         virtual void    performDiscreteCollisionDetection();
240
241 };
242
243
244 #endif //COLLISION_WORLD_H