Fix T49991: reloading librairies doesn't update node groups.
[blender.git] / source / blender / depsgraph / intern / builder / deg_builder_relations.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: Lukas Toenne
22  * Contributor(s): None Yet
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/depsgraph/intern/builder/deg_builder_relations.h
28  *  \ingroup depsgraph
29  */
30
31 #pragma once
32
33 #include <cstdio>
34
35 #include "intern/depsgraph_types.h"
36
37 #include "DNA_ID.h"
38
39 #include "RNA_access.h"
40 #include "RNA_types.h"
41
42 #include "BLI_utildefines.h"
43 #include "BLI_string.h"
44
45 #include "intern/nodes/deg_node.h"
46 #include "intern/nodes/deg_node_operation.h"
47
48 struct Base;
49 struct bGPdata;
50 struct CacheFile;
51 struct ListBase;
52 struct GHash;
53 struct ID;
54 struct FCurve;
55 struct Group;
56 struct Key;
57 struct Main;
58 struct Mask;
59 struct Material;
60 struct MTex;
61 struct MovieClip;
62 struct bNodeTree;
63 struct Object;
64 struct bPoseChannel;
65 struct bConstraint;
66 struct Scene;
67 struct Tex;
68 struct World;
69 struct EffectorWeights;
70 struct ParticleSystem;
71
72 struct PropertyRNA;
73
74 namespace DEG {
75
76 struct Depsgraph;
77 struct DepsNode;
78 struct DepsNodeHandle;
79 struct RootDepsNode;
80 struct SubgraphDepsNode;
81 struct IDDepsNode;
82 struct TimeSourceDepsNode;
83 struct ComponentDepsNode;
84 struct OperationDepsNode;
85 struct RootPChanMap;
86
87 struct RootKey {
88         RootKey();
89 };
90
91 struct TimeSourceKey
92 {
93         TimeSourceKey();
94         TimeSourceKey(ID *id);
95
96         string identifier() const;
97
98         ID *id;
99 };
100
101 struct ComponentKey
102 {
103         ComponentKey();
104         ComponentKey(ID *id, eDepsNode_Type type, const char *name = "");
105
106         string identifier() const;
107
108         ID *id;
109         eDepsNode_Type type;
110         const char *name;
111 };
112
113 struct OperationKey
114 {
115         OperationKey();
116         OperationKey(ID *id,
117                      eDepsNode_Type component_type,
118                      const char *name,
119                      int name_tag = -1);
120         OperationKey(ID *id,
121                      eDepsNode_Type component_type,
122                      const char *component_name,
123                      const char *name,
124                      int name_tag);
125
126         OperationKey(ID *id,
127                      eDepsNode_Type component_type,
128                      eDepsOperation_Code opcode);
129         OperationKey(ID *id,
130                      eDepsNode_Type component_type,
131                      const char *component_name,
132                      eDepsOperation_Code opcode);
133
134         OperationKey(ID *id,
135                      eDepsNode_Type component_type,
136                      eDepsOperation_Code opcode,
137                      const char *name,
138                      int name_tag = -1);
139         OperationKey(ID *id,
140                      eDepsNode_Type component_type,
141                      const char *component_name,
142                      eDepsOperation_Code opcode,
143                      const char *name,
144                      int name_tag = -1);
145
146         string identifier() const;
147
148         ID *id;
149         eDepsNode_Type component_type;
150         const char *component_name;
151         eDepsOperation_Code opcode;
152         const char *name;
153         int name_tag;
154 };
155
156 struct RNAPathKey
157 {
158         /* NOTE: see depsgraph_build.cpp for implementation */
159         RNAPathKey(ID *id, const char *path);
160
161         RNAPathKey(ID *id, const PointerRNA &ptr, PropertyRNA *prop);
162
163         string identifier() const;
164
165         ID *id;
166         PointerRNA ptr;
167         PropertyRNA *prop;
168 };
169
170 struct DepsgraphRelationBuilder
171 {
172         DepsgraphRelationBuilder(Depsgraph *graph);
173
174         template <typename KeyFrom, typename KeyTo>
175         void add_relation(const KeyFrom& key_from,
176                           const KeyTo& key_to,
177                           eDepsRelation_Type type,
178                           const char *description);
179
180         template <typename KeyTo>
181         void add_relation(const TimeSourceKey& key_from,
182                           const KeyTo& key_to,
183                           eDepsRelation_Type type,
184                           const char *description);
185
186         template <typename KeyType>
187         void add_node_handle_relation(const KeyType& key_from,
188                                       const DepsNodeHandle *handle,
189                                       eDepsRelation_Type type,
190                                       const char *description);
191
192         void build_scene(Main *bmain, Scene *scene);
193         void build_group(Main *bmain, Scene *scene, Object *object, Group *group);
194         void build_object(Main *bmain, Scene *scene, Object *ob);
195         void build_object_parent(Object *ob);
196         void build_constraints(Scene *scene, ID *id,
197                                eDepsNode_Type component_type,
198                                const char *component_subdata,
199                                ListBase *constraints,
200                                RootPChanMap *root_map);
201         void build_animdata(ID *id);
202         void build_driver(ID *id, FCurve *fcurve);
203         void build_world(World *world);
204         void build_rigidbody(Scene *scene);
205         void build_particles(Scene *scene, Object *ob);
206         void build_ik_pose(Object *ob,
207                            bPoseChannel *pchan,
208                            bConstraint *con,
209                            RootPChanMap *root_map);
210         void build_splineik_pose(Object *ob,
211                                  bPoseChannel *pchan,
212                                  bConstraint *con,
213                                  RootPChanMap *root_map);
214         void build_rig(Scene *scene, Object *ob);
215         void build_proxy_rig(Object *ob);
216         void build_shapekeys(ID *obdata, Key *key);
217         void build_obdata_geom(Main *bmain, Scene *scene, Object *ob);
218         void build_camera(Object *ob);
219         void build_lamp(Object *ob);
220         void build_nodetree(ID *owner, bNodeTree *ntree);
221         void build_material(ID *owner, Material *ma);
222         void build_texture(ID *owner, Tex *tex);
223         void build_texture_stack(ID *owner, MTex **texture_stack);
224         void build_compositor(Scene *scene);
225         void build_gpencil(ID *owner, bGPdata *gpd);
226         void build_cachefile(CacheFile *cache_file);
227         void build_mask(Mask *mask);
228         void build_movieclip(MovieClip *clip);
229
230         void add_collision_relations(const OperationKey &key, Scene *scene, Object *ob, Group *group, int layer, bool dupli, const char *name);
231         void add_forcefield_relations(const OperationKey &key, Scene *scene, Object *ob, ParticleSystem *psys, EffectorWeights *eff, bool add_absorption, const char *name);
232
233         template <typename KeyType>
234         OperationDepsNode *find_operation_node(const KeyType &key);
235
236 protected:
237         RootDepsNode *find_node(const RootKey &key) const;
238         TimeSourceDepsNode *find_node(const TimeSourceKey &key) const;
239         ComponentDepsNode *find_node(const ComponentKey &key) const;
240         OperationDepsNode *find_node(const OperationKey &key) const;
241         DepsNode *find_node(const RNAPathKey &key) const;
242         OperationDepsNode *has_node(const OperationKey &key) const;
243
244         void add_time_relation(TimeSourceDepsNode *timesrc,
245                                DepsNode *node_to,
246                                const char *description);
247         void add_operation_relation(OperationDepsNode *node_from,
248                                     OperationDepsNode *node_to,
249                                     eDepsRelation_Type type,
250                                     const char *description);
251
252         template <typename KeyType>
253         DepsNodeHandle create_node_handle(const KeyType& key,
254                                           const char *default_name = "");
255
256         bool needs_animdata_node(ID *id);
257
258 private:
259         Depsgraph *m_graph;
260 };
261
262 struct DepsNodeHandle
263 {
264         DepsNodeHandle(DepsgraphRelationBuilder *builder, OperationDepsNode *node, const char *default_name = "") :
265             builder(builder),
266             node(node),
267             default_name(default_name)
268         {
269                 BLI_assert(node != NULL);
270         }
271
272         DepsgraphRelationBuilder *builder;
273         OperationDepsNode *node;
274         const char *default_name;
275 };
276
277 /* Utilities for Builders ----------------------------------------------------- */
278
279 template <typename KeyType>
280 OperationDepsNode *DepsgraphRelationBuilder::find_operation_node(const KeyType& key)
281 {
282         DepsNode *node = find_node(key);
283         return node != NULL ? node->get_exit_operation() : NULL;
284 }
285
286 template <typename KeyFrom, typename KeyTo>
287 void DepsgraphRelationBuilder::add_relation(const KeyFrom &key_from,
288                                             const KeyTo &key_to,
289                                             eDepsRelation_Type type,
290                                             const char *description)
291 {
292         DepsNode *node_from = find_node(key_from);
293         DepsNode *node_to = find_node(key_to);
294         OperationDepsNode *op_from = node_from ? node_from->get_exit_operation() : NULL;
295         OperationDepsNode *op_to = node_to ? node_to->get_entry_operation() : NULL;
296         if (op_from && op_to) {
297                 add_operation_relation(op_from, op_to, type, description);
298         }
299         else {
300                 if (!op_from) {
301                         /* XXX TODO handle as error or report if needed */
302                         node_from = find_node(key_from);
303                         fprintf(stderr, "add_relation(%d, %s) - Could not find op_from (%s)\n",
304                                 type, description, key_from.identifier().c_str());
305                 }
306                 else {
307                         fprintf(stderr, "add_relation(%d, %s) - Failed, but op_from (%s) was ok\n",
308                                 type, description, key_from.identifier().c_str());
309                 }
310                 if (!op_to) {
311                         /* XXX TODO handle as error or report if needed */
312                         fprintf(stderr, "add_relation(%d, %s) - Could not find op_to (%s)\n",
313                                 type, description, key_to.identifier().c_str());
314                 }
315                 else {
316                         fprintf(stderr, "add_relation(%d, %s) - Failed, but op_to (%s) was ok\n",
317                                 type, description, key_to.identifier().c_str());
318                 }
319         }
320 }
321
322 template <typename KeyTo>
323 void DepsgraphRelationBuilder::add_relation(const TimeSourceKey &key_from,
324                                             const KeyTo &key_to,
325                                             eDepsRelation_Type type,
326                                             const char *description)
327 {
328         (void)type;  /* Ignored in release builds. */
329         BLI_assert(type == DEPSREL_TYPE_TIME);
330         TimeSourceDepsNode *time_from = find_node(key_from);
331         DepsNode *node_to = find_node(key_to);
332         OperationDepsNode *op_to = node_to ? node_to->get_entry_operation() : NULL;
333         if (time_from && op_to) {
334                 add_time_relation(time_from, op_to, description);
335         }
336         else {
337         }
338 }
339
340 template <typename KeyType>
341 void DepsgraphRelationBuilder::add_node_handle_relation(
342         const KeyType &key_from,
343         const DepsNodeHandle *handle,
344         eDepsRelation_Type type,
345         const char *description)
346 {
347         DepsNode *node_from = find_node(key_from);
348         OperationDepsNode *op_from = node_from ? node_from->get_exit_operation() : NULL;
349         OperationDepsNode *op_to = handle->node->get_entry_operation();
350         if (op_from && op_to) {
351                 add_operation_relation(op_from, op_to, type, description);
352         }
353         else {
354                 if (!op_from) {
355                         fprintf(stderr, "add_node_handle_relation(%d, %s) - Could not find op_from (%s)\n",
356                                 type, description, key_from.identifier().c_str());
357                 }
358                 if (!op_to) {
359                         fprintf(stderr, "add_node_handle_relation(%d, %s) - Could not find op_to (%s)\n",
360                                 type, description, key_from.identifier().c_str());
361                 }
362         }
363 }
364
365 template <typename KeyType>
366 DepsNodeHandle DepsgraphRelationBuilder::create_node_handle(
367         const KeyType &key,
368         const char *default_name)
369 {
370         return DepsNodeHandle(this, find_node(key), default_name);
371 }
372
373 }  // namespace DEG