Depsgraph: cleanup, no functional changes
[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
55  * graph container.
56  */
57 void DEG_graph_build_from_scene(struct Depsgraph *graph,
58                                 struct Main *bmain,
59                                 struct Scene *scene);
60
61 /* Tag relations from the given graph for update. */
62 void DEG_graph_tag_relations_update(struct Depsgraph *graph);
63
64 /* Tag all relations in the database for update.*/
65 void DEG_relations_tag_update(struct Main *bmain);
66
67 /* Create new graph if didn't exist yet,
68  * or update relations if graph was tagged for update.
69  */
70 void DEG_scene_relations_update(struct Main *bmain, struct Scene *scene);
71
72 /* Rebuild dependency graph only for a given scene. */
73 void DEG_scene_relations_rebuild(struct Main *bmain,
74                                  struct Scene *scene);
75
76 /* Delete scene graph. */
77 void DEG_scene_graph_free(struct Scene *scene);
78
79 /* Add Dependencies  ----------------------------- */
80
81 /* Handle for components to define their dependencies from callbacks.
82  * This is generated by the depsgraph and passed to dependency callbacks
83  * as a symbolic reference to the current DepsNode.
84  * All relations will be defined in reference to that node.
85  */
86 struct DepsNodeHandle;
87
88 struct CacheFile;
89 struct Object;
90
91 typedef enum eDepsSceneComponentType {
92         /* Parameters Component - Default when nothing else fits
93          * (i.e. just SDNA property setting).
94          */
95         DEG_SCENE_COMP_PARAMETERS,
96         /* Animation Component
97          * TODO(sergey): merge in with parameters?
98          */
99         DEG_SCENE_COMP_ANIMATION,
100         /* Sequencer Component (Scene Only). */
101         DEG_SCENE_COMP_SEQUENCER,
102 } eDepsSceneComponentType;
103
104 typedef enum eDepsObjectComponentType {
105         /* Parameters Component - Default when nothing else fits
106          * (i.e. just SDNA property setting).
107          */
108         DEG_OB_COMP_PARAMETERS,
109         /* Generic "Proxy-Inherit" Component.
110          * TODO(sergey): Also for instancing of subgraphs?
111          */
112         DEG_OB_COMP_PROXY,
113         /* Animation Component.
114          *
115          * TODO(sergey): merge in with parameters?
116          */
117         DEG_OB_COMP_ANIMATION,
118         /* Transform Component (Parenting/Constraints) */
119         DEG_OB_COMP_TRANSFORM,
120         /* Geometry Component (DerivedMesh/Displist) */
121         DEG_OB_COMP_GEOMETRY,
122
123         /* Evaluation-Related Outer Types (with Subdata) */
124
125         /* Pose Component - Owner/Container of Bones Eval */
126         DEG_OB_COMP_EVAL_POSE,
127         /* Bone Component - Child/Subcomponent of Pose */
128         DEG_OB_COMP_BONE,
129
130         /* Particle Systems Component */
131         DEG_OB_COMP_EVAL_PARTICLES,
132         /* Material Shading Component */
133         DEG_OB_COMP_SHADING,
134         /* Cache Component */
135         DEG_OB_COMP_CACHE,
136 } eDepsObjectComponentType;
137
138 void DEG_add_scene_relation(struct DepsNodeHandle *node,
139                             struct Scene *scene,
140                             eDepsSceneComponentType component,
141                             const char *description);
142 void DEG_add_object_relation(struct DepsNodeHandle *node, struct
143                              Object *ob,
144                              eDepsObjectComponentType component,
145                              const char *description);
146 void DEG_add_bone_relation(struct DepsNodeHandle *handle,
147                            struct Object *ob,
148                            const char *bone_name,
149                            eDepsObjectComponentType component,
150                            const char *description);
151 void DEG_add_object_cache_relation(struct DepsNodeHandle *handle,
152                                    struct CacheFile *cache_file,
153                                    eDepsObjectComponentType component,
154                                    const char *description);
155
156 /* TODO(sergey): Remove once all geometry update is granular. */
157 void DEG_add_special_eval_flag(struct Depsgraph *graph, struct ID *id, short flag);
158
159 /* Utility functions for physics modifiers */
160 typedef bool (*DEG_CollobjFilterFunction)(struct Object *obj, struct ModifierData *md);
161
162 void DEG_add_collision_relations(struct DepsNodeHandle *handle,
163                                  struct Scene *scene,
164                                  Object *ob,
165                                  struct Group *group,
166                                  int layer,
167                                  unsigned int modifier_type,
168                                  DEG_CollobjFilterFunction fn,
169                                  bool dupli,
170                                  const char *name);
171 void DEG_add_forcefield_relations(struct DepsNodeHandle *handle,
172                                   struct Scene *scene,
173                                   Object *ob,
174                                   struct EffectorWeights *eff,
175                                   bool add_absorption,
176                                   int skip_forcefield,
177                                   const char *name);
178
179 /* ************************************************ */
180
181 #ifdef __cplusplus
182 } /* extern "C" */
183 #endif
184
185 #endif  /* __DEG_DEPSGRAPH_BUILD_H__ */