Chipmunk2D Pro API Reference  7.0.3
 All Classes Functions Variables Typedefs Enumerations Enumerator Properties Groups Pages
chipmunk.h
1 /* Copyright (c) 2013 Scott Lembcke and Howling Moon Software
2  *
3  * Permission is hereby granted, free of charge, to any person obtaining a copy
4  * of this software and associated documentation files (the "Software"), to deal
5  * in the Software without restriction, including without limitation the rights
6  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7  * copies of the Software, and to permit persons to whom the Software is
8  * furnished to do so, subject to the following conditions:
9  *
10  * The above copyright notice and this permission notice shall be included in
11  * all copies or substantial portions of the Software.
12  *
13  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19  * SOFTWARE.
20  */
21 
22 #ifndef CHIPMUNK_H
23 #define CHIPMUNK_H
24 
25 #include <stdlib.h>
26 #include <math.h>
27 
28 #ifndef alloca
29  #ifdef _WIN32
30  #include <malloc.h>
31  #elif defined(__FreeBSD__)
32  /* already included in <stdlib.h> */
33  #else
34  #include <alloca.h>
35  #endif
36 #endif
37 
38 #ifdef _WIN32
39  #define CP_EXPORT __declspec(dllexport)
40 #else
41  #define CP_EXPORT
42 #endif
43 
44 #ifdef __cplusplus
45 extern "C" {
46 #endif
47 
48 CP_EXPORT void cpMessage(const char *condition, const char *file, int line, int isError, int isHardError, const char *message, ...);
49 #ifdef NDEBUG
50  #define cpAssertWarn(__condition__, ...)
51  #define cpAssertSoft(__condition__, ...)
52 #else
53  #define cpAssertSoft(__condition__, ...) if(!(__condition__)){cpMessage(#__condition__, __FILE__, __LINE__, 1, 0, __VA_ARGS__); abort();}
54  #define cpAssertWarn(__condition__, ...) if(!(__condition__)) cpMessage(#__condition__, __FILE__, __LINE__, 0, 0, __VA_ARGS__)
55 #endif
56 
57 // Hard assertions are used in situations where the program definitely will crash anyway, and the reason is inexpensive to detect.
58 #define cpAssertHard(__condition__, ...) if(!(__condition__)){cpMessage(#__condition__, __FILE__, __LINE__, 1, 1, __VA_ARGS__); abort();}
59 
60 #include "chipmunk_types.h"
61 
64 
66 #ifndef CP_BUFFER_BYTES
67  #define CP_BUFFER_BYTES (32*1024)
68 #endif
69 
70 #ifndef cpcalloc
71 
72  #define cpcalloc calloc
73 #endif
74 
75 #ifndef cprealloc
76 
77  #define cprealloc realloc
78 #endif
79 
80 #ifndef cpfree
81 
82  #define cpfree free
83 #endif
84 
85 typedef struct cpArray cpArray;
86 typedef struct cpHashSet cpHashSet;
87 
88 typedef struct cpBody cpBody;
89 
90 typedef struct cpShape cpShape;
91 typedef struct cpCircleShape cpCircleShape;
92 typedef struct cpSegmentShape cpSegmentShape;
93 typedef struct cpPolyShape cpPolyShape;
94 
95 typedef struct cpConstraint cpConstraint;
96 typedef struct cpPinJoint cpPinJoint;
97 typedef struct cpSlideJoint cpSlideJoint;
98 typedef struct cpPivotJoint cpPivotJoint;
99 typedef struct cpGrooveJoint cpGrooveJoint;
100 typedef struct cpDampedSpring cpDampedSpring;
103 typedef struct cpRatchetJoint cpRatchetJoint;
104 typedef struct cpGearJoint cpGearJoint;
105 typedef struct cpSimpleMotorJoint cpSimpleMotorJoint;
106 
108 typedef struct cpContactPointSet cpContactPointSet;
109 typedef struct cpArbiter cpArbiter;
110 
111 typedef struct cpSpace cpSpace;
112 
113 #include "cpVect.h"
114 #include "cpBB.h"
115 #include "cpTransform.h"
116 #include "cpSpatialIndex.h"
117 
118 #include "cpArbiter.h"
119 
120 #include "cpBody.h"
121 #include "cpShape.h"
122 #include "cpPolyShape.h"
123 
124 #include "cpConstraint.h"
125 
126 #include "cpSpace.h"
127 
128 // Chipmunk 7.0.3
129 #define CP_VERSION_MAJOR 7
130 #define CP_VERSION_MINOR 0
131 #define CP_VERSION_RELEASE 3
132 
134 CP_EXPORT extern const char *cpVersionString;
135 
138 CP_EXPORT cpFloat cpMomentForCircle(cpFloat m, cpFloat r1, cpFloat r2, cpVect offset);
139 
142 CP_EXPORT cpFloat cpAreaForCircle(cpFloat r1, cpFloat r2);
143 
146 CP_EXPORT cpFloat cpMomentForSegment(cpFloat m, cpVect a, cpVect b, cpFloat radius);
147 
149 CP_EXPORT cpFloat cpAreaForSegment(cpVect a, cpVect b, cpFloat radius);
150 
152 CP_EXPORT cpFloat cpMomentForPoly(cpFloat m, int count, const cpVect *verts, cpVect offset, cpFloat radius);
153 
156 CP_EXPORT cpFloat cpAreaForPoly(const int count, const cpVect *verts, cpFloat radius);
157 
159 CP_EXPORT cpVect cpCentroidForPoly(const int count, const cpVect *verts);
160 
162 CP_EXPORT cpFloat cpMomentForBox(cpFloat m, cpFloat width, cpFloat height);
163 
165 CP_EXPORT cpFloat cpMomentForBox2(cpFloat m, cpBB box);
166 
171 CP_EXPORT int cpConvexHull(int count, const cpVect *verts, cpVect *result, int *first, cpFloat tol);
172 
177 #define CP_CONVEX_HULL(__count__, __verts__, __count_var__, __verts_var__) \
178 cpVect *__verts_var__ = (cpVect *)alloca(__count__*sizeof(cpVect)); \
179 int __count_var__ = cpConvexHull(__count__, __verts__, __verts_var__, NULL, 0.0); \
180 
181 
182 static inline cpVect
183 cpClosetPointOnSegment(const cpVect p, const cpVect a, const cpVect b)
184 {
185  cpVect delta = cpvsub(a, b);
186  cpFloat t = cpfclamp01(cpvdot(delta, cpvsub(p, b))/cpvlengthsq(delta));
187  return cpvadd(b, cpvmult(delta, t));
188 }
189 
190 #if defined(__has_extension)
191 #if __has_extension(blocks)
192 // Define alternate block based alternatives for a few of the callback heavy functions.
193 // Collision handlers are post-step callbacks are not included to avoid memory management issues.
194 // If you want to use blocks for those and are aware of how to correctly manage the memory, the implementation is trivial.
195 
196 void cpSpaceEachBody_b(cpSpace *space, void (^block)(cpBody *body));
197 void cpSpaceEachShape_b(cpSpace *space, void (^block)(cpShape *shape));
198 void cpSpaceEachConstraint_b(cpSpace *space, void (^block)(cpConstraint *constraint));
199 
200 void cpBodyEachShape_b(cpBody *body, void (^block)(cpShape *shape));
201 void cpBodyEachConstraint_b(cpBody *body, void (^block)(cpConstraint *constraint));
202 void cpBodyEachArbiter_b(cpBody *body, void (^block)(cpArbiter *arbiter));
203 
204 typedef void (^cpSpacePointQueryBlock)(cpShape *shape, cpVect point, cpFloat distance, cpVect gradient);
205 void cpSpacePointQuery_b(cpSpace *space, cpVect point, cpFloat maxDistance, cpShapeFilter filter, cpSpacePointQueryBlock block);
206 
207 typedef void (^cpSpaceSegmentQueryBlock)(cpShape *shape, cpVect point, cpVect normal, cpFloat alpha);
208 void cpSpaceSegmentQuery_b(cpSpace *space, cpVect start, cpVect end, cpFloat radius, cpShapeFilter filter, cpSpaceSegmentQueryBlock block);
209 
210 typedef void (^cpSpaceBBQueryBlock)(cpShape *shape);
211 void cpSpaceBBQuery_b(cpSpace *space, cpBB bb, cpShapeFilter filter, cpSpaceBBQueryBlock block);
212 
213 typedef void (^cpSpaceShapeQueryBlock)(cpShape *shape, cpContactPointSet *points);
214 cpBool cpSpaceShapeQuery_b(cpSpace *space, cpShape *shape, cpSpaceShapeQueryBlock block);
215 
216 #endif
217 #endif
218 
219 
221 
222 #ifdef __cplusplus
223 }
224 
225 static inline cpVect operator *(const cpVect v, const cpFloat s){return cpvmult(v, s);}
226 static inline cpVect operator +(const cpVect v1, const cpVect v2){return cpvadd(v1, v2);}
227 static inline cpVect operator -(const cpVect v1, const cpVect v2){return cpvsub(v1, v2);}
228 static inline cpBool operator ==(const cpVect v1, const cpVect v2){return cpveql(v1, v2);}
229 static inline cpVect operator -(const cpVect v){return cpvneg(v);}
230 
231 #endif
232 #endif