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 extern rbDynamicsWorld *RB_dworld_new(const float gravity[3]);
  77
  78 /* Delete the given dynamics world, and free any extra data it may require */
  79 extern void RB_dworld_delete(rbDynamicsWorld *world);
  80
  81 /* Settings ------------------------- */
  82
  83 /* Gravity */
  84 extern void RB_dworld_get_gravity(rbDynamicsWorld *world, float g_out[3]);
  85 extern void RB_dworld_set_gravity(rbDynamicsWorld *world, const float g_in[3]);
  86
  87 /* Constraint Solver */
  88 extern void RB_dworld_set_solver_iterations(rbDynamicsWorld *world, int num_solver_iterations);
  89 /* Split Impulse */
  90 extern 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 extern 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 extern void RB_dworld_add_body(rbDynamicsWorld *world, rbRigidBody *body, int col_groups);
 109
 110 /* Remove RigidBody from dynamics world */
 111 extern void RB_dworld_remove_body(rbDynamicsWorld *world, rbRigidBody *body);
 112
 113 /* Collision detection */
 114
 115 void RB_world_convex_sweep_test(rbDynamicsWorld *world, rbRigidBody *object,
 116                                                                 const float loc_start[3], const float loc_end[3],
 117                                     float v_location[3],  float v_hitpoint[3],  float v_normal[3], int *r_hit);
 118
 119 /* ............ */
 120
 121 /* Create new RigidBody instance */
 122 extern rbRigidBody *RB_body_new(rbCollisionShape *shape, const float loc[3], const float rot[4]);
 123
 124 /* Delete the given RigidBody instance */
 125 extern void RB_body_delete(rbRigidBody *body);
 126
 127 /* Settings ------------------------- */
 128
 129 /* 'Type' */
 130 extern void RB_body_set_type(rbRigidBody *body, int type, float mass);
 131
 132 /* ............ */
 133
 134 /* Collision Shape */
 135 extern void RB_body_set_collision_shape(rbRigidBody *body, rbCollisionShape *shape);
 136
 137 /* ............ */
 138
 139 /* Mass */
 140 extern float RB_body_get_mass(rbRigidBody *body);
 141 extern void RB_body_set_mass(rbRigidBody *body, float value);
 142
 143 /* Friction */
 144 extern float RB_body_get_friction(rbRigidBody *body);
 145 extern void RB_body_set_friction(rbRigidBody *body, float value);
 146
 147 /* Restitution */
 148 extern float RB_body_get_restitution(rbRigidBody *body);
 149 extern void RB_body_set_restitution(rbRigidBody *body, float value);
 150
 151 /* Damping */
 152 extern float RB_body_get_linear_damping(rbRigidBody *body);
 153 extern void RB_body_set_linear_damping(rbRigidBody *body, float value);
 154
 155 extern float RB_body_get_angular_damping(rbRigidBody *body);
 156 extern void RB_body_set_angular_damping(rbRigidBody *body, float value);
 157
 158 extern void RB_body_set_damping(rbRigidBody *object, float linear, float angular);
 159
 160 /* Sleeping Thresholds */
 161 extern float RB_body_get_linear_sleep_thresh(rbRigidBody *body);
 162 extern void RB_body_set_linear_sleep_thresh(rbRigidBody *body, float value);
 163
 164 extern float RB_body_get_angular_sleep_thresh(rbRigidBody *body);
 165 extern void RB_body_set_angular_sleep_thresh(rbRigidBody *body, float value);
 166
 167 extern void RB_body_set_sleep_thresh(rbRigidBody *body, float linear, float angular);
 168
 169 /* Linear Velocity */
 170 extern void RB_body_get_linear_velocity(rbRigidBody *body, float v_out[3]);
 171 extern void RB_body_set_linear_velocity(rbRigidBody *body, const float v_in[3]);
 172
 173 /* Angular Velocity */
 174 extern void RB_body_get_angular_velocity(rbRigidBody *body, float v_out[3]);
 175 extern void RB_body_set_angular_velocity(rbRigidBody *body, const float v_in[3]);
 176
 177 /* Linear/Angular Factor, used to lock translation/roation axes */
 178 extern void RB_body_set_linear_factor(rbRigidBody *object, float x, float y, float z);
 179 extern void RB_body_set_angular_factor(rbRigidBody *object, float x, float y, float z);
 180
 181 /* Kinematic State */
 182 extern void RB_body_set_kinematic_state(rbRigidBody *body, int kinematic);
 183
 184 /* RigidBody Interface - Rigid Body Activation States */
 185 extern int RB_body_get_activation_state(rbRigidBody *body);
 186 extern void RB_body_set_activation_state(rbRigidBody *body, int use_deactivation);
 187 extern void RB_body_activate(rbRigidBody *body);
 188 extern void RB_body_deactivate(rbRigidBody *body);
 189
 190
 191 /* Simulation ----------------------- */
 192
 193 /* Get current transform matrix of RigidBody to use in Blender (OpenGL format) */
 194 extern void RB_body_get_transform_matrix(rbRigidBody *body, float m_out[4][4]);
 195
 196 /* Set RigidBody's location and rotation */
 197 extern void RB_body_set_loc_rot(rbRigidBody *body, const float loc[3], const float rot[4]);
 198 /* Set RigidBody's local scaling */
 199 extern 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 extern 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 extern rbCollisionShape *RB_shape_new_box(float x, float y, float z);
 218 extern rbCollisionShape *RB_shape_new_sphere(float radius);
 219 extern rbCollisionShape *RB_shape_new_capsule(float radius, float height);
 220 extern rbCollisionShape *RB_shape_new_cone(float radius, float height);
 221 extern rbCollisionShape *RB_shape_new_cylinder(float radius, float height);
 222
 223 /* Setup (Convex Hull) ------------ */
 224
 225 extern rbCollisionShape *RB_shape_new_convex_hull(float *verts, int stride, int count, float margin, bool *can_embed);
 226
 227 /* Setup (Triangle Mesh) ---------- */
 228
 229 /* 1 */
 230 extern rbMeshData *RB_trimesh_data_new(int num_tris, int num_verts);
 231 extern void RB_trimesh_add_vertices(rbMeshData *mesh, float *vertices, int num_verts, int vert_stride);
 232 extern void RB_trimesh_add_triangle_indices(rbMeshData *mesh, int num, int index0, int index1, int index2);
 233 extern void RB_trimesh_finish(rbMeshData *mesh);
 234 /* 2a - Triangle Meshes */
 235 extern rbCollisionShape *RB_shape_new_trimesh(rbMeshData *mesh);
 236 /* 2b - GImpact Meshes */
 237 extern rbCollisionShape *RB_shape_new_gimpact_mesh(rbMeshData *mesh);
 238
 239
 240 /* Cleanup --------------------------- */
 241
 242 extern void RB_shape_delete(rbCollisionShape *shape);
 243
 244 /* Settings --------------------------- */
 245
 246 /* Collision Margin */
 247 extern float RB_shape_get_margin(rbCollisionShape *shape);
 248 extern void RB_shape_set_margin(rbCollisionShape *shape, float value);
 249
 250 extern void RB_shape_trimesh_update(rbCollisionShape *shape, float *vertices, int num_verts, int vert_stride, float min[3], float max[3]);
 251
 252 /* ********************************** */
 253 /* Constraints */
 254
 255 /* Setup ----------------------------- */
 256
 257 /* Add Rigid Body Constraint to simulation world */
 258 extern void RB_dworld_add_constraint(rbDynamicsWorld *world, rbConstraint *con, int disable_collisions);
 259
 260 /* Remove Rigid Body Constraint from simulation world */
 261 extern void RB_dworld_remove_constraint(rbDynamicsWorld *world, rbConstraint *con);
 262
 263 extern rbConstraint *RB_constraint_new_point(float pivot[3], rbRigidBody *rb1, rbRigidBody *rb2);
 264 extern rbConstraint *RB_constraint_new_fixed(float pivot[3], float orn[4], rbRigidBody *rb1, rbRigidBody *rb2);
 265 extern rbConstraint *RB_constraint_new_hinge(float pivot[3], float orn[4], rbRigidBody *rb1, rbRigidBody *rb2);
 266 extern rbConstraint *RB_constraint_new_slider(float pivot[3], float orn[4], rbRigidBody *rb1, rbRigidBody *rb2);
 267 extern rbConstraint *RB_constraint_new_piston(float pivot[3], float orn[4], rbRigidBody *rb1, rbRigidBody *rb2);
 268 extern rbConstraint *RB_constraint_new_6dof(float pivot[3], float orn[4], rbRigidBody *rb1, rbRigidBody *rb2);
 269 extern rbConstraint *RB_constraint_new_6dof_spring(float pivot[3], float orn[4], rbRigidBody *rb1, rbRigidBody *rb2);
 270 extern rbConstraint *RB_constraint_new_motor(float pivot[3], float orn[4], rbRigidBody *rb1, rbRigidBody *rb2);
 271
 272 /* ............ */
 273
 274 /* Cleanup --------------------------- */
 275
 276 extern void RB_constraint_delete(rbConstraint *con);
 277
 278 /* Settings --------------------------- */
 279
 280 /* Enable or disable constraint */
 281 extern void RB_constraint_set_enabled(rbConstraint *con, int enabled);
 282
 283 /* Limits */
 284 #define RB_LIMIT_LIN_X 0
 285 #define RB_LIMIT_LIN_Y 1
 286 #define RB_LIMIT_LIN_Z 2
 287 #define RB_LIMIT_ANG_X 3
 288 #define RB_LIMIT_ANG_Y 4
 289 #define RB_LIMIT_ANG_Z 5
 290 /* Bullet uses the following convention:
 291  * - lower limit == upper limit -> axis is locked
 292  * - lower limit > upper limit -> axis is free
 293  * - lower limit < upper limit -> axis is limited in given range
 294  */
 295 extern void RB_constraint_set_limits_hinge(rbConstraint *con, float lower, float upper);
 296 extern void RB_constraint_set_limits_slider(rbConstraint *con, float lower, float upper);
 297 extern void RB_constraint_set_limits_piston(rbConstraint *con, float lin_lower, float lin_upper, float ang_lower, float ang_upper);
 298 extern void RB_constraint_set_limits_6dof(rbConstraint *con, int axis, float lower, float upper);
 299
 300 /* 6dof spring specific */
 301 extern void RB_constraint_set_stiffness_6dof_spring(rbConstraint *con, int axis, float stiffness);
 302 extern void RB_constraint_set_damping_6dof_spring(rbConstraint *con, int axis, float damping);
 303 extern void RB_constraint_set_spring_6dof_spring(rbConstraint *con, int axis, int enable);
 304 extern void RB_constraint_set_equilibrium_6dof_spring(rbConstraint *con);
 305
 306 /* motors */
 307 extern void RB_constraint_set_enable_motor(rbConstraint *con, int enable_lin, int enable_ang);
 308 extern void RB_constraint_set_max_impulse_motor(rbConstraint *con, float max_impulse_lin, float max_impulse_ang);
 309 extern 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 extern 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 extern 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