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