Updated to Box2D 2.3.0
[qml-box2d:qml-box2d-folibis.git] / Box2D / Common / b2Settings.h
1 /*
2 * Copyright (c) 2006-2009 Erin Catto http://www.box2d.org
3 *
4 * This software is provided 'as-is', without any express or implied
5 * warranty.  In no event will the authors be held liable for any damages
6 * 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
9 * freely, subject to the following restrictions:
10 * 1. The origin of this software must not be misrepresented; you must not
11 * claim that you wrote the original software. If you use this software
12 * in a product, an acknowledgment in the product documentation would be
13 * appreciated but is not required.
14 * 2. Altered source versions must be plainly marked as such, and must not be
15 * misrepresented as being the original software.
16 * 3. This notice may not be removed or altered from any source distribution.
17 */
18
19 #ifndef B2_SETTINGS_H
20 #define B2_SETTINGS_H
21
22 #include <stddef.h>
23 #include <assert.h>
24 #include <float.h>
25
26 #define B2_NOT_USED(x) ((void)(x))
27 #define b2Assert(A) assert(A)
28
29 typedef signed char     int8;
30 typedef signed short int16;
31 typedef signed int int32;
32 typedef unsigned char uint8;
33 typedef unsigned short uint16;
34 typedef unsigned int uint32;
35 typedef float float32;
36 typedef double float64;
37
38 #define b2_maxFloat             FLT_MAX
39 #define b2_epsilon              FLT_EPSILON
40 #define b2_pi                   3.14159265359f
41
42 /// @file
43 /// Global tuning constants based on meters-kilograms-seconds (MKS) units.
44 ///
45
46 // Collision
47
48 /// The maximum number of contact points between two convex shapes. Do
49 /// not change this value.
50 #define b2_maxManifoldPoints    2
51
52 /// The maximum number of vertices on a convex polygon. You cannot increase
53 /// this too much because b2BlockAllocator has a maximum object size.
54 #define b2_maxPolygonVertices   8
55
56 /// This is used to fatten AABBs in the dynamic tree. This allows proxies
57 /// to move by a small amount without triggering a tree adjustment.
58 /// This is in meters.
59 #define b2_aabbExtension                0.1f
60
61 /// This is used to fatten AABBs in the dynamic tree. This is used to predict
62 /// the future position based on the current displacement.
63 /// This is a dimensionless multiplier.
64 #define b2_aabbMultiplier               2.0f
65
66 /// A small length used as a collision and constraint tolerance. Usually it is
67 /// chosen to be numerically significant, but visually insignificant.
68 #define b2_linearSlop                   0.005f
69
70 /// A small angle used as a collision and constraint tolerance. Usually it is
71 /// chosen to be numerically significant, but visually insignificant.
72 #define b2_angularSlop                  (2.0f / 180.0f * b2_pi)
73
74 /// The radius of the polygon/edge shape skin. This should not be modified. Making
75 /// this smaller means polygons will have an insufficient buffer for continuous collision.
76 /// Making it larger may create artifacts for vertex collision.
77 #define b2_polygonRadius                (2.0f * b2_linearSlop)
78
79 /// Maximum number of sub-steps per contact in continuous physics simulation.
80 #define b2_maxSubSteps                  8
81
82
83 // Dynamics
84
85 /// Maximum number of contacts to be handled to solve a TOI impact.
86 #define b2_maxTOIContacts                       32
87
88 /// A velocity threshold for elastic collisions. Any collision with a relative linear
89 /// velocity below this threshold will be treated as inelastic.
90 #define b2_velocityThreshold            1.0f
91
92 /// The maximum linear position correction used when solving constraints. This helps to
93 /// prevent overshoot.
94 #define b2_maxLinearCorrection          0.2f
95
96 /// The maximum angular position correction used when solving constraints. This helps to
97 /// prevent overshoot.
98 #define b2_maxAngularCorrection         (8.0f / 180.0f * b2_pi)
99
100 /// The maximum linear velocity of a body. This limit is very large and is used
101 /// to prevent numerical problems. You shouldn't need to adjust this.
102 #define b2_maxTranslation                       2.0f
103 #define b2_maxTranslationSquared        (b2_maxTranslation * b2_maxTranslation)
104
105 /// The maximum angular velocity of a body. This limit is very large and is used
106 /// to prevent numerical problems. You shouldn't need to adjust this.
107 #define b2_maxRotation                          (0.5f * b2_pi)
108 #define b2_maxRotationSquared           (b2_maxRotation * b2_maxRotation)
109
110 /// This scale factor controls how fast overlap is resolved. Ideally this would be 1 so
111 /// that overlap is removed in one time step. However using values close to 1 often lead
112 /// to overshoot.
113 #define b2_baumgarte                            0.2f
114 #define b2_toiBaugarte                          0.75f
115
116
117 // Sleep
118
119 /// The time that a body must be still before it will go to sleep.
120 #define b2_timeToSleep                          0.5f
121
122 /// A body cannot sleep if its linear velocity is above this tolerance.
123 #define b2_linearSleepTolerance         0.01f
124
125 /// A body cannot sleep if its angular velocity is above this tolerance.
126 #define b2_angularSleepTolerance        (2.0f / 180.0f * b2_pi)
127
128 // Memory Allocation
129
130 /// Implement this function to use your own memory allocator.
131 void* b2Alloc(int32 size);
132
133 /// If you implement b2Alloc, you should also implement this function.
134 void b2Free(void* mem);
135
136 /// Logging function.
137 void b2Log(const char* string, ...);
138
139 /// Version numbering scheme.
140 /// See http://en.wikipedia.org/wiki/Software_versioning
141 struct b2Version
142 {
143         int32 major;            ///< significant changes
144         int32 minor;            ///< incremental changes
145         int32 revision;         ///< bug fixes
146 };
147
148 /// Current version.
149 extern b2Version b2_version;
150
151 #endif