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