Merge branch 'master' into blender2.8
[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 DepsRelation *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                 return 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         return NULL;
82 }
83
84 template <typename KeyTo>
85 DepsRelation *DepsgraphRelationBuilder::add_relation(
86         const TimeSourceKey &key_from,
87         const KeyTo &key_to,
88         const char *description,
89         bool check_unique)
90 {
91         TimeSourceDepsNode *time_from = get_node(key_from);
92         DepsNode *node_to = get_node(key_to);
93         OperationDepsNode *op_to = node_to ? node_to->get_entry_operation() : NULL;
94         if (time_from != NULL && op_to != NULL) {
95                 return add_time_relation(time_from, op_to, description, check_unique);
96         }
97         return NULL;
98 }
99
100 template <typename KeyType>
101 DepsRelation *DepsgraphRelationBuilder::add_node_handle_relation(
102         const KeyType &key_from,
103         const DepsNodeHandle *handle,
104         const char *description,
105         bool check_unique)
106 {
107         DepsNode *node_from = get_node(key_from);
108         OperationDepsNode *op_from = node_from ? node_from->get_exit_operation() : NULL;
109         OperationDepsNode *op_to = handle->node->get_entry_operation();
110         if (op_from != NULL && op_to != NULL) {
111                 return add_operation_relation(op_from, op_to, description, check_unique);
112         }
113         else {
114                 if (!op_from) {
115                         fprintf(stderr, "add_node_handle_relation(%s) - Could not find op_from (%s)\n",
116                                 description, key_from.identifier().c_str());
117                 }
118                 if (!op_to) {
119                         fprintf(stderr, "add_node_handle_relation(%s) - Could not find op_to (%s)\n",
120                                 description, key_from.identifier().c_str());
121                 }
122         }
123         return NULL;
124 }
125
126 template <typename KeyType>
127 DepsNodeHandle DepsgraphRelationBuilder::create_node_handle(
128         const KeyType &key,
129         const char *default_name)
130 {
131         return DepsNodeHandle(this, get_node(key), default_name);
132 }
133
134 /* Rig compatibility: we check if bone is using local transform as a variable
135  * for driver on itself and ignore those relations to avoid "false-positive"
136  * dependency cycles.
137  */
138 template <typename KeyFrom, typename KeyTo>
139 bool DepsgraphRelationBuilder::is_same_bone_dependency(const KeyFrom& key_from,
140                                                        const KeyTo& key_to)
141 {
142         /* Get operations for requested keys. */
143         DepsNode *node_from = get_node(key_from);
144         DepsNode *node_to = get_node(key_to);
145         if (node_from == NULL || node_to == NULL) {
146                 return false;
147         }
148         OperationDepsNode *op_from = node_from->get_exit_operation();
149         OperationDepsNode *op_to = node_to->get_entry_operation();
150         if (op_from == NULL || op_to == NULL) {
151                 return false;
152         }
153         /* Different armatures, bone can't be the same. */
154         if (op_from->owner->owner != op_to->owner->owner) {
155                 return false;
156         }
157         /* We are only interested in relations like BONE_DONE -> BONE_LOCAL... */
158         if (!(op_from->opcode == DEG_OPCODE_BONE_DONE &&
159               op_to->opcode == DEG_OPCODE_BONE_LOCAL))
160         {
161                 return false;
162         }
163         /* ... BUT, we also need to check if it's same bone.  */
164         if (!STREQ(op_from->owner->name, op_to->owner->name)) {
165                 return false;
166         }
167         return true;
168 }
169
170 template <typename KeyFrom, typename KeyTo>
171 bool DepsgraphRelationBuilder::is_same_nodetree_node_dependency(
172         const KeyFrom& key_from,
173         const KeyTo& key_to)
174 {
175         /* Get operations for requested keys. */
176         DepsNode *node_from = get_node(key_from);
177         DepsNode *node_to = get_node(key_to);
178         if (node_from == NULL || node_to == NULL) {
179                 return false;
180         }
181         OperationDepsNode *op_from = node_from->get_exit_operation();
182         OperationDepsNode *op_to = node_to->get_entry_operation();
183         if (op_from == NULL || op_to == NULL) {
184                 return false;
185         }
186         /* Check if this is actually a node tree. */
187         if (GS(op_from->owner->owner->id_orig->name) != ID_NT) {
188                 return false;
189         }
190         /* Different node trees. */
191         if (op_from->owner->owner != op_to->owner->owner) {
192                 return false;
193         }
194         /* We are only interested in relations like BONE_DONE -> BONE_LOCAL... */
195         if (!(op_from->opcode == DEG_OPCODE_PARAMETERS_EVAL &&
196               op_to->opcode == DEG_OPCODE_PARAMETERS_EVAL))
197         {
198                 return false;
199         }
200         return true;
201 }
202
203 template <typename KeyFrom, typename KeyTo>
204 bool DepsgraphRelationBuilder::is_same_shapekey_dependency(
205         const KeyFrom& key_from,
206         const KeyTo& key_to)
207 {
208         /* Get operations for requested keys. */
209         DepsNode *node_from = get_node(key_from);
210         DepsNode *node_to = get_node(key_to);
211         if (node_from == NULL || node_to == NULL) {
212                 return false;
213         }
214         OperationDepsNode *op_from = node_from->get_exit_operation();
215         OperationDepsNode *op_to = node_to->get_entry_operation();
216         if (op_from == NULL || op_to == NULL) {
217                 return false;
218         }
219         /* Check if this is actually a shape key datablock. */
220         if (GS(op_from->owner->owner->id_orig->name) != ID_KE) {
221                 return false;
222         }
223         /* Different key data blocks. */
224         if (op_from->owner->owner != op_to->owner->owner) {
225                 return false;
226         }
227         return true;
228 }
229
230 }  // namespace DEG