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 /* tse is not in the treestore, we use its contents to find a match */
105 TreeElement *outliner_find_tse(SpaceOops *soops, const TreeStoreElem *tse)
106 {
107         TreeStoreElem *tselem;
108
109         if (tse->id == NULL) return NULL;
110
111         /* check if 'tse' is in treestore */
112         tselem = BKE_outliner_treehash_lookup_any(soops->treehash, tse->type, tse->nr, tse->id);
113         if (tselem)
114                 return outliner_find_tree_element(&soops->tree, tselem);
115
116         return NULL;
117 }
118
119 /* Find treestore that refers to given ID */
120 TreeElement *outliner_find_id(SpaceOops *soops, ListBase *lb, const ID *id)
121 {
122         for (TreeElement *te = lb->first; te; te = te->next) {
123                 TreeStoreElem *tselem = TREESTORE(te);
124                 if (tselem->type == 0) {
125                         if (tselem->id == id) {
126                                 return te;
127                         }
128                         /* only deeper on scene or object */
129                         if (ELEM(te->idcode, ID_OB, ID_SCE) ||
130                             ((soops->outlinevis == SO_GROUPS) && (te->idcode == ID_GR)))
131                         {
132                                 TreeElement *tes = outliner_find_id(soops, &te->subtree, id);
133                                 if (tes) {
134                                         return tes;
135                                 }
136                         }
137                 }
138         }
139         return NULL;
140 }
141
142 TreeElement *outliner_find_posechannel(ListBase *lb, const bPoseChannel *pchan)
143 {
144         for (TreeElement *te = lb->first; te; te = te->next) {
145                 if (te->directdata == pchan) {
146                         return te;
147                 }
148
149                 TreeStoreElem *tselem = TREESTORE(te);
150                 if (ELEM(tselem->type, TSE_POSE_BASE, TSE_POSE_CHANNEL)) {
151                         TreeElement *tes = outliner_find_posechannel(&te->subtree, pchan);
152                         if (tes) {
153                                 return tes;
154                         }
155                 }
156         }
157         return NULL;
158 }
159
160 TreeElement *outliner_find_editbone(ListBase *lb, const EditBone *ebone)
161 {
162         for (TreeElement *te = lb->first; te; te = te->next) {
163                 if (te->directdata == ebone) {
164                         return te;
165                 }
166
167                 TreeStoreElem *tselem = TREESTORE(te);
168                 if (ELEM(tselem->type, 0, TSE_EBONE)) {
169                         TreeElement *tes = outliner_find_editbone(&te->subtree, ebone);
170                         if (tes) {
171                                 return tes;
172                         }
173                 }
174         }
175         return NULL;
176 }
177
178 ID *outliner_search_back(SpaceOops *UNUSED(soops), TreeElement *te, short idcode)
179 {
180         TreeStoreElem *tselem;
181         te = te->parent;
182
183         while (te) {
184                 tselem = TREESTORE(te);
185                 if (tselem->type == 0 && te->idcode == idcode) return tselem->id;
186                 te = te->parent;
187         }
188         return NULL;
189 }
190
191 /**
192  * Iterate over all tree elements (pre-order traversal), executing \a func callback for
193  * each tree element matching the optional filters.
194  *
195  * \param filter_te_flag: If not 0, only TreeElements with this flag will be visited.
196  * \param filter_tselem_flag: Same as \a filter_te_flag, but for the TreeStoreElem.
197  * \param func: Custom callback to execute for each visited item.
198  */
199 bool outliner_tree_traverse(const SpaceOops *soops, ListBase *tree, int filter_te_flag, int filter_tselem_flag,
200                             TreeTraversalFunc func, void *customdata)
201 {
202         for (TreeElement *te = tree->first, *te_next; te; te = te_next) {
203                 TreeTraversalAction func_retval = TRAVERSE_CONTINUE;
204                 /* in case te is freed in callback */
205                 TreeStoreElem *tselem = TREESTORE(te);
206                 ListBase subtree = te->subtree;
207                 te_next = te->next;
208
209                 if (filter_te_flag && (te->flag & filter_te_flag) == 0) {
210                         /* skip */
211                 }
212                 else if (filter_tselem_flag && (tselem->flag & filter_tselem_flag) == 0) {
213                         /* skip */
214                 }
215                 else {
216                         func_retval = func(te, customdata);
217                 }
218                 /* Don't access te or tselem from now on! Might've been freed... */
219
220                 if (func_retval == TRAVERSE_BREAK) {
221                         return false;
222                 }
223
224                 if (func_retval == TRAVERSE_SKIP_CHILDS) {
225                         /* skip */
226                 }
227                 else if (!outliner_tree_traverse(soops, &subtree, filter_te_flag, filter_tselem_flag, func, customdata)) {
228                         return false;
229                 }
230         }
231
232         return true;
233 }