doxygen: add newline after \file
[blender.git] / source / blender / depsgraph / intern / builder / deg_builder_relations_impl.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2013 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup depsgraph
22  */
23
24 #pragma once
25
26 #include "intern/node/deg_node_id.h"
27
28 extern "C" {
29 #include "DNA_ID.h"
30 }
31
32 namespace DEG {
33
34 template <typename KeyType>
35 OperationNode *DepsgraphRelationBuilder::find_operation_node(const KeyType& key)
36 {
37         Node *node = get_node(key);
38         return node != NULL ? node->get_exit_operation() : NULL;
39 }
40
41 template <typename KeyFrom, typename KeyTo>
42 Relation *DepsgraphRelationBuilder::add_relation(const KeyFrom &key_from,
43                                                  const KeyTo &key_to,
44                                                  const char *description,
45                                                  int flags)
46 {
47         Node *node_from = get_node(key_from);
48         Node *node_to = get_node(key_to);
49         OperationNode *op_from = node_from ? node_from->get_exit_operation() : NULL;
50         OperationNode *op_to = node_to ? node_to->get_entry_operation() : NULL;
51         if (op_from && op_to) {
52                 return add_operation_relation(op_from, op_to, description, flags);
53         }
54         else {
55                 if (!op_from) {
56                         /* XXX TODO handle as error or report if needed */
57                         fprintf(stderr, "add_relation(%s) - Could not find op_from (%s)\n",
58                                 description, key_from.identifier().c_str());
59                 }
60                 else {
61                         fprintf(stderr, "add_relation(%s) - Failed, but op_from (%s) was ok\n",
62                                 description, key_from.identifier().c_str());
63                 }
64                 if (!op_to) {
65                         /* XXX TODO handle as error or report if needed */
66                         fprintf(stderr, "add_relation(%s) - Could not find op_to (%s)\n",
67                                 description, key_to.identifier().c_str());
68                 }
69                 else {
70                         fprintf(stderr, "add_relation(%s) - Failed, but op_to (%s) was ok\n",
71                                 description, key_to.identifier().c_str());
72                 }
73         }
74         return NULL;
75 }
76
77 template <typename KeyTo>
78 Relation *DepsgraphRelationBuilder::add_relation(
79         const TimeSourceKey &key_from,
80         const KeyTo &key_to,
81         const char *description,
82         int flags)
83 {
84         TimeSourceNode *time_from = get_node(key_from);
85         Node *node_to = get_node(key_to);
86         OperationNode *op_to = node_to ? node_to->get_entry_operation() : NULL;
87         if (time_from != NULL && op_to != NULL) {
88                 return add_time_relation(
89                         time_from, op_to, description, flags);
90         }
91         return NULL;
92 }
93
94 template <typename KeyType>
95 Relation *DepsgraphRelationBuilder::add_node_handle_relation(
96         const KeyType &key_from,
97         const DepsNodeHandle *handle,
98         const char *description,
99         int flags)
100 {
101         Node *node_from = get_node(key_from);
102         OperationNode *op_from = node_from ? node_from->get_exit_operation() : NULL;
103         OperationNode *op_to = handle->node->get_entry_operation();
104         if (op_from != NULL && op_to != NULL) {
105                 return add_operation_relation(op_from, op_to, description, flags);
106         }
107         else {
108                 if (!op_from) {
109                         fprintf(stderr, "add_node_handle_relation(%s) - Could not find op_from (%s)\n",
110                                 description, key_from.identifier().c_str());
111                 }
112                 if (!op_to) {
113                         fprintf(stderr, "add_node_handle_relation(%s) - Could not find op_to (%s)\n",
114                                 description, key_from.identifier().c_str());
115                 }
116         }
117         return NULL;
118 }
119
120 template <typename KeyType>
121 DepsNodeHandle DepsgraphRelationBuilder::create_node_handle(
122         const KeyType &key,
123         const char *default_name)
124 {
125         return DepsNodeHandle(this, get_node(key), default_name);
126 }
127
128 /* Rig compatibility: we check if bone is using local transform as a variable
129  * for driver on itself and ignore those relations to avoid "false-positive"
130  * dependency cycles.
131  */
132 template <typename KeyFrom, typename KeyTo>
133 bool DepsgraphRelationBuilder::is_same_bone_dependency(const KeyFrom& key_from,
134                                                        const KeyTo& key_to)
135 {
136         /* Get operations for requested keys. */
137         Node *node_from = get_node(key_from);
138         Node *node_to = get_node(key_to);
139         if (node_from == NULL || node_to == NULL) {
140                 return false;
141         }
142         OperationNode *op_from = node_from->get_exit_operation();
143         OperationNode *op_to = node_to->get_entry_operation();
144         if (op_from == NULL || op_to == NULL) {
145                 return false;
146         }
147         /* Different armatures, bone can't be the same. */
148         if (op_from->owner->owner != op_to->owner->owner) {
149                 return false;
150         }
151         /* We are only interested in relations like BONE_DONE -> BONE_LOCAL... */
152         if (!(op_from->opcode == OperationCode::BONE_DONE &&
153               op_to->opcode == OperationCode::BONE_LOCAL))
154         {
155                 return false;
156         }
157         /* ... BUT, we also need to check if it's same bone.  */
158         if (!STREQ(op_from->owner->name, op_to->owner->name)) {
159                 return false;
160         }
161         return true;
162 }
163
164 template <typename KeyFrom, typename KeyTo>
165 bool DepsgraphRelationBuilder::is_same_nodetree_node_dependency(
166         const KeyFrom& key_from,
167         const KeyTo& key_to)
168 {
169         /* Get operations for requested keys. */
170         Node *node_from = get_node(key_from);
171         Node *node_to = get_node(key_to);
172         if (node_from == NULL || node_to == NULL) {
173                 return false;
174         }
175         OperationNode *op_from = node_from->get_exit_operation();
176         OperationNode *op_to = node_to->get_entry_operation();
177         if (op_from == NULL || op_to == NULL) {
178                 return false;
179         }
180         /* Check if this is actually a node tree. */
181         if (GS(op_from->owner->owner->id_orig->name) != ID_NT) {
182                 return false;
183         }
184         /* Different node trees. */
185         if (op_from->owner->owner != op_to->owner->owner) {
186                 return false;
187         }
188         /* We are only interested in relations like BONE_DONE -> BONE_LOCAL... */
189         if (!(op_from->opcode == OperationCode::PARAMETERS_EVAL &&
190               op_to->opcode == OperationCode::PARAMETERS_EVAL))
191         {
192                 return false;
193         }
194         return true;
195 }
196
197 }  // namespace DEG