Depsgraph: Add utility function for transform dependency
[blender.git] / source / blender / depsgraph / DEG_depsgraph_build.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 depsgraph
21  *
22  * Public API for Depsgraph
23  */
24
25 #ifndef __DEG_DEPSGRAPH_BUILD_H__
26 #define __DEG_DEPSGRAPH_BUILD_H__
27
28 /* ************************************************* */
29
30 /* Dependency Graph */
31 struct Depsgraph;
32
33 /* ------------------------------------------------ */
34
35 struct CacheFile;
36 struct Collection;
37 struct EffectorWeights;
38 struct ID;
39 struct Main;
40 struct ModifierData;
41 struct Object;
42 struct Scene;
43 struct ViewLayer;
44
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48
49 #include "BLI_sys_types.h"
50
51 /* Graph Building -------------------------------- */
52
53 /* Build depsgraph for the given scene, and dump results in given
54  * graph container.
55  */
56 void DEG_graph_build_from_view_layer(struct Depsgraph *graph,
57                                       struct Main *bmain,
58                                       struct Scene *scene,
59                                       struct ViewLayer *view_layer);
60
61 /* Tag relations from the given graph for update. */
62 void DEG_graph_tag_relations_update(struct Depsgraph *graph);
63
64 /* Create or update relations in the specified graph. */
65 void DEG_graph_relations_update(struct Depsgraph *graph,
66                                 struct Main *bmain,
67                                 struct Scene *scene,
68                                 struct ViewLayer *view_layer);
69
70 /* Tag all relations in the database for update.*/
71 void DEG_relations_tag_update(struct Main *bmain);
72
73 /* Add Dependencies  ----------------------------- */
74
75 /* Handle for components to define their dependencies from callbacks.
76  * This is generated by the depsgraph and passed to dependency callbacks
77  * as a symbolic reference to the current DepsNode.
78  * All relations will be defined in reference to that node.
79  */
80 struct DepsNodeHandle;
81
82 typedef enum eDepsSceneComponentType {
83         /* Parameters Component - Default when nothing else fits
84          * (i.e. just SDNA property setting). */
85         DEG_SCENE_COMP_PARAMETERS,
86         /* Animation Component
87          * TODO(sergey): merge in with parameters?  */
88         DEG_SCENE_COMP_ANIMATION,
89         /* Sequencer Component (Scene Only). */
90         DEG_SCENE_COMP_SEQUENCER,
91 } eDepsSceneComponentType;
92
93 typedef enum eDepsObjectComponentType {
94         /* Parameters Component - Default when nothing else fits
95          * (i.e. just SDNA property setting). */
96         DEG_OB_COMP_PARAMETERS,
97         /* Generic "Proxy-Inherit" Component.
98          * TODO(sergey): Also for instancing of subgraphs? */
99         DEG_OB_COMP_PROXY,
100         /* Animation Component.
101          *
102          * TODO(sergey): merge in with parameters? */
103         DEG_OB_COMP_ANIMATION,
104         /* Transform Component (Parenting/Constraints) */
105         DEG_OB_COMP_TRANSFORM,
106         /* Geometry Component (Mesh/Displist) */
107         DEG_OB_COMP_GEOMETRY,
108
109         /* Evaluation-Related Outer Types (with Subdata) */
110
111         /* Pose Component - Owner/Container of Bones Eval */
112         DEG_OB_COMP_EVAL_POSE,
113         /* Bone Component - Child/Subcomponent of Pose */
114         DEG_OB_COMP_BONE,
115
116         /* Material Shading Component */
117         DEG_OB_COMP_SHADING,
118         /* Cache Component */
119         DEG_OB_COMP_CACHE,
120 } eDepsObjectComponentType;
121
122 void DEG_add_scene_relation(struct DepsNodeHandle *node_handle,
123                             struct Scene *scene,
124                             eDepsSceneComponentType component,
125                             const char *description);
126 void DEG_add_object_relation(struct DepsNodeHandle *node_handle,
127                              struct Object *object,
128                              eDepsObjectComponentType component,
129                              const char *description);
130 void DEG_add_bone_relation(struct DepsNodeHandle *handle,
131                            struct Object *object,
132                            const char *bone_name,
133                            eDepsObjectComponentType component,
134                            const char *description);
135 void DEG_add_object_cache_relation(struct DepsNodeHandle *handle,
136                                    struct CacheFile *cache_file,
137                                    eDepsObjectComponentType component,
138                                    const char *description);
139 /* Adds relation from DEG_OPCODE_GENERIC_DATABLOCK_UPDATE of a given ID.
140  * Is used for such entities as textures and images. */
141 void DEG_add_generic_id_relation(struct DepsNodeHandle *node_handle,
142                                  struct ID *id,
143                                  const char *description);
144
145 /* Special function which is used from modifiers' updateDepsgraph() callback
146  * to indicate that the modifietr needs to know transformation of the object
147  * which that modifier belongs to.
148  * This function will take care of checking which operation is required to
149  * have transformation for the modifier, taking into account possible simulation
150  * solvers. */
151 void DEG_add_modifier_to_transform_relation(
152         struct DepsNodeHandle *node_handle,
153         const char *description);
154
155 /* Adds relations from the given component of a given object to the given node
156  * handle AND the component to the point cache component of the node's ID. */
157 void DEG_add_object_pointcache_relation(struct DepsNodeHandle *node_handle,
158                                         struct Object *object,
159                                         eDepsObjectComponentType component,
160                                         const char *description);
161
162 void DEG_add_special_eval_flag(struct DepsNodeHandle *handle, struct ID *id, uint32_t flag);
163 void DEG_add_customdata_mask(struct DepsNodeHandle *handle, struct Object *object, uint64_t mask);
164
165 struct ID *DEG_get_id_from_handle(struct DepsNodeHandle *node_handle);
166 struct Depsgraph *DEG_get_graph_from_handle(struct DepsNodeHandle *node_handle);
167
168 /* ************************************************ */
169
170 #ifdef __cplusplus
171 } /* extern "C" */
172 #endif
173
174 #endif  /* __DEG_DEPSGRAPH_BUILD_H__ */