Fix depsgraph to compute more accurate links for collision & force.
[blender.git] / source / blender / depsgraph / DEG_depsgraph_build.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  * Original Author: Joshua Leung
22  * Contributor(s): Lukas Toenne
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/depsgraph/DEG_depsgraph_build.h
28  *  \ingroup depsgraph
29  *
30  * Public API for Depsgraph
31  */
32
33 #ifndef __DEG_DEPSGRAPH_BUILD_H__
34 #define __DEG_DEPSGRAPH_BUILD_H__
35
36 /* ************************************************* */
37
38 /* Dependency Graph */
39 struct Depsgraph;
40
41 /* ------------------------------------------------ */
42
43 struct Main;
44 struct Scene;
45 struct Group;
46 struct EffectorWeights;
47
48 #ifdef __cplusplus
49 extern "C" {
50 #endif
51
52 /* Graph Building -------------------------------- */
53
54 /* Build depsgraph for the given scene, and dump results in given graph container */
55 void DEG_graph_build_from_scene(struct Depsgraph *graph, struct Main *bmain, struct Scene *scene);
56
57 /* Tag relations from the given graph for update. */
58 void DEG_graph_tag_relations_update(struct Depsgraph *graph);
59
60 /* Tag all relations in the database for update.*/
61 void DEG_relations_tag_update(struct Main *bmain);
62
63 /* Create new graph if didn't exist yet,
64  * or update relations if graph was tagged for update.
65  */
66 void DEG_scene_relations_update(struct Main *bmain, struct Scene *scene);
67
68 /* Rebuild dependency graph only for a given scene. */
69 void DEG_scene_relations_rebuild(struct Main *bmain,
70                                  struct Scene *scene);
71
72 /* Delete scene graph. */
73 void DEG_scene_graph_free(struct Scene *scene);
74
75 /* Add Dependencies  ----------------------------- */
76
77 /* Handle for components to define their dependencies from callbacks.
78  * This is generated by the depsgraph and passed to dependency callbacks
79  * as a symbolic reference to the current DepsNode.
80  * All relations will be defined in reference to that node.
81  */
82 struct DepsNodeHandle;
83
84 struct CacheFile;
85 struct Object;
86
87 typedef enum eDepsSceneComponentType {
88         DEG_SCENE_COMP_PARAMETERS,     /* Parameters Component - Default when nothing else fits (i.e. just SDNA property setting) */
89         DEG_SCENE_COMP_ANIMATION,      /* Animation Component */                 // XXX: merge in with parameters?
90         DEG_SCENE_COMP_SEQUENCER,      /* Sequencer Component (Scene Only) */
91 } eDepsSceneComponentType;
92
93 typedef enum eDepsObjectComponentType {
94         DEG_OB_COMP_PARAMETERS,        /* Parameters Component - Default when nothing else fits (i.e. just SDNA property setting) */
95         DEG_OB_COMP_PROXY,             /* Generic "Proxy-Inherit" Component */   // XXX: Also for instancing of subgraphs?
96         DEG_OB_COMP_ANIMATION,         /* Animation Component */                 // XXX: merge in with parameters?
97         DEG_OB_COMP_TRANSFORM,         /* Transform Component (Parenting/Constraints) */
98         DEG_OB_COMP_GEOMETRY,          /* Geometry Component (DerivedMesh/Displist) */
99         
100         /* Evaluation-Related Outer Types (with Subdata) */
101         DEG_OB_COMP_EVAL_POSE,         /* Pose Component - Owner/Container of Bones Eval */
102         DEG_OB_COMP_BONE,              /* Bone Component - Child/Subcomponent of Pose */
103         
104         DEG_OB_COMP_EVAL_PARTICLES,    /* Particle Systems Component */
105         DEG_OB_COMP_SHADING,           /* Material Shading Component */
106         DEG_OB_COMP_CACHE,             /* Cache Component */
107 } eDepsObjectComponentType;
108
109 void DEG_add_scene_relation(struct DepsNodeHandle *node, struct Scene *scene, eDepsSceneComponentType component, const char *description);
110 void DEG_add_object_relation(struct DepsNodeHandle *node, struct Object *ob, eDepsObjectComponentType component, const char *description);
111 void DEG_add_bone_relation(struct DepsNodeHandle *handle, struct Object *ob, const char *bone_name, eDepsObjectComponentType component, const char *description);
112 void DEG_add_object_cache_relation(struct DepsNodeHandle *handle, struct CacheFile *cache_file, eDepsObjectComponentType component, const char *description);
113
114 /* TODO(sergey): Remove once all geometry update is granular. */
115 void DEG_add_special_eval_flag(struct Depsgraph *graph, struct ID *id, short flag);
116
117 /* Utility functions for physics modifiers */
118 typedef bool (*DEG_CollobjFilterFunction)(struct Object *obj, struct ModifierData *md);
119
120 void DEG_add_collision_relations(struct DepsNodeHandle *handle, struct Scene *scene, Object *ob, struct Group *group, int layer, unsigned int modifier_type, DEG_CollobjFilterFunction fn, bool dupli, const char *name);
121 void DEG_add_forcefield_relations(struct DepsNodeHandle *handle, struct Scene *scene, Object *ob, struct EffectorWeights *eff, bool add_absorption, int skip_forcefield, const char *name);
122
123 /* ************************************************ */
124
125 #ifdef __cplusplus
126 } /* extern "C" */
127 #endif
128
129 #endif  /* __DEG_DEPSGRAPH_BUILD_H__ */