Depsgraph: Comb code to a better state all over
[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/node/deg_node_id.h"
34
35 extern "C" {
36 #include "DNA_ID.h"
37 }
38
39 namespace DEG {
40
41 template <typename KeyType>
42 OperationNode *DepsgraphRelationBuilder::find_operation_node(const KeyType& key)
43 {
44         Node *node = get_node(key);
45         return node != NULL ? node->get_exit_operation() : NULL;
46 }
47
48 template <typename KeyFrom, typename KeyTo>
49 Relation *DepsgraphRelationBuilder::add_relation(const KeyFrom &key_from,
50                                                  const KeyTo &key_to,
51                                                  const char *description,
52                                                  int flags)
53 {
54         Node *node_from = get_node(key_from);
55         Node *node_to = get_node(key_to);
56         OperationNode *op_from = node_from ? node_from->get_exit_operation() : NULL;
57         OperationNode *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, flags);
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 Relation *DepsgraphRelationBuilder::add_relation(
86         const TimeSourceKey &key_from,
87         const KeyTo &key_to,
88         const char *description,
89         int flags)
90 {
91         TimeSourceNode *time_from = get_node(key_from);
92         Node *node_to = get_node(key_to);
93         OperationNode *op_to = node_to ? node_to->get_entry_operation() : NULL;
94         if (time_from != NULL && op_to != NULL) {
95                 return add_time_relation(
96                         time_from, op_to, description, flags);
97         }
98         return NULL;
99 }
100
101 template <typename KeyType>
102 Relation *DepsgraphRelationBuilder::add_node_handle_relation(
103         const KeyType &key_from,
104         const DepsNodeHandle *handle,
105         const char *description,
106         int flags)
107 {
108         Node *node_from = get_node(key_from);
109         OperationNode *op_from = node_from ? node_from->get_exit_operation() : NULL;
110         OperationNode *op_to = handle->node->get_entry_operation();
111         if (op_from != NULL && op_to != NULL) {
112                 return add_operation_relation(op_from, op_to, description, flags);
113         }
114         else {
115                 if (!op_from) {
116                         fprintf(stderr, "add_node_handle_relation(%s) - Could not find op_from (%s)\n",
117                                 description, key_from.identifier().c_str());
118                 }
119                 if (!op_to) {
120                         fprintf(stderr, "add_node_handle_relation(%s) - Could not find op_to (%s)\n",
121                                 description, key_from.identifier().c_str());
122                 }
123         }
124         return NULL;
125 }
126
127 template <typename KeyType>
128 DepsNodeHandle DepsgraphRelationBuilder::create_node_handle(
129         const KeyType &key,
130         const char *default_name)
131 {
132         return DepsNodeHandle(this, get_node(key), default_name);
133 }
134
135 /* Rig compatibility: we check if bone is using local transform as a variable
136  * for driver on itself and ignore those relations to avoid "false-positive"
137  * dependency cycles.
138  */
139 template <typename KeyFrom, typename KeyTo>
140 bool DepsgraphRelationBuilder::is_same_bone_dependency(const KeyFrom& key_from,
141                                                        const KeyTo& key_to)
142 {
143         /* Get operations for requested keys. */
144         Node *node_from = get_node(key_from);
145         Node *node_to = get_node(key_to);
146         if (node_from == NULL || node_to == NULL) {
147                 return false;
148         }
149         OperationNode *op_from = node_from->get_exit_operation();
150         OperationNode *op_to = node_to->get_entry_operation();
151         if (op_from == NULL || op_to == NULL) {
152                 return false;
153         }
154         /* Different armatures, bone can't be the same. */
155         if (op_from->owner->owner != op_to->owner->owner) {
156                 return false;
157         }
158         /* We are only interested in relations like BONE_DONE -> BONE_LOCAL... */
159         if (!(op_from->opcode == OperationCode::BONE_DONE &&
160               op_to->opcode == OperationCode::BONE_LOCAL))
161         {
162                 return false;
163         }
164         /* ... BUT, we also need to check if it's same bone.  */
165         if (!STREQ(op_from->owner->name, op_to->owner->name)) {
166                 return false;
167         }
168         return true;
169 }
170
171 template <typename KeyFrom, typename KeyTo>
172 bool DepsgraphRelationBuilder::is_same_nodetree_node_dependency(
173         const KeyFrom& key_from,
174         const KeyTo& key_to)
175 {
176         /* Get operations for requested keys. */
177         Node *node_from = get_node(key_from);
178         Node *node_to = get_node(key_to);
179         if (node_from == NULL || node_to == NULL) {
180                 return false;
181         }
182         OperationNode *op_from = node_from->get_exit_operation();
183         OperationNode *op_to = node_to->get_entry_operation();
184         if (op_from == NULL || op_to == NULL) {
185                 return false;
186         }
187         /* Check if this is actually a node tree. */
188         if (GS(op_from->owner->owner->id_orig->name) != ID_NT) {
189                 return false;
190         }
191         /* Different node trees. */
192         if (op_from->owner->owner != op_to->owner->owner) {
193                 return false;
194         }
195         /* We are only interested in relations like BONE_DONE -> BONE_LOCAL... */
196         if (!(op_from->opcode == OperationCode::PARAMETERS_EVAL &&
197               op_to->opcode == OperationCode::PARAMETERS_EVAL))
198         {
199                 return false;
200         }
201         return true;
202 }
203
204 }  // namespace DEG