Merge branch 'master' into blender2.8
[blender.git] / source / blender / editors / space_outliner / outliner_utils.c
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) 2017 Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 /** \file blender/editors/space_outliner/outliner_utils.c
27  *  \ingroup spoutliner
28  */
29
30 #include "BLI_utildefines.h"
31
32 #include "DNA_action_types.h"
33 #include "DNA_space_types.h"
34
35 #include "BKE_outliner_treehash.h"
36
37 #include "ED_armature.h"
38
39 #include "UI_interface.h"
40
41 #include "outliner_intern.h"
42
43 /**
44  * Try to find an item under y-coordinate \a view_co_y (view-space).
45  * \note Recursive
46  */
47 TreeElement *outliner_find_item_at_y(const SpaceOops *soops, const ListBase *tree, float view_co_y)
48 {
49         for (TreeElement *te_iter = tree->first; te_iter; te_iter = te_iter->next) {
50                 if (view_co_y < (te_iter->ys + UI_UNIT_Y)) {
51                         if (view_co_y >= te_iter->ys) {
52                                 /* co_y is inside this element */
53                                 return te_iter;
54                         }
55                         else if (TSELEM_OPEN(te_iter->store_elem, soops)) {
56                                 /* co_y is lower than current element, possibly inside children */
57                                 TreeElement *te_sub = outliner_find_item_at_y(soops, &te_iter->subtree, view_co_y);
58                                 if (te_sub) {
59                                         return te_sub;
60                                 }
61                         }
62                 }
63         }
64
65         return NULL;
66 }
67
68 /**
69  * Collapsed items can show their children as click-able icons. This function tries to find
70  * such an icon that represents the child item at x-coordinate \a view_co_x (view-space).
71  *
72  * \return a hovered child item or \a parent_te (if no hovered child found).
73  */
74 TreeElement *outliner_find_item_at_x_in_row(const SpaceOops *soops, const TreeElement *parent_te, float view_co_x)
75 {
76         if (!TSELEM_OPEN(TREESTORE(parent_te), soops)) { /* if parent_te is opened, it doesn't show childs in row */
77                 /* no recursion, items can only display their direct children in the row */
78                 for (TreeElement *child_te = parent_te->subtree.first;
79                      child_te && view_co_x >= child_te->xs; /* don't look further if co_x is smaller than child position*/
80                      child_te = child_te->next)
81                 {
82                         if ((child_te->flag & TE_ICONROW) && (view_co_x > child_te->xs) && (view_co_x < child_te->xend)) {
83                                 return child_te;
84                         }
85                 }
86         }
87
88         /* return parent if no child is hovered */
89         return (TreeElement *)parent_te;
90 }
91
92 /* Find specific item from the treestore */
93 TreeElement *outliner_find_tree_element(ListBase *lb, const TreeStoreElem *store_elem)
94 {
95         TreeElement *te, *tes;
96         for (te = lb->first; te; te = te->next) {
97                 if (te->store_elem == store_elem) return te;
98                 tes = outliner_find_tree_element(&te->subtree, store_elem);
99                 if (tes) return tes;
100         }
101         return NULL;
102 }
103
104 /* Find parent element of te */
105 TreeElement *outliner_find_parent_element(ListBase *lb, TreeElement *parent_te, const TreeElement *child_te)
106 {
107         TreeElement *te;
108         for (te = lb->first; te; te = te->next) {
109                 if (te == child_te) {
110                         return parent_te;
111                 }
112
113                 TreeElement *find_te = outliner_find_parent_element(&te->subtree, te, child_te);
114                 if (find_te) {
115                         return find_te;
116                 }
117         }
118         return NULL;
119 }
120
121 /* tse is not in the treestore, we use its contents to find a match */
122 TreeElement *outliner_find_tse(SpaceOops *soops, const TreeStoreElem *tse)
123 {
124         TreeStoreElem *tselem;
125
126         if (tse->id == NULL) return NULL;
127
128         /* check if 'tse' is in treestore */
129         tselem = BKE_outliner_treehash_lookup_any(soops->treehash, tse->type, tse->nr, tse->id);
130         if (tselem)
131                 return outliner_find_tree_element(&soops->tree, tselem);
132
133         return NULL;
134 }
135
136 /* Find treestore that refers to given ID */
137 TreeElement *outliner_find_id(SpaceOops *soops, ListBase *lb, const ID *id)
138 {
139         for (TreeElement *te = lb->first; te; te = te->next) {
140                 TreeStoreElem *tselem = TREESTORE(te);
141                 if (tselem->type == 0) {
142                         if (tselem->id == id) {
143                                 return te;
144                         }
145                 }
146
147                 TreeElement *tes = outliner_find_id(soops, &te->subtree, id);
148                 if (tes) {
149                         return tes;
150                 }
151         }
152         return NULL;
153 }
154
155 TreeElement *outliner_find_posechannel(ListBase *lb, const bPoseChannel *pchan)
156 {
157         for (TreeElement *te = lb->first; te; te = te->next) {
158                 if (te->directdata == pchan) {
159                         return te;
160                 }
161
162                 TreeStoreElem *tselem = TREESTORE(te);
163                 if (ELEM(tselem->type, TSE_POSE_BASE, TSE_POSE_CHANNEL)) {
164                         TreeElement *tes = outliner_find_posechannel(&te->subtree, pchan);
165                         if (tes) {
166                                 return tes;
167                         }
168                 }
169         }
170         return NULL;
171 }
172
173 TreeElement *outliner_find_editbone(ListBase *lb, const EditBone *ebone)
174 {
175         for (TreeElement *te = lb->first; te; te = te->next) {
176                 if (te->directdata == ebone) {
177                         return te;
178                 }
179
180                 TreeStoreElem *tselem = TREESTORE(te);
181                 if (ELEM(tselem->type, 0, TSE_EBONE)) {
182                         TreeElement *tes = outliner_find_editbone(&te->subtree, ebone);
183                         if (tes) {
184                                 return tes;
185                         }
186                 }
187         }
188         return NULL;
189 }
190
191 ID *outliner_search_back(SpaceOops *UNUSED(soops), TreeElement *te, short idcode)
192 {
193         TreeStoreElem *tselem;
194         te = te->parent;
195
196         while (te) {
197                 tselem = TREESTORE(te);
198                 if (tselem->type == 0 && te->idcode == idcode) return tselem->id;
199                 te = te->parent;
200         }
201         return NULL;
202 }
203
204 /**
205  * Iterate over all tree elements (pre-order traversal), executing \a func callback for
206  * each tree element matching the optional filters.
207  *
208  * \param filter_te_flag: If not 0, only TreeElements with this flag will be visited.
209  * \param filter_tselem_flag: Same as \a filter_te_flag, but for the TreeStoreElem.
210  * \param func: Custom callback to execute for each visited item.
211  */
212 bool outliner_tree_traverse(const SpaceOops *soops, ListBase *tree, int filter_te_flag, int filter_tselem_flag,
213                             TreeTraversalFunc func, void *customdata)
214 {
215         for (TreeElement *te = tree->first, *te_next; te; te = te_next) {
216                 TreeTraversalAction func_retval = TRAVERSE_CONTINUE;
217                 /* in case te is freed in callback */
218                 TreeStoreElem *tselem = TREESTORE(te);
219                 ListBase subtree = te->subtree;
220                 te_next = te->next;
221
222                 if (filter_te_flag && (te->flag & filter_te_flag) == 0) {
223                         /* skip */
224                 }
225                 else if (filter_tselem_flag && (tselem->flag & filter_tselem_flag) == 0) {
226                         /* skip */
227                 }
228                 else {
229                         func_retval = func(te, customdata);
230                 }
231                 /* Don't access te or tselem from now on! Might've been freed... */
232
233                 if (func_retval == TRAVERSE_BREAK) {
234                         return false;
235                 }
236
237                 if (func_retval == TRAVERSE_SKIP_CHILDS) {
238                         /* skip */
239                 }
240                 else if (!outliner_tree_traverse(soops, &subtree, filter_te_flag, filter_tselem_flag, func, customdata)) {
241                         return false;
242                 }
243         }
244
245         return true;
246 }