Fix T66072: GPencil "stroke placement:surface" uses "stroke placement:stroke"s target...
[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
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
87  * maximum substeps */
88 void RB_dworld_step_simulation(rbDynamicsWorld *world,
89                                float timeStep,
90                                int maxSubSteps,
91                                float timeSubStep);
92
93 /* Export -------------------------- */
94
95 /* Exports the dynamics world to physics simulator's serialisation format */
96 void RB_dworld_export(rbDynamicsWorld *world, const char *filename);
97
98 /* ********************************** */
99 /* Rigid Body Methods */
100
101 /* Setup ---------------------------- */
102
103 /* Add RigidBody to dynamics world */
104 void RB_dworld_add_body(rbDynamicsWorld *world, rbRigidBody *body, int col_groups);
105
106 /* Remove RigidBody from dynamics world */
107 void RB_dworld_remove_body(rbDynamicsWorld *world, rbRigidBody *body);
108
109 /* Collision detection */
110
111 void RB_world_convex_sweep_test(rbDynamicsWorld *world,
112                                 rbRigidBody *object,
113                                 const float loc_start[3],
114                                 const float loc_end[3],
115                                 float v_location[3],
116                                 float v_hitpoint[3],
117                                 float v_normal[3],
118                                 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 /* Simulation ----------------------- */
192
193 /* Get current transform matrix of RigidBody to use in Blender (OpenGL format) */
194 void RB_body_get_transform_matrix(rbRigidBody *body, float m_out[4][4]);
195
196 /* Set RigidBody's location and rotation */
197 void RB_body_set_loc_rot(rbRigidBody *body, const float loc[3], const float rot[4]);
198 /* Set RigidBody's local scaling */
199 void RB_body_set_scale(rbRigidBody *body, const float scale[3]);
200
201 /* ............ */
202
203 /* Get RigidBody's position as vector */
204 void RB_body_get_position(rbRigidBody *body, float v_out[3]);
205 /* Get RigidBody's orientation as quaternion */
206 void RB_body_get_orientation(rbRigidBody *body, float v_out[4]);
207
208 /* ............ */
209
210 void RB_body_apply_central_force(rbRigidBody *body, const float v_in[3]);
211
212 /* ********************************** */
213 /* Collision Shape Methods */
214
215 /* Setup (Standard Shapes) ----------- */
216
217 rbCollisionShape *RB_shape_new_box(float x, float y, float z);
218 rbCollisionShape *RB_shape_new_sphere(float radius);
219 rbCollisionShape *RB_shape_new_capsule(float radius, float height);
220 rbCollisionShape *RB_shape_new_cone(float radius, float height);
221 rbCollisionShape *RB_shape_new_cylinder(float radius, float height);
222
223 /* Setup (Convex Hull) ------------ */
224
225 rbCollisionShape *RB_shape_new_convex_hull(
226     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(
234     rbMeshData *mesh, int num, int index0, int index1, int index2);
235 void RB_trimesh_finish(rbMeshData *mesh);
236 /* 2a - Triangle Meshes */
237 rbCollisionShape *RB_shape_new_trimesh(rbMeshData *mesh);
238 /* 2b - GImpact Meshes */
239 rbCollisionShape *RB_shape_new_gimpact_mesh(rbMeshData *mesh);
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,
252                              float *vertices,
253                              int num_verts,
254                              int vert_stride,
255                              float min[3],
256                              float max[3]);
257
258 /* ********************************** */
259 /* Constraints */
260
261 /* Setup ----------------------------- */
262
263 /* Add Rigid Body Constraint to simulation world */
264 void RB_dworld_add_constraint(rbDynamicsWorld *world, rbConstraint *con, int disable_collisions);
265
266 /* Remove Rigid Body Constraint from simulation world */
267 void RB_dworld_remove_constraint(rbDynamicsWorld *world, rbConstraint *con);
268
269 rbConstraint *RB_constraint_new_point(float pivot[3], rbRigidBody *rb1, rbRigidBody *rb2);
270 rbConstraint *RB_constraint_new_fixed(float pivot[3],
271                                       float orn[4],
272                                       rbRigidBody *rb1,
273                                       rbRigidBody *rb2);
274 rbConstraint *RB_constraint_new_hinge(float pivot[3],
275                                       float orn[4],
276                                       rbRigidBody *rb1,
277                                       rbRigidBody *rb2);
278 rbConstraint *RB_constraint_new_slider(float pivot[3],
279                                        float orn[4],
280                                        rbRigidBody *rb1,
281                                        rbRigidBody *rb2);
282 rbConstraint *RB_constraint_new_piston(float pivot[3],
283                                        float orn[4],
284                                        rbRigidBody *rb1,
285                                        rbRigidBody *rb2);
286 rbConstraint *RB_constraint_new_6dof(float pivot[3],
287                                      float orn[4],
288                                      rbRigidBody *rb1,
289                                      rbRigidBody *rb2);
290 rbConstraint *RB_constraint_new_6dof_spring(float pivot[3],
291                                             float orn[4],
292                                             rbRigidBody *rb1,
293                                             rbRigidBody *rb2);
294 rbConstraint *RB_constraint_new_6dof_spring2(float pivot[3],
295                                              float orn[4],
296                                              rbRigidBody *rb1,
297                                              rbRigidBody *rb2);
298 rbConstraint *RB_constraint_new_motor(float pivot[3],
299                                       float orn[4],
300                                       rbRigidBody *rb1,
301                                       rbRigidBody *rb2);
302
303 /* ............ */
304
305 /* Cleanup --------------------------- */
306
307 void RB_constraint_delete(rbConstraint *con);
308
309 /* Settings --------------------------- */
310
311 /* Enable or disable constraint */
312 void RB_constraint_set_enabled(rbConstraint *con, int enabled);
313
314 /* Limits */
315 #define RB_LIMIT_LIN_X 0
316 #define RB_LIMIT_LIN_Y 1
317 #define RB_LIMIT_LIN_Z 2
318 #define RB_LIMIT_ANG_X 3
319 #define RB_LIMIT_ANG_Y 4
320 #define RB_LIMIT_ANG_Z 5
321 /* Bullet uses the following convention:
322  * - lower limit == upper limit -> axis is locked
323  * - lower limit > upper limit -> axis is free
324  * - lower limit < upper limit -> axis is limited in given range
325  */
326 void RB_constraint_set_limits_hinge(rbConstraint *con, float lower, float upper);
327 void RB_constraint_set_limits_slider(rbConstraint *con, float lower, float upper);
328 void RB_constraint_set_limits_piston(
329     rbConstraint *con, float lin_lower, float lin_upper, float ang_lower, float ang_upper);
330 void RB_constraint_set_limits_6dof(rbConstraint *con, int axis, float lower, float upper);
331
332 /* 6dof spring specific */
333 void RB_constraint_set_stiffness_6dof_spring(rbConstraint *con, int axis, float stiffness);
334 void RB_constraint_set_damping_6dof_spring(rbConstraint *con, int axis, float damping);
335 void RB_constraint_set_spring_6dof_spring(rbConstraint *con, int axis, int enable);
336 void RB_constraint_set_equilibrium_6dof_spring(rbConstraint *con);
337
338 /* 6dof spring 2 specific */
339 void RB_constraint_set_limits_6dof_spring2(rbConstraint *con, int axis, float lower, float upper);
340 void RB_constraint_set_stiffness_6dof_spring2(rbConstraint *con, int axis, float stiffness);
341 void RB_constraint_set_damping_6dof_spring2(rbConstraint *con, int axis, float damping);
342 void RB_constraint_set_spring_6dof_spring2(rbConstraint *con, int axis, int enable);
343 void RB_constraint_set_equilibrium_6dof_spring2(rbConstraint *con);
344
345 /* motors */
346 void RB_constraint_set_enable_motor(rbConstraint *con, int enable_lin, int enable_ang);
347 void RB_constraint_set_max_impulse_motor(rbConstraint *con,
348                                          float max_impulse_lin,
349                                          float max_impulse_ang);
350 void RB_constraint_set_target_velocity_motor(rbConstraint *con,
351                                              float velocity_lin,
352                                              float velocity_ang);
353
354 /* Set number of constraint solver iterations made per step, this overrided world setting
355  * To use default set it to -1 */
356 void RB_constraint_set_solver_iterations(rbConstraint *con, int num_solver_iterations);
357
358 /* Set breaking impulse threshold, if constraint shouldn't break it can be set to FLT_MAX */
359 void RB_constraint_set_breaking_threshold(rbConstraint *con, float threshold);
360
361 /* ********************************** */
362
363 #ifdef __cplusplus
364 }
365 #endif
366
367 #endif /* __RB_API_H__ */