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