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