Merge branch 'blender2.7'
[blender.git] / intern / rigidbody / RBI_api.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2013 Blender Foundation,
17  * All rights reserved.
18  */
19
20 /** \file \ingroup RigidBody
21  *  \brief Rigid Body API for interfacing with external Physics Engines
22  */
23
24 #ifndef __RB_API_H__
25 #define __RB_API_H__
26
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30
31 /* API Notes:
32  * Currently, this API is optimised for Bullet RigidBodies, and doesn't
33  * take into account other Physics Engines. Some tweaking may be necessary
34  * to allow other systems to be used, in particular there may be references
35  * to datatypes that aren't used here...
36  *
37  * -- Joshua Leung (22 June 2010)
38  */
39
40 /* ********************************** */
41 /* Partial Type Defines - Aliases for the type of data we store */
42
43 // ----------
44
45 /* Dynamics World */
46 typedef struct rbDynamicsWorld rbDynamicsWorld;
47
48 /* Rigid Body */
49 typedef struct rbRigidBody rbRigidBody;
50
51 /* Collision Shape */
52 typedef struct rbCollisionShape rbCollisionShape;
53
54 /* Mesh Data (for Collision Shapes of Meshes) */
55 typedef struct rbMeshData rbMeshData;
56
57 /* Constraint */
58 typedef struct rbConstraint rbConstraint;
59
60 /* ********************************** */
61 /* Dynamics World Methods */
62
63 /* Setup ---------------------------- */
64
65 /* Create a new dynamics world instance */
66 // TODO: add args to set the type of constraint solvers, etc.
67 rbDynamicsWorld *RB_dworld_new(const float gravity[3]);
68
69 /* Delete the given dynamics world, and free any extra data it may require */
70 void RB_dworld_delete(rbDynamicsWorld *world);
71
72 /* Settings ------------------------- */
73
74 /* Gravity */
75 void RB_dworld_get_gravity(rbDynamicsWorld *world, float g_out[3]);
76 void RB_dworld_set_gravity(rbDynamicsWorld *world, const float g_in[3]);
77
78 /* Constraint Solver */
79 void RB_dworld_set_solver_iterations(rbDynamicsWorld *world, int num_solver_iterations);
80 /* Split Impulse */
81 void RB_dworld_set_split_impulse(rbDynamicsWorld *world, int split_impulse);
82
83 /* Simulation ----------------------- */
84
85 /* Step the simulation by the desired amount (in seconds) with extra controls on substep sizes and maximum substeps */
86 void RB_dworld_step_simulation(rbDynamicsWorld *world, float timeStep, int maxSubSteps, float timeSubStep);
87
88 /* Export -------------------------- */
89
90 /* Exports the dynamics world to physics simulator's serialisation format */
91 void RB_dworld_export(rbDynamicsWorld *world, const char *filename);
92
93 /* ********************************** */
94 /* Rigid Body Methods */
95
96 /* Setup ---------------------------- */
97
98 /* Add RigidBody to dynamics world */
99 void RB_dworld_add_body(rbDynamicsWorld *world, rbRigidBody *body, int col_groups);
100
101 /* Remove RigidBody from dynamics world */
102 void RB_dworld_remove_body(rbDynamicsWorld *world, rbRigidBody *body);
103
104 /* Collision detection */
105
106 void RB_world_convex_sweep_test(
107         rbDynamicsWorld *world, rbRigidBody *object,
108         const float loc_start[3], const float loc_end[3],
109         float v_location[3],  float v_hitpoint[3],  float v_normal[3], int *r_hit);
110
111 /* ............ */
112
113 /* Create new RigidBody instance */
114 rbRigidBody *RB_body_new(rbCollisionShape *shape, const float loc[3], const float rot[4]);
115
116 /* Delete the given RigidBody instance */
117 void RB_body_delete(rbRigidBody *body);
118
119 /* Settings ------------------------- */
120
121 /* 'Type' */
122 void RB_body_set_type(rbRigidBody *body, int type, float mass);
123
124 /* ............ */
125
126 /* Collision Shape */
127 void RB_body_set_collision_shape(rbRigidBody *body, rbCollisionShape *shape);
128
129 /* ............ */
130
131 /* Mass */
132 float RB_body_get_mass(rbRigidBody *body);
133 void RB_body_set_mass(rbRigidBody *body, float value);
134
135 /* Friction */
136 float RB_body_get_friction(rbRigidBody *body);
137 void RB_body_set_friction(rbRigidBody *body, float value);
138
139 /* Restitution */
140 float RB_body_get_restitution(rbRigidBody *body);
141 void RB_body_set_restitution(rbRigidBody *body, float value);
142
143 /* Damping */
144 float RB_body_get_linear_damping(rbRigidBody *body);
145 void RB_body_set_linear_damping(rbRigidBody *body, float value);
146
147 float RB_body_get_angular_damping(rbRigidBody *body);
148 void RB_body_set_angular_damping(rbRigidBody *body, float value);
149
150 void RB_body_set_damping(rbRigidBody *object, float linear, float angular);
151
152 /* Sleeping Thresholds */
153 float RB_body_get_linear_sleep_thresh(rbRigidBody *body);
154 void RB_body_set_linear_sleep_thresh(rbRigidBody *body, float value);
155
156 float RB_body_get_angular_sleep_thresh(rbRigidBody *body);
157 void RB_body_set_angular_sleep_thresh(rbRigidBody *body, float value);
158
159 void RB_body_set_sleep_thresh(rbRigidBody *body, float linear, float angular);
160
161 /* Linear Velocity */
162 void RB_body_get_linear_velocity(rbRigidBody *body, float v_out[3]);
163 void RB_body_set_linear_velocity(rbRigidBody *body, const float v_in[3]);
164
165 /* Angular Velocity */
166 void RB_body_get_angular_velocity(rbRigidBody *body, float v_out[3]);
167 void RB_body_set_angular_velocity(rbRigidBody *body, const float v_in[3]);
168
169 /* Linear/Angular Factor, used to lock translation/roation axes */
170 void RB_body_set_linear_factor(rbRigidBody *object, float x, float y, float z);
171 void RB_body_set_angular_factor(rbRigidBody *object, float x, float y, float z);
172
173 /* Kinematic State */
174 void RB_body_set_kinematic_state(rbRigidBody *body, int kinematic);
175
176 /* RigidBody Interface - Rigid Body Activation States */
177 int RB_body_get_activation_state(rbRigidBody *body);
178 void RB_body_set_activation_state(rbRigidBody *body, int use_deactivation);
179 void RB_body_activate(rbRigidBody *body);
180 void RB_body_deactivate(rbRigidBody *body);
181
182
183 /* Simulation ----------------------- */
184
185 /* Get current transform matrix of RigidBody to use in Blender (OpenGL format) */
186 void RB_body_get_transform_matrix(rbRigidBody *body, float m_out[4][4]);
187
188 /* Set RigidBody's location and rotation */
189 void RB_body_set_loc_rot(rbRigidBody *body, const float loc[3], const float rot[4]);
190 /* Set RigidBody's local scaling */
191 void RB_body_set_scale(rbRigidBody *body, const float scale[3]);
192
193 /* ............ */
194
195 /* Get RigidBody's position as vector */
196 void RB_body_get_position(rbRigidBody *body, float v_out[3]);
197 /* Get RigidBody's orientation as quaternion */
198 void RB_body_get_orientation(rbRigidBody *body, float v_out[4]);
199
200 /* ............ */
201
202 void RB_body_apply_central_force(rbRigidBody *body, const float v_in[3]);
203
204 /* ********************************** */
205 /* Collision Shape Methods */
206
207 /* Setup (Standard Shapes) ----------- */
208
209 rbCollisionShape *RB_shape_new_box(float x, float y, float z);
210 rbCollisionShape *RB_shape_new_sphere(float radius);
211 rbCollisionShape *RB_shape_new_capsule(float radius, float height);
212 rbCollisionShape *RB_shape_new_cone(float radius, float height);
213 rbCollisionShape *RB_shape_new_cylinder(float radius, float height);
214
215 /* Setup (Convex Hull) ------------ */
216
217 rbCollisionShape *RB_shape_new_convex_hull(float *verts, int stride, int count, float margin, bool *can_embed);
218
219 /* Setup (Triangle Mesh) ---------- */
220
221 /* 1 */
222 rbMeshData *RB_trimesh_data_new(int num_tris, int num_verts);
223 void RB_trimesh_add_vertices(rbMeshData *mesh, float *vertices, int num_verts, int vert_stride);
224 void RB_trimesh_add_triangle_indices(rbMeshData *mesh, int num, int index0, int index1, int index2);
225 void RB_trimesh_finish(rbMeshData *mesh);
226 /* 2a - Triangle Meshes */
227 rbCollisionShape *RB_shape_new_trimesh(rbMeshData *mesh);
228 /* 2b - GImpact Meshes */
229 rbCollisionShape *RB_shape_new_gimpact_mesh(rbMeshData *mesh);
230
231
232 /* Cleanup --------------------------- */
233
234 void RB_shape_delete(rbCollisionShape *shape);
235
236 /* Settings --------------------------- */
237
238 /* Collision Margin */
239 float RB_shape_get_margin(rbCollisionShape *shape);
240 void RB_shape_set_margin(rbCollisionShape *shape, float value);
241
242 void RB_shape_trimesh_update(rbCollisionShape *shape, float *vertices, int num_verts, int vert_stride, float min[3], float max[3]);
243
244 /* ********************************** */
245 /* Constraints */
246
247 /* Setup ----------------------------- */
248
249 /* Add Rigid Body Constraint to simulation world */
250 void RB_dworld_add_constraint(rbDynamicsWorld *world, rbConstraint *con, int disable_collisions);
251
252 /* Remove Rigid Body Constraint from simulation world */
253 void RB_dworld_remove_constraint(rbDynamicsWorld *world, rbConstraint *con);
254
255 rbConstraint *RB_constraint_new_point(float pivot[3], rbRigidBody *rb1, rbRigidBody *rb2);
256 rbConstraint *RB_constraint_new_fixed(float pivot[3], float orn[4], rbRigidBody *rb1, rbRigidBody *rb2);
257 rbConstraint *RB_constraint_new_hinge(float pivot[3], float orn[4], rbRigidBody *rb1, rbRigidBody *rb2);
258 rbConstraint *RB_constraint_new_slider(float pivot[3], float orn[4], rbRigidBody *rb1, rbRigidBody *rb2);
259 rbConstraint *RB_constraint_new_piston(float pivot[3], float orn[4], rbRigidBody *rb1, rbRigidBody *rb2);
260 rbConstraint *RB_constraint_new_6dof(float pivot[3], float orn[4], rbRigidBody *rb1, rbRigidBody *rb2);
261 rbConstraint *RB_constraint_new_6dof_spring(float pivot[3], float orn[4], rbRigidBody *rb1, rbRigidBody *rb2);
262 rbConstraint *RB_constraint_new_6dof_spring2(float pivot[3], float orn[4], rbRigidBody *rb1, rbRigidBody *rb2);
263 rbConstraint *RB_constraint_new_motor(float pivot[3], float orn[4], rbRigidBody *rb1, rbRigidBody *rb2);
264
265 /* ............ */
266
267 /* Cleanup --------------------------- */
268
269 void RB_constraint_delete(rbConstraint *con);
270
271 /* Settings --------------------------- */
272
273 /* Enable or disable constraint */
274 void RB_constraint_set_enabled(rbConstraint *con, int enabled);
275
276 /* Limits */
277 #define RB_LIMIT_LIN_X 0
278 #define RB_LIMIT_LIN_Y 1
279 #define RB_LIMIT_LIN_Z 2
280 #define RB_LIMIT_ANG_X 3
281 #define RB_LIMIT_ANG_Y 4
282 #define RB_LIMIT_ANG_Z 5
283 /* Bullet uses the following convention:
284  * - lower limit == upper limit -> axis is locked
285  * - lower limit > upper limit -> axis is free
286  * - lower limit < upper limit -> axis is limited in given range
287  */
288 void RB_constraint_set_limits_hinge(rbConstraint *con, float lower, float upper);
289 void RB_constraint_set_limits_slider(rbConstraint *con, float lower, float upper);
290 void RB_constraint_set_limits_piston(rbConstraint *con, float lin_lower, float lin_upper, float ang_lower, float ang_upper);
291 void RB_constraint_set_limits_6dof(rbConstraint *con, int axis, float lower, float upper);
292
293 /* 6dof spring specific */
294 void RB_constraint_set_stiffness_6dof_spring(rbConstraint *con, int axis, float stiffness);
295 void RB_constraint_set_damping_6dof_spring(rbConstraint *con, int axis, float damping);
296 void RB_constraint_set_spring_6dof_spring(rbConstraint *con, int axis, int enable);
297 void RB_constraint_set_equilibrium_6dof_spring(rbConstraint *con);
298
299 /* 6dof spring 2 specific */
300 void RB_constraint_set_limits_6dof_spring2(rbConstraint *con, int axis, float lower, float upper);
301 void RB_constraint_set_stiffness_6dof_spring2(rbConstraint *con, int axis, float stiffness);
302 void RB_constraint_set_damping_6dof_spring2(rbConstraint *con, int axis, float damping);
303 void RB_constraint_set_spring_6dof_spring2(rbConstraint *con, int axis, int enable);
304 void RB_constraint_set_equilibrium_6dof_spring2(rbConstraint *con);
305
306 /* motors */
307 void RB_constraint_set_enable_motor(rbConstraint *con, int enable_lin, int enable_ang);
308 void RB_constraint_set_max_impulse_motor(rbConstraint *con, float max_impulse_lin, float max_impulse_ang);
309 void RB_constraint_set_target_velocity_motor(rbConstraint *con, float velocity_lin, float velocity_ang);
310
311 /* Set number of constraint solver iterations made per step, this overrided world setting
312  * To use default set it to -1 */
313 void RB_constraint_set_solver_iterations(rbConstraint *con, int num_solver_iterations);
314
315 /* Set breaking impulse threshold, if constraint shouldn't break it can be set to FLT_MAX */
316 void RB_constraint_set_breaking_threshold(rbConstraint *con, float threshold);
317
318 /* ********************************** */
319
320 #ifdef __cplusplus
321 }
322 #endif
323
324 #endif /* __RB_API_H__ */
325