Depsgraph: Fix fake cyclic dependencies for node tree drivers
[blender.git] / source / blender / depsgraph / intern / builder / deg_builder_relations_impl.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): Sergey SHarybin
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/depsgraph/intern/builder/deg_builder_relations_impl.h
28  *  \ingroup depsgraph
29  */
30
31 #pragma once
32
33 #include "intern/nodes/deg_node_id.h"
34
35 extern "C" {
36 #include "DNA_ID.h"
37 }
38
39 namespace DEG {
40
41 template <typename KeyType>
42 OperationDepsNode *DepsgraphRelationBuilder::find_operation_node(const KeyType& key)
43 {
44         DepsNode *node = get_node(key);
45         return node != NULL ? node->get_exit_operation() : NULL;
46 }
47
48 template <typename KeyFrom, typename KeyTo>
49 void DepsgraphRelationBuilder::add_relation(const KeyFrom &key_from,
50                                             const KeyTo &key_to,
51                                             const char *description,
52                                             bool check_unique)
53 {
54         DepsNode *node_from = get_node(key_from);
55         DepsNode *node_to = get_node(key_to);
56         OperationDepsNode *op_from = node_from ? node_from->get_exit_operation() : NULL;
57         OperationDepsNode *op_to = node_to ? node_to->get_entry_operation() : NULL;
58         if (op_from && op_to) {
59                 add_operation_relation(op_from, op_to, description, check_unique);
60         }
61         else {
62                 if (!op_from) {
63                         /* XXX TODO handle as error or report if needed */
64                         fprintf(stderr, "add_relation(%s) - Could not find op_from (%s)\n",
65                                 description, key_from.identifier().c_str());
66                 }
67                 else {
68                         fprintf(stderr, "add_relation(%s) - Failed, but op_from (%s) was ok\n",
69                                 description, key_from.identifier().c_str());
70                 }
71                 if (!op_to) {
72                         /* XXX TODO handle as error or report if needed */
73                         fprintf(stderr, "add_relation(%s) - Could not find op_to (%s)\n",
74                                 description, key_to.identifier().c_str());
75                 }
76                 else {
77                         fprintf(stderr, "add_relation(%s) - Failed, but op_to (%s) was ok\n",
78                                 description, key_to.identifier().c_str());
79                 }
80         }
81 }
82
83 template <typename KeyTo>
84 void DepsgraphRelationBuilder::add_relation(const TimeSourceKey &key_from,
85                                             const KeyTo &key_to,
86                                             const char *description,
87                                             bool check_unique)
88 {
89         TimeSourceDepsNode *time_from = get_node(key_from);
90         DepsNode *node_to = get_node(key_to);
91         OperationDepsNode *op_to = node_to ? node_to->get_entry_operation() : NULL;
92         if (time_from != NULL && op_to != NULL) {
93                 add_time_relation(time_from, op_to, description, check_unique);
94         }
95 }
96
97 template <typename KeyType>
98 void DepsgraphRelationBuilder::add_node_handle_relation(
99         const KeyType &key_from,
100         const DepsNodeHandle *handle,
101         const char *description,
102         bool check_unique)
103 {
104         DepsNode *node_from = get_node(key_from);
105         OperationDepsNode *op_from = node_from ? node_from->get_exit_operation() : NULL;
106         OperationDepsNode *op_to = handle->node->get_entry_operation();
107         if (op_from != NULL && op_to != NULL) {
108                 add_operation_relation(op_from, op_to, description, check_unique);
109         }
110         else {
111                 if (!op_from) {
112                         fprintf(stderr, "add_node_handle_relation(%s) - Could not find op_from (%s)\n",
113                                 description, key_from.identifier().c_str());
114                 }
115                 if (!op_to) {
116                         fprintf(stderr, "add_node_handle_relation(%s) - Could not find op_to (%s)\n",
117                                 description, key_from.identifier().c_str());
118                 }
119         }
120 }
121
122 template <typename KeyType>
123 DepsNodeHandle DepsgraphRelationBuilder::create_node_handle(
124         const KeyType &key,
125         const char *default_name)
126 {
127         return DepsNodeHandle(this, get_node(key), default_name);
128 }
129
130 /* Rig compatibility: we check if bone is using local transform as a variable
131  * for driver on itself and ignore those relations to avoid "false-positive"
132  * dependency cycles.
133  */
134 template <typename KeyFrom, typename KeyTo>
135 bool DepsgraphRelationBuilder::is_same_bone_dependency(const KeyFrom& key_from,
136                                                        const KeyTo& key_to)
137 {
138         /* Get operations for requested keys. */
139         DepsNode *node_from = get_node(key_from);
140         DepsNode *node_to = get_node(key_to);
141         if (node_from == NULL || node_to == NULL) {
142                 return false;
143         }
144         OperationDepsNode *op_from = node_from->get_exit_operation();
145         OperationDepsNode *op_to = node_to->get_entry_operation();
146         if (op_from == NULL || op_to == NULL) {
147                 return false;
148         }
149         /* Different armatures, bone can't be the same. */
150         if (op_from->owner->owner != op_to->owner->owner) {
151                 return false;
152         }
153         /* We are only interested in relations like BONE_DONE -> BONE_LOCAL... */
154         if (!(op_from->opcode == DEG_OPCODE_BONE_DONE &&
155               op_to->opcode == DEG_OPCODE_BONE_LOCAL))
156         {
157                 return false;
158         }
159         /* ... BUT, we also need to check if it's same bone.  */
160         if (!STREQ(op_from->owner->name, op_to->owner->name)) {
161                 return false;
162         }
163         return true;
164 }
165
166 template <typename KeyFrom, typename KeyTo>
167 bool DepsgraphRelationBuilder::is_nodetree_node_dependency(
168         const KeyFrom& key_from,
169         const KeyTo& key_to)
170 {
171         /* Get operations for requested keys. */
172         DepsNode *node_from = get_node(key_from);
173         DepsNode *node_to = get_node(key_to);
174         if (node_from == NULL || node_to == NULL) {
175                 return false;
176         }
177         OperationDepsNode *op_from = node_from->get_exit_operation();
178         OperationDepsNode *op_to = node_to->get_entry_operation();
179         if (op_from == NULL || op_to == NULL) {
180                 return false;
181         }
182         /* Check if this is actually a node tree. */
183         if (GS(op_from->owner->owner->id->name) != ID_NT) {
184                 return false;
185         }
186         /* Different node trees. */
187         if (op_from->owner->owner != op_to->owner->owner) {
188                 return false;
189         }
190         /* We are only interested in relations like BONE_DONE -> BONE_LOCAL... */
191         if (!(op_from->opcode == DEG_OPCODE_PARAMETERS_EVAL &&
192               op_to->opcode == DEG_OPCODE_PARAMETERS_EVAL))
193         {
194                 return false;
195         }
196         return true;
197 }
198
199 }  // namespace DEG