doxygen: add newline after \file
[blender.git] / source / blender / blenkernel / BKE_rigidbody.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 blenkernel
22  * \brief API for Blender-side Rigid Body stuff
23  */
24
25
26 #ifndef __BKE_RIGIDBODY_H__
27 #define __BKE_RIGIDBODY_H__
28
29 struct RigidBodyOb;
30 struct RigidBodyWorld;
31
32 struct Collection;
33 struct Depsgraph;
34 struct Main;
35 struct Object;
36 struct Scene;
37
38 /* -------------- */
39 /* Memory Management */
40
41 void BKE_rigidbody_free_world(struct Scene *scene);
42 void BKE_rigidbody_free_object(struct Object *ob, struct RigidBodyWorld *rbw);
43 void BKE_rigidbody_free_constraint(struct Object *ob);
44
45 /* ...... */
46
47 struct RigidBodyOb *BKE_rigidbody_copy_object(const struct Object *ob, const int flag);
48 struct RigidBodyCon *BKE_rigidbody_copy_constraint(const struct Object *ob, const int flag);
49
50 /* Callback format for performing operations on ID-pointers for rigidbody world. */
51 typedef void (*RigidbodyWorldIDFunc)(struct RigidBodyWorld *rbw, struct ID **idpoin, void *userdata, int cb_flag);
52
53 void BKE_rigidbody_world_id_loop(struct RigidBodyWorld *rbw, RigidbodyWorldIDFunc func, void *userdata);
54
55 /* -------------- */
56 /* Setup */
57
58 /* create Blender-side settings data - physics objects not initialized yet */
59 struct RigidBodyWorld *BKE_rigidbody_create_world(struct Scene *scene);
60 struct RigidBodyOb *BKE_rigidbody_create_object(struct Scene *scene, struct Object *ob, short type);
61 struct RigidBodyCon *BKE_rigidbody_create_constraint(struct Scene *scene, struct Object *ob, short type);
62
63 /* Ensure newly set collections' objects all have required data. */
64 void BKE_rigidbody_objects_collection_validate(struct Scene *scene, struct RigidBodyWorld *rbw);
65 void BKE_rigidbody_constraints_collection_validate(struct Scene *scene, struct RigidBodyWorld *rbw);
66
67 /* Ensure object added to collection gets RB data if that collection is a RB one. */
68 void BKE_rigidbody_main_collection_object_add(struct Main *bmain, struct Collection *collection, struct Object *object);
69
70 /* copy */
71 struct RigidBodyWorld *BKE_rigidbody_world_copy(struct RigidBodyWorld *rbw, const int flag);
72 void BKE_rigidbody_world_groups_relink(struct RigidBodyWorld *rbw);
73
74 /* 'validate' (i.e. make new or replace old) Physics-Engine objects */
75 void BKE_rigidbody_validate_sim_world(struct Scene *scene, struct RigidBodyWorld *rbw, bool rebuild);
76
77 void BKE_rigidbody_calc_volume(struct Object *ob, float *r_vol);
78 void BKE_rigidbody_calc_center_of_mass(struct Object *ob, float r_center[3]);
79
80 /* -------------- */
81 /* Utilities */
82
83 struct RigidBodyWorld *BKE_rigidbody_get_world(struct Scene *scene);
84 void BKE_rigidbody_remove_object(struct Main *bmain, struct Scene *scene, struct Object *ob);
85 void BKE_rigidbody_remove_constraint(struct Scene *scene, struct Object *ob);
86
87 /* -------------- */
88 /* Utility Macros */
89
90 /* get mass of Rigid Body Object to supply to RigidBody simulators */
91 #define RBO_GET_MASS(rbo) \
92         ((rbo && ((rbo->type == RBO_TYPE_PASSIVE) || (rbo->flag & RBO_FLAG_KINEMATIC) || (rbo->flag & RBO_FLAG_DISABLED))) ? (0.0f) : (rbo->mass))
93 /* get collision margin for Rigid Body Object, triangle mesh and cone shapes cannot embed margin, convex hull always uses custom margin */
94 #define RBO_GET_MARGIN(rbo) \
95         ((rbo->flag & RBO_FLAG_USE_MARGIN || rbo->shape == RB_SHAPE_CONVEXH || rbo->shape == RB_SHAPE_TRIMESH || rbo->shape == RB_SHAPE_CONE) ? (rbo->margin) : (0.04f))
96
97 /* -------------- */
98 /* Simulation */
99
100 void BKE_rigidbody_aftertrans_update(struct Object *ob, float loc[3], float rot[3], float quat[4], float rotAxis[3], float rotAngle);
101 void BKE_rigidbody_sync_transforms(struct RigidBodyWorld *rbw, struct Object *ob, float ctime);
102 bool BKE_rigidbody_check_sim_running(struct RigidBodyWorld *rbw, float ctime);
103 void BKE_rigidbody_cache_reset(struct RigidBodyWorld *rbw);
104 void BKE_rigidbody_rebuild_world(struct Depsgraph *depsgraph, struct Scene *scene, float ctime);
105 void BKE_rigidbody_do_simulation(struct Depsgraph *depsgraph, struct Scene *scene, float ctime);
106
107 /* -------------------- */
108 /* Depsgraph evaluation */
109
110 void BKE_rigidbody_rebuild_sim(struct Depsgraph *depsgraph,
111                                struct Scene *scene);
112
113 void BKE_rigidbody_eval_simulation(struct Depsgraph *depsgraph,
114                                    struct Scene *scene);
115
116 void BKE_rigidbody_object_sync_transforms(struct Depsgraph *depsgraph,
117                                           struct Scene *scene,
118                                           struct Object *ob);
119
120 #endif /* __BKE_RIGIDBODY_H__ */