Depsgraph: Add evaluation callbacks for granular nodes update
[blender-staging.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 Scene;
41 struct Object;
42
43 /* -------------- */
44 /* Memory Management */
45
46 void BKE_rigidbody_free_world(struct RigidBodyWorld *rbw);
47 void BKE_rigidbody_free_object(struct Object *ob);
48 void BKE_rigidbody_free_constraint(struct Object *ob);
49
50 /* ...... */
51
52 struct RigidBodyOb *BKE_rigidbody_copy_object(struct Object *ob);
53 struct RigidBodyCon *BKE_rigidbody_copy_constraint(struct Object *ob);
54 void BKE_rigidbody_relink_constraint(struct RigidBodyCon *rbc);
55
56 /* -------------- */
57 /* Setup */
58
59 /* create Blender-side settings data - physics objects not initialized yet */
60 struct RigidBodyWorld *BKE_rigidbody_create_world(struct Scene *scene);
61 struct RigidBodyOb *BKE_rigidbody_create_object(struct Scene *scene, struct Object *ob, short type);
62 struct RigidBodyCon *BKE_rigidbody_create_constraint(struct Scene *scene, struct Object *ob, short type);
63
64 /* copy */
65 struct RigidBodyWorld *BKE_rigidbody_world_copy(struct RigidBodyWorld *rbw);
66 void BKE_rigidbody_world_groups_relink(struct RigidBodyWorld *rbw);
67
68 /* 'validate' (i.e. make new or replace old) Physics-Engine objects */
69 void BKE_rigidbody_validate_sim_world(struct Scene *scene, struct RigidBodyWorld *rbw, bool rebuild);
70
71 void BKE_rigidbody_calc_volume(struct Object *ob, float *r_vol);
72 void BKE_rigidbody_calc_center_of_mass(struct Object *ob, float r_com[3]);
73
74 /* -------------- */
75 /* Utilities */
76
77 struct RigidBodyWorld *BKE_rigidbody_get_world(struct Scene *scene);
78 void BKE_rigidbody_remove_object(struct Scene *scene, struct Object *ob);
79 void BKE_rigidbody_remove_constraint(struct Scene *scene, struct Object *ob);
80
81 /* -------------- */
82 /* Utility Macros */
83
84 /* get mass of Rigid Body Object to supply to RigidBody simulators */
85 #define RBO_GET_MASS(rbo) \
86         ((rbo && ((rbo->type == RBO_TYPE_PASSIVE) || (rbo->flag & RBO_FLAG_KINEMATIC) || (rbo->flag & RBO_FLAG_DISABLED))) ? (0.0f) : (rbo->mass))
87 /* get collision margin for Rigid Body Object, triangle mesh and cone shapes cannot embed margin, convex hull always uses custom margin */
88 #define RBO_GET_MARGIN(rbo) \
89         ((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))
90
91 /* -------------- */
92 /* Simulation */
93
94 void BKE_rigidbody_aftertrans_update(struct Object *ob, float loc[3], float rot[3], float quat[4], float rotAxis[3], float rotAngle);
95 void BKE_rigidbody_sync_transforms(struct RigidBodyWorld *rbw, struct Object *ob, float ctime);
96 bool BKE_rigidbody_check_sim_running(struct RigidBodyWorld *rbw, float ctime);
97 void BKE_rigidbody_cache_reset(struct RigidBodyWorld *rbw);
98 void BKE_rigidbody_rebuild_world(struct Scene *scene, float ctime);
99 void BKE_rigidbody_do_simulation(struct Scene *scene, float ctime);
100
101 /* -------------------- */
102 /* Depsgraph evaluation */
103
104 struct EvaluationContext;
105
106 void BKE_rigidbody_rebuild_sim(struct EvaluationContext *eval_ctx,
107                                struct Scene *scene);
108
109 void BKE_rigidbody_eval_simulation(struct EvaluationContext *eval_ctx,
110                                    struct Scene *scene);
111
112 void BKE_rigidbody_object_sync_transforms(struct EvaluationContext *eval_ctx,
113                                           struct Scene *scene,
114                                           struct Object *ob);
115
116 #endif /* __BKE_RIGIDBODY_H__ */