Depsgraph: Cleanup, deduplicate code around component registration
[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     layers(0)
128 {
129         operations_map = BLI_ghash_new(comp_node_hash_key,
130                                        comp_node_hash_key_cmp,
131                                        "Depsgraph id hash");
132 }
133
134 /* Initialize 'component' node - from pointer data given */
135 void ComponentDepsNode::init(const ID * /*id*/,
136                              const char * /*subdata*/)
137 {
138         /* hook up eval context? */
139         // XXX: maybe this needs a special API?
140 }
141
142 /* Free 'component' node */
143 ComponentDepsNode::~ComponentDepsNode()
144 {
145         clear_operations();
146         if (operations_map != NULL) {
147                 BLI_ghash_free(operations_map,
148                                comp_node_hash_key_free,
149                                comp_node_hash_value_free);
150         }
151 }
152
153 string ComponentDepsNode::identifier() const
154 {
155         string idname = this->owner->name;
156
157         char typebuf[16];
158         sprintf(typebuf, "(%d)", type);
159
160         char layers[16];
161         sprintf(layers, "%u", this->layers);
162
163         return string(typebuf) + name + " : " + idname + " (Layers: " + layers + ")";
164 }
165
166 OperationDepsNode *ComponentDepsNode::find_operation(OperationIDKey key) const
167 {
168         OperationDepsNode *node = reinterpret_cast<OperationDepsNode *>(BLI_ghash_lookup(operations_map, &key));
169         if (node != NULL) {
170                 return node;
171         }
172         else {
173                 fprintf(stderr, "%s: find_operation(%s) failed\n",
174                         this->identifier().c_str(), key.identifier().c_str());
175                 BLI_assert(!"Request for non-existing operation, should not happen");
176                 return NULL;
177         }
178 }
179
180 OperationDepsNode *ComponentDepsNode::find_operation(eDepsOperation_Code opcode,
181                                                      const char *name,
182                                                      int name_tag) const
183 {
184         OperationIDKey key(opcode, name, name_tag);
185         return find_operation(key);
186 }
187
188 OperationDepsNode *ComponentDepsNode::has_operation(OperationIDKey key) const
189 {
190         return reinterpret_cast<OperationDepsNode *>(BLI_ghash_lookup(operations_map, &key));
191 }
192
193 OperationDepsNode *ComponentDepsNode::has_operation(eDepsOperation_Code opcode,
194                                                     const char *name,
195                                                     int name_tag) const
196 {
197         OperationIDKey key(opcode, name, name_tag);
198         return has_operation(key);
199 }
200
201 OperationDepsNode *ComponentDepsNode::add_operation(const DepsEvalOperationCb& op,
202                                                     eDepsOperation_Code opcode,
203                                                     const char *name,
204                                                     int name_tag)
205 {
206         OperationDepsNode *op_node = has_operation(opcode, name, name_tag);
207         if (!op_node) {
208                 DepsNodeFactory *factory = deg_get_node_factory(DEG_NODE_TYPE_OPERATION);
209                 op_node = (OperationDepsNode *)factory->create_node(this->owner->id, "", name);
210
211                 /* register opnode in this component's operation set */
212                 OperationIDKey *key = OBJECT_GUARDED_NEW(OperationIDKey, opcode, name, name_tag);
213                 BLI_ghash_insert(operations_map, key, op_node);
214
215                 /* set backlink */
216                 op_node->owner = this;
217         }
218         else {
219                 fprintf(stderr, "add_operation: Operation already exists - %s has %s at %p\n",
220                         this->identifier().c_str(), op_node->identifier().c_str(), op_node);
221                 BLI_assert(!"Should not happen!");
222         }
223
224         /* attach extra data */
225         op_node->evaluate = op;
226         op_node->opcode = opcode;
227         op_node->name = name;
228
229         return op_node;
230 }
231
232 void ComponentDepsNode::set_entry_operation(OperationDepsNode *op_node)
233 {
234         BLI_assert(entry_operation == NULL);
235         entry_operation = op_node;
236 }
237
238 void ComponentDepsNode::set_exit_operation(OperationDepsNode *op_node)
239 {
240         BLI_assert(exit_operation == NULL);
241         exit_operation = op_node;
242 }
243
244 void ComponentDepsNode::clear_operations()
245 {
246         if (operations_map != NULL) {
247                 BLI_ghash_clear(operations_map,
248                                 comp_node_hash_key_free,
249                                 comp_node_hash_value_free);
250         }
251         foreach (OperationDepsNode *op_node, operations) {
252                 OBJECT_GUARDED_DELETE(op_node, OperationDepsNode);
253         }
254         operations.clear();
255 }
256
257 void ComponentDepsNode::tag_update(Depsgraph *graph)
258 {
259         OperationDepsNode *entry_op = get_entry_operation();
260         if (entry_op != NULL && entry_op->flag & DEPSOP_FLAG_NEEDS_UPDATE) {
261                 return;
262         }
263         foreach (OperationDepsNode *op_node, operations) {
264                 op_node->tag_update(graph);
265         }
266         // It is possible that tag happens before finalization.
267         if (operations_map != NULL) {
268                 GHASH_FOREACH_BEGIN(OperationDepsNode *, op_node, operations_map)
269                 {
270                         op_node->tag_update(graph);
271                 }
272                 GHASH_FOREACH_END();
273         }
274 }
275
276 OperationDepsNode *ComponentDepsNode::get_entry_operation()
277 {
278         if (entry_operation) {
279                 return entry_operation;
280         }
281         else if (operations_map != NULL && BLI_ghash_size(operations_map) == 1) {
282                 OperationDepsNode *op_node = NULL;
283                 /* TODO(sergey): This is somewhat slow. */
284                 GHASH_FOREACH_BEGIN(OperationDepsNode *, tmp, operations_map)
285                 {
286                         op_node = tmp;
287                 }
288                 GHASH_FOREACH_END();
289                 /* Cache for the subsequent usage. */
290                 entry_operation = op_node;
291                 return op_node;
292         }
293         else if (operations.size() == 1) {
294                 return operations[0];
295         }
296         return NULL;
297 }
298
299 OperationDepsNode *ComponentDepsNode::get_exit_operation()
300 {
301         if (exit_operation) {
302                 return exit_operation;
303         }
304         else if (operations_map != NULL && BLI_ghash_size(operations_map) == 1) {
305                 OperationDepsNode *op_node = NULL;
306                 /* TODO(sergey): This is somewhat slow. */
307                 GHASH_FOREACH_BEGIN(OperationDepsNode *, tmp, operations_map)
308                 {
309                         op_node = tmp;
310                 }
311                 GHASH_FOREACH_END();
312                 /* Cache for the subsequent usage. */
313                 exit_operation = op_node;
314                 return op_node;
315         }
316         else if (operations.size() == 1) {
317                 return operations[0];
318         }
319         return NULL;
320 }
321
322 void ComponentDepsNode::finalize_build()
323 {
324         operations.reserve(BLI_ghash_size(operations_map));
325         GHASH_FOREACH_BEGIN(OperationDepsNode *, op_node, operations_map)
326         {
327                 operations.push_back(op_node);
328         }
329         GHASH_FOREACH_END();
330         BLI_ghash_free(operations_map,
331                        comp_node_hash_key_free,
332                        NULL);
333         operations_map = NULL;
334 }
335
336 /* Register all components. =============================== */
337
338 #define DEG_COMPONENT_DEFINE(name, NAME)                             \
339   DEG_DEPSNODE_DEFINE(name ## ComponentDepsNode,                     \
340                       DEG_NODE_TYPE_ ## NAME,                        \
341                       #name  " Component");                          \
342 static DepsNodeFactoryImpl<name ## ComponentDepsNode> DNTI_ ## NAME
343
344
345 DEG_COMPONENT_DEFINE(Animation, ANIMATION);
346 DEG_COMPONENT_DEFINE(Cache, CACHE);
347 DEG_COMPONENT_DEFINE(Geometry, GEOMETRY);
348 DEG_COMPONENT_DEFINE(Parameters, PARAMETERS);
349 DEG_COMPONENT_DEFINE(Particles, EVAL_PARTICLES);
350 DEG_COMPONENT_DEFINE(Proxy, PROXY);
351 DEG_COMPONENT_DEFINE(Pose, EVAL_POSE);
352 DEG_COMPONENT_DEFINE(Sequencer, SEQUENCER);
353 DEG_COMPONENT_DEFINE(Shading, SHADING);
354 DEG_COMPONENT_DEFINE(Transform, TRANSFORM);
355
356 /* Bone Component ========================================= */
357
358 /* Initialize 'bone component' node - from pointer data given */
359 void BoneComponentDepsNode::init(const ID *id, const char *subdata)
360 {
361         /* generic component-node... */
362         ComponentDepsNode::init(id, subdata);
363
364         /* name of component comes is bone name */
365         /* TODO(sergey): This sets name to an empty string because subdata is
366          * empty. Is it a bug?
367          */
368         //this->name = subdata;
369
370         /* bone-specific node data */
371         Object *object = (Object *)id;
372         this->pchan = BKE_pose_channel_find_name(object->pose, subdata);
373 }
374
375 DEG_COMPONENT_DEFINE(Bone, BONE);
376
377 /* Node Types Register =================================== */
378
379 void deg_register_component_depsnodes()
380 {
381         deg_register_node_typeinfo(&DNTI_PARAMETERS);
382         deg_register_node_typeinfo(&DNTI_PROXY);
383         deg_register_node_typeinfo(&DNTI_ANIMATION);
384         deg_register_node_typeinfo(&DNTI_TRANSFORM);
385         deg_register_node_typeinfo(&DNTI_GEOMETRY);
386         deg_register_node_typeinfo(&DNTI_SEQUENCER);
387
388         deg_register_node_typeinfo(&DNTI_EVAL_POSE);
389         deg_register_node_typeinfo(&DNTI_BONE);
390
391         deg_register_node_typeinfo(&DNTI_EVAL_PARTICLES);
392         deg_register_node_typeinfo(&DNTI_SHADING);
393
394         deg_register_node_typeinfo(&DNTI_CACHE);
395 }
396
397 }  // namespace DEG