Correct own error in recent BVH nearest ray
[blender.git] / extern / bullet2 / src / BulletCollision / CollisionShapes / btCollisionShape.h
1 /*
2 Bullet Continuous Collision Detection and Physics Library
3 Copyright (c) 2003-2009 Erwin Coumans  http://bulletphysics.org
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 #ifndef BT_COLLISION_SHAPE_H
17 #define BT_COLLISION_SHAPE_H
18
19 #include "LinearMath/btTransform.h"
20 #include "LinearMath/btVector3.h"
21 #include "LinearMath/btMatrix3x3.h"
22 #include "BulletCollision/BroadphaseCollision/btBroadphaseProxy.h" //for the shape types
23 class btSerializer;
24
25
26 ///The btCollisionShape class provides an interface for collision shapes that can be shared among btCollisionObjects.
27 ATTRIBUTE_ALIGNED16(class) btCollisionShape
28 {
29 protected:
30         int m_shapeType;
31         void* m_userPointer;
32
33 public:
34
35         BT_DECLARE_ALIGNED_ALLOCATOR();
36
37         btCollisionShape() : m_shapeType (INVALID_SHAPE_PROXYTYPE), m_userPointer(0)
38         {
39         }
40
41         virtual ~btCollisionShape()
42         {
43         }
44
45         ///getAabb returns the axis aligned bounding box in the coordinate frame of the given transform t.
46         virtual void getAabb(const btTransform& t,btVector3& aabbMin,btVector3& aabbMax) const =0;
47
48         virtual void    getBoundingSphere(btVector3& center,btScalar& radius) const;
49
50         ///getAngularMotionDisc returns the maximus radius needed for Conservative Advancement to handle time-of-impact with rotations.
51         virtual btScalar        getAngularMotionDisc() const;
52
53         virtual btScalar        getContactBreakingThreshold(btScalar defaultContactThresholdFactor) const;
54
55
56         ///calculateTemporalAabb calculates the enclosing aabb for the moving object over interval [0..timeStep)
57         ///result is conservative
58         void calculateTemporalAabb(const btTransform& curTrans,const btVector3& linvel,const btVector3& angvel,btScalar timeStep, btVector3& temporalAabbMin,btVector3& temporalAabbMax) const;
59
60
61
62         SIMD_FORCE_INLINE bool  isPolyhedral() const
63         {
64                 return btBroadphaseProxy::isPolyhedral(getShapeType());
65         }
66
67         SIMD_FORCE_INLINE bool  isConvex2d() const
68         {
69                 return btBroadphaseProxy::isConvex2d(getShapeType());
70         }
71
72         SIMD_FORCE_INLINE bool  isConvex() const
73         {
74                 return btBroadphaseProxy::isConvex(getShapeType());
75         }
76         SIMD_FORCE_INLINE bool  isNonMoving() const
77         {
78                 return btBroadphaseProxy::isNonMoving(getShapeType());
79         }
80         SIMD_FORCE_INLINE bool  isConcave() const
81         {
82                 return btBroadphaseProxy::isConcave(getShapeType());
83         }
84         SIMD_FORCE_INLINE bool  isCompound() const
85         {
86                 return btBroadphaseProxy::isCompound(getShapeType());
87         }
88
89         SIMD_FORCE_INLINE bool  isSoftBody() const
90         {
91                 return btBroadphaseProxy::isSoftBody(getShapeType());
92         }
93
94         ///isInfinite is used to catch simulation error (aabb check)
95         SIMD_FORCE_INLINE bool isInfinite() const
96         {
97                 return btBroadphaseProxy::isInfinite(getShapeType());
98         }
99
100 #ifndef __SPU__
101         virtual void    setLocalScaling(const btVector3& scaling) =0;
102         virtual const btVector3& getLocalScaling() const =0;
103         virtual void    calculateLocalInertia(btScalar mass,btVector3& inertia) const = 0;
104
105
106 //debugging support
107         virtual const char*     getName()const =0 ;
108 #endif //__SPU__
109
110         
111         int             getShapeType() const { return m_shapeType; }
112
113         ///the getAnisotropicRollingFrictionDirection can be used in combination with setAnisotropicFriction
114         ///See Bullet/Demos/RollingFrictionDemo for an example
115         virtual btVector3       getAnisotropicRollingFrictionDirection() const
116         {
117                 return btVector3(1,1,1);
118         }
119         virtual void    setMargin(btScalar margin) = 0;
120         virtual btScalar        getMargin() const = 0;
121
122         
123         ///optional user data pointer
124         void    setUserPointer(void*  userPtr)
125         {
126                 m_userPointer = userPtr;
127         }
128
129         void*   getUserPointer() const
130         {
131                 return m_userPointer;
132         }
133
134         virtual int     calculateSerializeBufferSize() const;
135
136         ///fills the dataBuffer and returns the struct name (and 0 on failure)
137         virtual const char*     serialize(void* dataBuffer, btSerializer* serializer) const;
138
139         virtual void    serializeSingleShape(btSerializer* serializer) const;
140
141 };      
142
143 ///do not change those serialization structures, it requires an updated sBulletDNAstr/sBulletDNAstr64
144 struct  btCollisionShapeData
145 {
146         char    *m_name;
147         int             m_shapeType;
148         char    m_padding[4];
149 };
150
151 SIMD_FORCE_INLINE       int     btCollisionShape::calculateSerializeBufferSize() const
152 {
153         return sizeof(btCollisionShapeData);
154 }
155
156
157
158 #endif //BT_COLLISION_SHAPE_H
159