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