Merge branch 'master' into blender2.8
[blender.git] / source / blender / depsgraph / intern / nodes / deg_node_component.cc
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): None Yet
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/depsgraph/intern/nodes/deg_node_component.cc
28  *  \ingroup depsgraph
29  */
30
31 #include "intern/nodes/deg_node_component.h"
32
33 #include <stdio.h>
34 #include <cstring>  /* required for STREQ later on. */
35
36 #include "BLI_utildefines.h"
37 #include "BLI_ghash.h"
38
39 extern "C" {
40 #include "DNA_object_types.h"
41
42 #include "BKE_action.h"
43 } /* extern "C" */
44
45 #include "intern/nodes/deg_node_operation.h"
46 #include "intern/depsgraph_intern.h"
47 #include "util/deg_util_foreach.h"
48
49 namespace DEG {
50
51 /* *********** */
52 /* Outer Nodes */
53
54 /* Standard Component Methods ============================= */
55
56 ComponentDepsNode::OperationIDKey::OperationIDKey()
57         : opcode(DEG_OPCODE_OPERATION),
58           name(""),
59           name_tag(-1)
60 {
61 }
62
63 ComponentDepsNode::OperationIDKey::OperationIDKey(eDepsOperation_Code opcode)
64         : opcode(opcode),
65           name(""),
66           name_tag(-1)
67 {
68 }
69
70 ComponentDepsNode::OperationIDKey::OperationIDKey(eDepsOperation_Code opcode,
71                                                  const char *name,
72                                                  int name_tag)
73         : opcode(opcode),
74           name(name),
75           name_tag(name_tag)
76 {
77 }
78
79 string ComponentDepsNode::OperationIDKey::identifier() const
80 {
81         char codebuf[5];
82         BLI_snprintf(codebuf, sizeof(codebuf), "%d", opcode);
83         return string("OperationIDKey(") + codebuf + ", " + name + ")";
84 }
85
86 bool ComponentDepsNode::OperationIDKey::operator==(
87         const OperationIDKey &other) const
88 {
89         return (opcode == other.opcode) &&
90                 (STREQ(name, other.name)) &&
91                 (name_tag == other.name_tag);
92 }
93
94 static unsigned int comp_node_hash_key(const void *key_v)
95 {
96         const ComponentDepsNode::OperationIDKey *key =
97                 reinterpret_cast<const ComponentDepsNode::OperationIDKey *>(key_v);
98         return BLI_ghashutil_combine_hash(BLI_ghashutil_uinthash(key->opcode),
99                                           BLI_ghashutil_strhash_p(key->name));
100 }
101
102 static bool comp_node_hash_key_cmp(const void *a, const void *b)
103 {
104         const ComponentDepsNode::OperationIDKey *key_a =
105                 reinterpret_cast<const ComponentDepsNode::OperationIDKey *>(a);
106         const ComponentDepsNode::OperationIDKey *key_b =
107                 reinterpret_cast<const ComponentDepsNode::OperationIDKey *>(b);
108         return !(*key_a == *key_b);
109 }
110
111 static void comp_node_hash_key_free(void *key_v)
112 {
113         typedef ComponentDepsNode::OperationIDKey OperationIDKey;
114         OperationIDKey *key = reinterpret_cast<OperationIDKey *>(key_v);
115         OBJECT_GUARDED_DELETE(key, OperationIDKey);
116 }
117
118 static void comp_node_hash_value_free(void *value_v)
119 {
120         OperationDepsNode *op_node = reinterpret_cast<OperationDepsNode *>(value_v);
121         OBJECT_GUARDED_DELETE(op_node, OperationDepsNode);
122 }
123
124 ComponentDepsNode::ComponentDepsNode() :
125     entry_operation(NULL),
126     exit_operation(NULL)
127 {
128         operations_map = BLI_ghash_new(comp_node_hash_key,
129                                        comp_node_hash_key_cmp,
130                                        "Depsgraph id hash");
131 }
132
133 /* Initialize 'component' node - from pointer data given */
134 void ComponentDepsNode::init(const ID * /*id*/,
135                              const char * /*subdata*/)
136 {
137         /* hook up eval context? */
138         // XXX: maybe this needs a special API?
139 }
140
141 /* Free 'component' node */
142 ComponentDepsNode::~ComponentDepsNode()
143 {
144         clear_operations();
145         if (operations_map != NULL) {
146                 BLI_ghash_free(operations_map,
147                                comp_node_hash_key_free,
148                                comp_node_hash_value_free);
149         }
150 }
151
152 string ComponentDepsNode::identifier() const
153 {
154         string idname = this->owner->name;
155
156         char typebuf[16];
157         sprintf(typebuf, "(%d)", type);
158
159         return string(typebuf) + name + " : " + idname;
160 }
161
162 OperationDepsNode *ComponentDepsNode::find_operation(OperationIDKey key) const
163 {
164         OperationDepsNode *node = NULL;
165         if (operations_map != NULL) {
166                 node = (OperationDepsNode *)BLI_ghash_lookup(operations_map, &key);
167         }
168         else {
169                 BLI_assert(key.name_tag == -1);
170                 foreach (OperationDepsNode *op_node, operations) {
171                         if (op_node->opcode == key.opcode &&
172                             STREQ(op_node->name, key.name))
173                         {
174                                 node = op_node;
175                                 break;
176                         }
177                 }
178         }
179         return node;
180 }
181
182 OperationDepsNode *ComponentDepsNode::find_operation(eDepsOperation_Code opcode,
183                                                     const char *name,
184                                                     int name_tag) const
185 {
186         OperationIDKey key(opcode, name, name_tag);
187         return find_operation(key);
188 }
189
190 OperationDepsNode *ComponentDepsNode::get_operation(OperationIDKey key) const
191 {
192         OperationDepsNode *node = find_operation(key);
193         if (node == NULL) {
194                 fprintf(stderr, "%s: find_operation(%s) failed\n",
195                         this->identifier().c_str(), key.identifier().c_str());
196                 BLI_assert(!"Request for non-existing operation, should not happen");
197                 return NULL;
198         }
199         return node;
200 }
201
202 OperationDepsNode *ComponentDepsNode::get_operation(eDepsOperation_Code opcode,
203                                                     const char *name,
204                                                     int name_tag) const
205 {
206         OperationIDKey key(opcode, name, name_tag);
207         return get_operation(key);
208 }
209
210 bool ComponentDepsNode::has_operation(OperationIDKey key) const
211 {
212         return find_operation(key) != NULL;
213 }
214
215 bool ComponentDepsNode::has_operation(eDepsOperation_Code opcode,
216                                       const char *name,
217                                       int name_tag) const
218 {
219         OperationIDKey key(opcode, name, name_tag);
220         return has_operation(key);
221 }
222
223 OperationDepsNode *ComponentDepsNode::add_operation(const DepsEvalOperationCb& op,
224                                                     eDepsOperation_Code opcode,
225                                                     const char *name,
226                                                     int name_tag)
227 {
228         OperationDepsNode *op_node = find_operation(opcode, name, name_tag);
229         if (!op_node) {
230                 DepsNodeFactory *factory = deg_get_node_factory(DEG_NODE_TYPE_OPERATION);
231                 op_node = (OperationDepsNode *)factory->create_node(this->owner->id_orig, "", name);
232
233                 /* register opnode in this component's operation set */
234                 OperationIDKey *key = OBJECT_GUARDED_NEW(OperationIDKey, opcode, name, name_tag);
235                 BLI_ghash_insert(operations_map, key, op_node);
236
237                 /* set backlink */
238                 op_node->owner = this;
239         }
240         else {
241                 fprintf(stderr, "add_operation: Operation already exists - %s has %s at %p\n",
242                         this->identifier().c_str(), op_node->identifier().c_str(), op_node);
243                 BLI_assert(!"Should not happen!");
244         }
245
246         /* attach extra data */
247         op_node->evaluate = op;
248         op_node->opcode = opcode;
249         op_node->name = name;
250
251         return op_node;
252 }
253
254 void ComponentDepsNode::set_entry_operation(OperationDepsNode *op_node)
255 {
256         BLI_assert(entry_operation == NULL);
257         entry_operation = op_node;
258 }
259
260 void ComponentDepsNode::set_exit_operation(OperationDepsNode *op_node)
261 {
262         BLI_assert(exit_operation == NULL);
263         exit_operation = op_node;
264 }
265
266 void ComponentDepsNode::clear_operations()
267 {
268         if (operations_map != NULL) {
269                 BLI_ghash_clear(operations_map,
270                                 comp_node_hash_key_free,
271                                 comp_node_hash_value_free);
272         }
273         foreach (OperationDepsNode *op_node, operations) {
274                 OBJECT_GUARDED_DELETE(op_node, OperationDepsNode);
275         }
276         operations.clear();
277 }
278
279 void ComponentDepsNode::tag_update(Depsgraph *graph)
280 {
281         OperationDepsNode *entry_op = get_entry_operation();
282         if (entry_op != NULL && entry_op->flag & DEPSOP_FLAG_NEEDS_UPDATE) {
283                 return;
284         }
285         foreach (OperationDepsNode *op_node, operations) {
286                 op_node->tag_update(graph);
287         }
288         // It is possible that tag happens before finalization.
289         if (operations_map != NULL) {
290                 GHASH_FOREACH_BEGIN(OperationDepsNode *, op_node, operations_map)
291                 {
292                         op_node->tag_update(graph);
293                 }
294                 GHASH_FOREACH_END();
295         }
296 }
297
298 OperationDepsNode *ComponentDepsNode::get_entry_operation()
299 {
300         if (entry_operation) {
301                 return entry_operation;
302         }
303         else if (operations_map != NULL && BLI_ghash_size(operations_map) == 1) {
304                 OperationDepsNode *op_node = NULL;
305                 /* TODO(sergey): This is somewhat slow. */
306                 GHASH_FOREACH_BEGIN(OperationDepsNode *, tmp, operations_map)
307                 {
308                         op_node = tmp;
309                 }
310                 GHASH_FOREACH_END();
311                 /* Cache for the subsequent usage. */
312                 entry_operation = op_node;
313                 return op_node;
314         }
315         else if (operations.size() == 1) {
316                 return operations[0];
317         }
318         return NULL;
319 }
320
321 OperationDepsNode *ComponentDepsNode::get_exit_operation()
322 {
323         if (exit_operation) {
324                 return exit_operation;
325         }
326         else if (operations_map != NULL && BLI_ghash_size(operations_map) == 1) {
327                 OperationDepsNode *op_node = NULL;
328                 /* TODO(sergey): This is somewhat slow. */
329                 GHASH_FOREACH_BEGIN(OperationDepsNode *, tmp, operations_map)
330                 {
331                         op_node = tmp;
332                 }
333                 GHASH_FOREACH_END();
334                 /* Cache for the subsequent usage. */
335                 exit_operation = op_node;
336                 return op_node;
337         }
338         else if (operations.size() == 1) {
339                 return operations[0];
340         }
341         return NULL;
342 }
343
344 void ComponentDepsNode::finalize_build(Depsgraph * /*graph*/)
345 {
346         operations.reserve(BLI_ghash_size(operations_map));
347         GHASH_FOREACH_BEGIN(OperationDepsNode *, op_node, operations_map)
348         {
349                 operations.push_back(op_node);
350         }
351         GHASH_FOREACH_END();
352         BLI_ghash_free(operations_map,
353                        comp_node_hash_key_free,
354                        NULL);
355         operations_map = NULL;
356 }
357
358 /* Register all components. =============================== */
359
360 #define DEG_COMPONENT_DEFINE(name, NAME)                             \
361   DEG_DEPSNODE_DEFINE(name ## ComponentDepsNode,                     \
362                       DEG_NODE_TYPE_ ## NAME,                        \
363                       #name  " Component");                          \
364 static DepsNodeFactoryImpl<name ## ComponentDepsNode> DNTI_ ## NAME
365
366
367 DEG_COMPONENT_DEFINE(Animation, ANIMATION);
368 DEG_COMPONENT_DEFINE(BatchCache, BATCH_CACHE);
369 DEG_COMPONENT_DEFINE(Cache, CACHE);
370 DEG_COMPONENT_DEFINE(CopyOnWrite, COPY_ON_WRITE);
371 DEG_COMPONENT_DEFINE(Geometry, GEOMETRY);
372 DEG_COMPONENT_DEFINE(LayerCollections, LAYER_COLLECTIONS);
373 DEG_COMPONENT_DEFINE(Parameters, PARAMETERS);
374 DEG_COMPONENT_DEFINE(Particles, EVAL_PARTICLES);
375 DEG_COMPONENT_DEFINE(Proxy, PROXY);
376 DEG_COMPONENT_DEFINE(Pose, EVAL_POSE);
377 DEG_COMPONENT_DEFINE(Sequencer, SEQUENCER);
378 DEG_COMPONENT_DEFINE(Shading, SHADING);
379 DEG_COMPONENT_DEFINE(ShadingParameters, SHADING_PARAMETERS);
380 DEG_COMPONENT_DEFINE(Transform, TRANSFORM);
381
382 /* Bone Component ========================================= */
383
384 /* Initialize 'bone component' node - from pointer data given */
385 void BoneComponentDepsNode::init(const ID *id, const char *subdata)
386 {
387         /* generic component-node... */
388         ComponentDepsNode::init(id, subdata);
389
390         /* name of component comes is bone name */
391         /* TODO(sergey): This sets name to an empty string because subdata is
392          * empty. Is it a bug?
393          */
394         //this->name = subdata;
395
396         /* bone-specific node data */
397         Object *object = (Object *)id;
398         this->pchan = BKE_pose_channel_find_name(object->pose, subdata);
399 }
400
401 DEG_COMPONENT_DEFINE(Bone, BONE);
402
403 /* Node Types Register =================================== */
404
405 void deg_register_component_depsnodes()
406 {
407         deg_register_node_typeinfo(&DNTI_ANIMATION);
408         deg_register_node_typeinfo(&DNTI_BONE);
409         deg_register_node_typeinfo(&DNTI_CACHE);
410         deg_register_node_typeinfo(&DNTI_BATCH_CACHE);
411         deg_register_node_typeinfo(&DNTI_COPY_ON_WRITE);
412         deg_register_node_typeinfo(&DNTI_GEOMETRY);
413         deg_register_node_typeinfo(&DNTI_LAYER_COLLECTIONS);
414         deg_register_node_typeinfo(&DNTI_PARAMETERS);
415         deg_register_node_typeinfo(&DNTI_EVAL_PARTICLES);
416         deg_register_node_typeinfo(&DNTI_PROXY);
417         deg_register_node_typeinfo(&DNTI_EVAL_POSE);
418         deg_register_node_typeinfo(&DNTI_SEQUENCER);
419         deg_register_node_typeinfo(&DNTI_SHADING);
420         deg_register_node_typeinfo(&DNTI_SHADING_PARAMETERS);
421         deg_register_node_typeinfo(&DNTI_TRANSFORM);
422 }
423
424 }  // namespace DEG