Merge branch 'master' into blender2.8
[blender.git] / source / blender / editors / space_outliner / outliner_intern.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) 2008 Blender Foundation.
19  * All rights reserved.
20  *
21  *
22  * Contributor(s): Blender Foundation
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/editors/space_outliner/outliner_intern.h
28  *  \ingroup spoutliner
29  */
30
31
32 #ifndef __OUTLINER_INTERN_H__
33 #define __OUTLINER_INTERN_H__
34
35 #include "RNA_types.h"
36
37 /* internal exports only */
38
39 struct ARegion;
40 struct ListBase;
41 struct wmOperatorType;
42 struct TreeElement;
43 struct TreeStoreElem;
44 struct Main;
45 struct bContext;
46 struct Scene;
47 struct ViewLayer;
48 struct ID;
49 struct Object;
50 struct bPoseChannel;
51 struct EditBone;
52 struct wmEvent;
53 struct wmKeyConfig;
54
55 typedef enum TreeElementInsertType {
56         TE_INSERT_BEFORE,
57         TE_INSERT_AFTER,
58         TE_INSERT_INTO,
59 } TreeElementInsertType;
60
61 typedef enum TreeTraversalAction {
62         /* Continue traversal regularly, don't skip children. */
63         TRAVERSE_CONTINUE = 0,
64         /* Stop traversal */
65         TRAVERSE_BREAK,
66         /* Continue traversal, but skip childs of traversed element */
67         TRAVERSE_SKIP_CHILDS,
68 } TreeTraversalAction;
69
70 typedef TreeTraversalAction (*TreeTraversalFunc)(struct TreeElement *te, void *customdata);
71
72
73 typedef struct TreeElement {
74         struct TreeElement *next, *prev, *parent;
75         ListBase subtree;
76         int xs, ys;                // do selection
77         TreeStoreElem *store_elem; // element in tree store
78         short flag;                // flag for non-saved stuff
79         short index;               // index for data arrays
80         short idcode;              // from TreeStore id
81         short xend;                // width of item display, for select
82         const char *name;
83         void *directdata;          // Armature Bones, Base, Sequence, Strip...
84         PointerRNA rnaptr;         // RNA Pointer
85 } TreeElement;
86
87 typedef struct TreeElementIcon {
88         struct ID *drag_id, *drag_parent;
89         int icon;
90 } TreeElementIcon;
91
92 #define TREESTORE_ID_TYPE(_id) \
93         (ELEM(GS((_id)->name), ID_SCE, ID_LI, ID_OB, ID_ME, ID_CU, ID_MB, ID_NT, ID_MA, ID_TE, ID_IM, ID_LT, ID_LA, ID_CA) || \
94          ELEM(GS((_id)->name), ID_KE, ID_WO, ID_SPK, ID_GR, ID_AR, ID_AC, ID_BR, ID_PA, ID_GD, ID_LS, ID_LP) || \
95          ELEM(GS((_id)->name), ID_SCR, ID_WM, ID_TXT, ID_VF, ID_SO, ID_CF, ID_PAL, ID_MC, ID_WS))  /* Only in 'blendfile' mode ... :/ */
96
97 /* TreeElement->flag */
98 enum {
99         TE_ACTIVE      = (1 << 0),
100         /* Closed items display their children as icon within the row. TE_ICONROW is for
101          * these child-items that are visible but only within the row of the closed parent. */
102         TE_ICONROW     = (1 << 1),
103         TE_LAZY_CLOSED = (1 << 2),
104         TE_FREE_NAME   = (1 << 3),
105         TE_DISABLED    = (1 << 4),
106         TE_DRAGGING    = (1 << 5),
107 };
108
109 /* button events */
110 #define OL_NAMEBUTTON       1
111
112 typedef enum {
113         OL_DRAWSEL_NONE    = 0,  /* inactive (regular black text) */
114         OL_DRAWSEL_NORMAL  = 1,  /* active object (draws white text) */
115         OL_DRAWSEL_ACTIVE  = 2,  /* active obdata (draws a circle around the icon) */
116 } eOLDrawState;
117
118 typedef enum {
119         OL_SETSEL_NONE     = 0,  /* don't change the selection state */
120         OL_SETSEL_NORMAL   = 1,  /* select the item */
121         OL_SETSEL_EXTEND   = 2,  /* select the item and extend (also toggles selection) */
122 } eOLSetState;
123
124 /* get TreeStoreElem associated with a TreeElement
125  * < a: (TreeElement) tree element to find stored element for
126  */
127 #define TREESTORE(a) ((a)->store_elem)
128
129 /* size constants */
130 #define OL_Y_OFFSET 2
131
132 #define OL_TOG_HIDEX            (UI_UNIT_X * 4.0f)
133 #define OL_TOG_RESTRICT_SELECTX (UI_UNIT_X * 3.0f)
134 #define OL_TOG_RESTRICT_VIEWX   (UI_UNIT_X * 2.0f)
135 #define OL_TOG_RESTRICT_RENDERX UI_UNIT_X
136
137 #define OL_TOGW OL_TOG_HIDEX
138
139 #define OL_RNA_COLX         (UI_UNIT_X * 15)
140 #define OL_RNA_COL_SIZEX    (UI_UNIT_X * 7.5f)
141 #define OL_RNA_COL_SPACEX   (UI_UNIT_X * 2.5f)
142
143 /* The outliner display modes that support the filter system.
144  * Note: keep it synced with space_outliner.py */
145 #define SUPPORT_FILTER_OUTLINER(soops_) (ELEM((soops_)->outlinevis, SO_VIEW_LAYER))
146
147 /* Outliner Searching --
148  *
149  * Are we looking for something in the outliner?
150  * If so finding matches in child items makes it more useful
151  *
152  * - We want to flag parents to act as being open to filter child matches
153  * - and also flag matches so we can highlight them
154  * - Flags are stored in TreeStoreElem->flag
155  * - Flag options defined in DNA_outliner_types.h
156  * - SO_SEARCH_RECURSIVE defined in DNA_space_types.h
157  *
158  * - NOT in datablocks view - searching all datablocks takes way too long
159  *   to be useful
160  * - not searching into RNA items helps but isn't the complete solution
161  */
162
163 #define SEARCHING_OUTLINER(sov)   (sov->search_flags & SO_SEARCH_RECURSIVE)
164
165 /* is the currrent element open? if so we also show children */
166 #define TSELEM_OPEN(telm, sv)    ( (telm->flag & TSE_CLOSED) == 0 || (SEARCHING_OUTLINER(sv) && (telm->flag & TSE_CHILDSEARCH)) )
167
168 /* outliner_tree.c ----------------------------------------------- */
169
170 void outliner_free_tree(ListBase *tree);
171 void outliner_cleanup_tree(struct SpaceOops *soops);
172 void outliner_free_tree_element(TreeElement *element, ListBase *parent_subtree);
173
174 void outliner_build_tree(
175         struct Main *mainvar,
176         struct Scene *scene, struct ViewLayer *view_layer,
177         struct SpaceOops *soops, struct ARegion *ar);
178
179 typedef struct ObjectsSelectedData {
180         struct ListBase objects_selected_array;
181 } ObjectsSelectedData;
182
183 TreeTraversalAction outliner_find_selected_objects(struct TreeElement *te, void *customdata);
184
185 /* outliner_draw.c ---------------------------------------------- */
186
187 void draw_outliner(const struct bContext *C);
188 void restrictbutton_gr_restrict_flag(void *poin, void *poin2, int flag);
189
190 TreeElementIcon tree_element_get_icon(TreeStoreElem *tselem, TreeElement *te);
191
192 /* outliner_select.c -------------------------------------------- */
193 eOLDrawState tree_element_type_active(
194         struct bContext *C, struct Scene *scene, struct ViewLayer *view_layer, struct SpaceOops *soops,
195         TreeElement *te, TreeStoreElem *tselem, const eOLSetState set, bool recursive);
196 eOLDrawState tree_element_active(struct bContext *C, struct Scene *scene, struct ViewLayer *view_layer, SpaceOops *soops,
197                                  TreeElement *te, const eOLSetState set, const bool handle_all_types);
198
199 void outliner_item_do_activate_from_tree_element(
200         struct bContext *C, TreeElement *te, TreeStoreElem *tselem,
201         bool extend, bool recursive);
202 int outliner_item_do_activate_from_cursor(
203         struct bContext *C, const int mval[2],
204         bool extend, bool recursive);
205
206 void outliner_item_select(
207         struct SpaceOops *soops, const struct TreeElement *te,
208         const bool extend, const bool toggle);
209
210 void outliner_object_mode_toggle(
211         struct bContext *C, Scene *scene, ViewLayer *view_layer,
212         Base *base);
213
214 /* outliner_edit.c ---------------------------------------------- */
215 typedef void (*outliner_operation_cb)(
216         struct bContext *C, struct ReportList *, struct Scene *scene,
217         struct TreeElement *, struct TreeStoreElem *, TreeStoreElem *, void *);
218
219 void outliner_do_object_operation_ex(
220         struct bContext *C, struct ReportList *reports, struct Scene *scene, struct SpaceOops *soops,
221         struct ListBase *lb, outliner_operation_cb operation_cb, bool recurse_selected);
222 void outliner_do_object_operation(
223         struct bContext *C, struct ReportList *reports, struct Scene *scene, struct SpaceOops *soops,
224         struct ListBase *lb, outliner_operation_cb operation_cb);
225
226 int common_restrict_check(struct bContext *C, struct Object *ob);
227
228 int outliner_flag_is_any_test(ListBase *lb, short flag, const int curlevel);
229 bool outliner_flag_set(ListBase *lb, short flag, short set);
230 bool outliner_flag_flip(ListBase *lb, short flag);
231
232 void object_toggle_visibility_cb(
233         struct bContext *C, struct ReportList *reports, struct Scene *scene,
234         TreeElement *te, struct TreeStoreElem *tsep, struct TreeStoreElem *tselem, void *user_data);
235 void object_toggle_selectability_cb(
236         struct bContext *C, struct ReportList *reports, struct Scene *scene,
237         TreeElement *te, struct TreeStoreElem *tsep, struct TreeStoreElem *tselem, void *user_data);
238 void object_toggle_renderability_cb(
239         struct bContext *C, struct ReportList *reports, struct Scene *scene,
240         TreeElement *te, struct TreeStoreElem *tsep, struct TreeStoreElem *tselem, void *user_data);
241
242
243 void item_rename_cb(
244         struct bContext *C, struct ReportList *reports, struct Scene *scene,
245         TreeElement *te, struct TreeStoreElem *tsep, struct TreeStoreElem *tselem, void *user_data);
246 void lib_relocate_cb(
247         struct bContext *C, struct ReportList *reports, struct Scene *scene, struct TreeElement *te,
248         struct TreeStoreElem *tsep, struct TreeStoreElem *tselem, void *user_data);
249 void lib_reload_cb(
250         struct bContext *C, struct ReportList *reports, struct Scene *scene, struct TreeElement *te,
251         struct TreeStoreElem *tsep, struct TreeStoreElem *tselem, void *user_data);
252
253 void id_delete_cb(
254         struct bContext *C, struct ReportList *reports, struct Scene *scene, struct TreeElement *te,
255         struct TreeStoreElem *tsep, struct TreeStoreElem *tselem, void *user_data);
256 void id_remap_cb(
257         struct bContext *C, struct ReportList *reports, struct Scene *scene, struct TreeElement *te,
258         struct TreeStoreElem *tsep, struct TreeStoreElem *tselem, void *user_data);
259
260 void item_object_mode_enter_cb(
261         struct bContext *C, struct ReportList *reports, struct Scene *scene,
262         TreeElement *te, struct TreeStoreElem *tsep, struct TreeStoreElem *tselem, void *user_data);
263 void item_object_mode_exit_cb(
264         struct bContext *C, struct ReportList *reports, struct Scene *scene,
265         TreeElement *te, struct TreeStoreElem *tsep, struct TreeStoreElem *tselem, void *user_data);
266
267 void outliner_set_coordinates(struct ARegion *ar, struct SpaceOops *soops);
268
269 /* outliner_dragdrop.c */
270 void outliner_dropboxes(void);
271
272 void OUTLINER_OT_item_drag_drop(struct wmOperatorType *ot);
273 void OUTLINER_OT_parent_drop(struct wmOperatorType *ot);
274 void OUTLINER_OT_parent_clear(struct wmOperatorType *ot);
275 void OUTLINER_OT_scene_drop(struct wmOperatorType *ot);
276 void OUTLINER_OT_material_drop(struct wmOperatorType *ot);
277 void OUTLINER_OT_collection_drop(struct wmOperatorType *ot);
278
279 /* ...................................................... */
280
281 void OUTLINER_OT_highlight_update(struct wmOperatorType *ot);
282
283 void OUTLINER_OT_item_activate(struct wmOperatorType *ot);
284 void OUTLINER_OT_item_openclose(struct wmOperatorType *ot);
285 void OUTLINER_OT_item_rename(struct wmOperatorType *ot);
286 void OUTLINER_OT_lib_relocate(struct wmOperatorType *ot);
287 void OUTLINER_OT_lib_reload(struct wmOperatorType *ot);
288
289 void OUTLINER_OT_id_delete(struct wmOperatorType *ot);
290
291 void OUTLINER_OT_show_one_level(struct wmOperatorType *ot);
292 void OUTLINER_OT_show_active(struct wmOperatorType *ot);
293 void OUTLINER_OT_show_hierarchy(struct wmOperatorType *ot);
294
295 void OUTLINER_OT_select_border(struct wmOperatorType *ot);
296
297 void OUTLINER_OT_select_all(struct wmOperatorType *ot);
298 void OUTLINER_OT_expanded_toggle(struct wmOperatorType *ot);
299
300 void OUTLINER_OT_scroll_page(struct wmOperatorType *ot);
301
302 void OUTLINER_OT_keyingset_add_selected(struct wmOperatorType *ot);
303 void OUTLINER_OT_keyingset_remove_selected(struct wmOperatorType *ot);
304
305 void OUTLINER_OT_drivers_add_selected(struct wmOperatorType *ot);
306 void OUTLINER_OT_drivers_delete_selected(struct wmOperatorType *ot);
307
308 void OUTLINER_OT_orphans_purge(struct wmOperatorType *ot);
309
310 /* outliner_tools.c ---------------------------------------------- */
311
312 void OUTLINER_OT_operation(struct wmOperatorType *ot);
313 void OUTLINER_OT_scene_operation(struct wmOperatorType *ot);
314 void OUTLINER_OT_object_operation(struct wmOperatorType *ot);
315 void OUTLINER_OT_lib_operation(struct wmOperatorType *ot);
316 void OUTLINER_OT_id_operation(struct wmOperatorType *ot);
317 void OUTLINER_OT_id_remap(struct wmOperatorType *ot);
318 void OUTLINER_OT_data_operation(struct wmOperatorType *ot);
319 void OUTLINER_OT_animdata_operation(struct wmOperatorType *ot);
320 void OUTLINER_OT_action_set(struct wmOperatorType *ot);
321 void OUTLINER_OT_constraint_operation(struct wmOperatorType *ot);
322 void OUTLINER_OT_modifier_operation(struct wmOperatorType *ot);
323
324 /* ---------------------------------------------------------------- */
325
326 /* outliner_ops.c */
327 void outliner_operatortypes(void);
328 void outliner_keymap(struct wmKeyConfig *keyconf);
329
330 /* outliner_collections.c */
331
332 bool outliner_is_collection_tree_element(const TreeElement *te);
333 struct Collection *outliner_collection_from_tree_element(const TreeElement *te);
334
335 void OUTLINER_OT_collection_new(struct wmOperatorType *ot);
336 void OUTLINER_OT_collection_duplicate(struct wmOperatorType *ot);
337 void OUTLINER_OT_collection_delete(struct wmOperatorType *ot);
338 void OUTLINER_OT_collection_objects_select(struct wmOperatorType *ot);
339 void OUTLINER_OT_collection_objects_deselect(struct wmOperatorType *ot);
340 void OUTLINER_OT_collection_link(struct wmOperatorType *ot);
341 void OUTLINER_OT_collection_instance(struct wmOperatorType *ot);
342 void OUTLINER_OT_collection_exclude_set(struct wmOperatorType *ot);
343 void OUTLINER_OT_collection_exclude_clear(struct wmOperatorType *ot);
344 void OUTLINER_OT_collection_holdout_set(struct wmOperatorType *ot);
345 void OUTLINER_OT_collection_holdout_clear(struct wmOperatorType *ot);
346 void OUTLINER_OT_collection_indirect_only_set(struct wmOperatorType *ot);
347 void OUTLINER_OT_collection_indirect_only_clear(struct wmOperatorType *ot);
348
349 /* outliner_utils.c ---------------------------------------------- */
350
351 TreeElement *outliner_find_item_at_y(const SpaceOops *soops, const ListBase *tree, float view_co_y);
352 TreeElement *outliner_find_item_at_x_in_row(const SpaceOops *soops, const TreeElement *parent_te, float view_co_x);
353 TreeElement *outliner_find_tse(struct SpaceOops *soops, const TreeStoreElem *tse);
354 TreeElement *outliner_find_tree_element(ListBase *lb, const TreeStoreElem *store_elem);
355 TreeElement *outliner_find_parent_element(ListBase *lb, TreeElement *parent_te, const TreeElement *child_te);
356 TreeElement *outliner_find_id(struct SpaceOops *soops, ListBase *lb, const struct ID *id);
357 TreeElement *outliner_find_posechannel(ListBase *lb, const struct bPoseChannel *pchan);
358 TreeElement *outliner_find_editbone(ListBase *lb, const struct EditBone *ebone);
359 struct ID *outliner_search_back(SpaceOops *soops, TreeElement *te, short idcode);
360 bool outliner_tree_traverse(const SpaceOops *soops, ListBase *tree, int filter_te_flag, int filter_tselem_flag,
361                             TreeTraversalFunc func, void *customdata);
362
363
364 #endif /* __OUTLINER_INTERN_H__ */