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