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 /**
71  * Callback type for reinserting elements at a different position, used to allow user customizable element order.
72  */
73 typedef void (*TreeElementReinsertFunc)(struct Main *bmain,
74                                         struct Scene *scene,
75                                         struct SpaceOops *soops,
76                                         struct TreeElement *insert_element,
77                                         struct TreeElement *insert_handle,
78                                         TreeElementInsertType action,
79                                         const struct wmEvent *event);
80 /**
81  * Executed on (almost) each mouse move while dragging. It's supposed to give info
82  * if reinserting insert_element before/after/into insert_handle would be allowed.
83  * It's allowed to change the reinsert info here for non const pointers.
84  */
85 typedef bool (*TreeElementReinsertPollFunc)(const struct TreeElement *insert_element,
86                                             struct TreeElement **io_insert_handle, TreeElementInsertType *io_action);
87 typedef TreeTraversalAction (*TreeTraversalFunc)(struct TreeElement *te, void *customdata);
88
89
90 typedef struct TreeElement {
91         struct TreeElement *next, *prev, *parent;
92         ListBase subtree;
93         int xs, ys;                // do selection
94         TreeStoreElem *store_elem; // element in tree store
95         short flag;                // flag for non-saved stuff
96         short index;               // index for data arrays
97         short idcode;              // from TreeStore id
98         short xend;                // width of item display, for select
99         const char *name;
100         void *directdata;          // Armature Bones, Base, Sequence, Strip...
101         PointerRNA rnaptr;         // RNA Pointer
102
103         /* callbacks - TODO should be moved into a type (like TreeElementType) */
104         TreeElementReinsertFunc reinsert;
105         TreeElementReinsertPollFunc reinsert_poll;
106
107         struct {
108                 TreeElementInsertType insert_type;
109                 /* the element before/after/into which we may insert the dragged one (NULL to insert at top) */
110                 struct TreeElement *insert_handle;
111                 void *tooltip_draw_handle;
112         } *drag_data;
113 } TreeElement;
114
115 #define TREESTORE_ID_TYPE(_id) \
116         (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) || \
117          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) || \
118          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 ... :/ */
119
120 /* TreeElement->flag */
121 enum {
122         TE_ACTIVE      = (1 << 0),
123         /* Closed items display their children as icon within the row. TE_ICONROW is for
124          * these child-items that are visible but only within the row of the closed parent. */
125         TE_ICONROW     = (1 << 1),
126         TE_LAZY_CLOSED = (1 << 2),
127         TE_FREE_NAME   = (1 << 3),
128         TE_DISABLED    = (1 << 4),
129 };
130
131 /* button events */
132 #define OL_NAMEBUTTON       1
133
134 typedef enum {
135         OL_DRAWSEL_NONE    = 0,  /* inactive (regular black text) */
136         OL_DRAWSEL_NORMAL  = 1,  /* active object (draws white text) */
137         OL_DRAWSEL_ACTIVE  = 2,  /* active obdata (draws a circle around the icon) */
138 } eOLDrawState;
139
140 typedef enum {
141         OL_SETSEL_NONE     = 0,  /* don't change the selection state */
142         OL_SETSEL_NORMAL   = 1,  /* select the item */
143         OL_SETSEL_EXTEND   = 2,  /* select the item and extend (also toggles selection) */
144 } eOLSetState;
145
146 /* get TreeStoreElem associated with a TreeElement
147  * < a: (TreeElement) tree element to find stored element for
148  */
149 #define TREESTORE(a) ((a)->store_elem)
150
151 /* size constants */
152 #define OL_Y_OFFSET 2
153
154 #define OL_TOG_HIDEX            (UI_UNIT_X * 4.0f)
155 #define OL_TOG_RESTRICT_SELECTX (UI_UNIT_X * 3.0f)
156 #define OL_TOG_RESTRICT_VIEWX   (UI_UNIT_X * 2.0f)
157 #define OL_TOG_RESTRICT_RENDERX UI_UNIT_X
158
159 #define OL_TOGW OL_TOG_HIDEX
160
161 #define OL_RNA_COLX         (UI_UNIT_X * 15)
162 #define OL_RNA_COL_SIZEX    (UI_UNIT_X * 7.5f)
163 #define OL_RNA_COL_SPACEX   (UI_UNIT_X * 2.5f)
164
165 /* The outliner display modes that support the filter system.
166  * Note: keep it synced with space_outliner.py */
167 #define SUPPORT_FILTER_OUTLINER(soops_) (ELEM((soops_)->outlinevis, SO_VIEW_LAYER))
168
169 /* Outliner Searching --
170  *
171  * Are we looking for something in the outliner?
172  * If so finding matches in child items makes it more useful
173  *
174  * - We want to flag parents to act as being open to filter child matches
175  * - and also flag matches so we can highlight them
176  * - Flags are stored in TreeStoreElem->flag
177  * - Flag options defined in DNA_outliner_types.h
178  * - SO_SEARCH_RECURSIVE defined in DNA_space_types.h
179  *
180  * - NOT in datablocks view - searching all datablocks takes way too long
181  *   to be useful
182  * - not searching into RNA items helps but isn't the complete solution
183  */
184
185 #define SEARCHING_OUTLINER(sov)   (sov->search_flags & SO_SEARCH_RECURSIVE)
186
187 /* is the currrent element open? if so we also show children */
188 #define TSELEM_OPEN(telm, sv)    ( (telm->flag & TSE_CLOSED) == 0 || (SEARCHING_OUTLINER(sv) && (telm->flag & TSE_CHILDSEARCH)) )
189
190 /* outliner_tree.c ----------------------------------------------- */
191
192 void outliner_free_tree(ListBase *tree);
193 void outliner_cleanup_tree(struct SpaceOops *soops);
194 void outliner_free_tree_element(TreeElement *element, ListBase *parent_subtree);
195
196 void outliner_build_tree(
197         struct Main *mainvar,
198         struct Scene *scene, struct ViewLayer *view_layer,
199         struct SpaceOops *soops, struct ARegion *ar);
200
201 typedef struct ObjectsSelectedData {
202         struct ListBase objects_selected_array;
203 } ObjectsSelectedData;
204
205 TreeTraversalAction outliner_find_selected_objects(struct TreeElement *te, void *customdata);
206
207 /* outliner_draw.c ---------------------------------------------- */
208
209 void draw_outliner(const struct bContext *C);
210 void restrictbutton_gr_restrict_flag(void *poin, void *poin2, int flag);
211
212 /* outliner_select.c -------------------------------------------- */
213 eOLDrawState tree_element_type_active(
214         struct bContext *C, struct Scene *scene, struct ViewLayer *view_layer, struct SpaceOops *soops,
215         TreeElement *te, TreeStoreElem *tselem, const eOLSetState set, bool recursive);
216 eOLDrawState tree_element_active(struct bContext *C, struct Scene *scene, struct ViewLayer *view_layer, SpaceOops *soops,
217                                  TreeElement *te, const eOLSetState set, const bool handle_all_types);
218
219 void outliner_item_do_activate_from_tree_element(
220         struct bContext *C, TreeElement *te, TreeStoreElem *tselem,
221         bool extend, bool recursive);
222 int outliner_item_do_activate_from_cursor(
223         struct bContext *C, const int mval[2],
224         bool extend, bool recursive);
225
226 void outliner_item_select(
227         struct SpaceOops *soops, const struct TreeElement *te,
228         const bool extend, const bool toggle);
229
230 void outliner_object_mode_toggle(
231         struct bContext *C, Scene *scene, ViewLayer *view_layer,
232         Base *base);
233
234 /* outliner_edit.c ---------------------------------------------- */
235 typedef void (*outliner_operation_cb)(
236         struct bContext *C, struct ReportList *, struct Scene *scene,
237         struct TreeElement *, struct TreeStoreElem *, TreeStoreElem *, void *);
238
239 void outliner_do_object_operation_ex(
240         struct bContext *C, struct ReportList *reports, struct Scene *scene, struct SpaceOops *soops,
241         struct ListBase *lb, outliner_operation_cb operation_cb, bool recurse_selected);
242 void outliner_do_object_operation(
243         struct bContext *C, struct ReportList *reports, struct Scene *scene, struct SpaceOops *soops,
244         struct ListBase *lb, outliner_operation_cb operation_cb);
245
246 int common_restrict_check(struct bContext *C, struct Object *ob);
247
248 int outliner_flag_is_any_test(ListBase *lb, short flag, const int curlevel);
249 bool outliner_flag_set(ListBase *lb, short flag, short set);
250
251 void object_toggle_visibility_cb(
252         struct bContext *C, struct ReportList *reports, struct Scene *scene,
253         TreeElement *te, struct TreeStoreElem *tsep, struct TreeStoreElem *tselem, void *user_data);
254 void object_toggle_selectability_cb(
255         struct bContext *C, struct ReportList *reports, struct Scene *scene,
256         TreeElement *te, struct TreeStoreElem *tsep, struct TreeStoreElem *tselem, void *user_data);
257 void object_toggle_renderability_cb(
258         struct bContext *C, struct ReportList *reports, struct Scene *scene,
259         TreeElement *te, struct TreeStoreElem *tsep, struct TreeStoreElem *tselem, void *user_data);
260
261
262 void item_rename_cb(
263         struct bContext *C, struct ReportList *reports, struct Scene *scene,
264         TreeElement *te, struct TreeStoreElem *tsep, struct TreeStoreElem *tselem, void *user_data);
265 void lib_relocate_cb(
266         struct bContext *C, struct ReportList *reports, struct Scene *scene, struct TreeElement *te,
267         struct TreeStoreElem *tsep, struct TreeStoreElem *tselem, void *user_data);
268 void lib_reload_cb(
269         struct bContext *C, struct ReportList *reports, struct Scene *scene, struct TreeElement *te,
270         struct TreeStoreElem *tsep, struct TreeStoreElem *tselem, void *user_data);
271
272 void id_delete_cb(
273         struct bContext *C, struct ReportList *reports, struct Scene *scene, struct TreeElement *te,
274         struct TreeStoreElem *tsep, struct TreeStoreElem *tselem, void *user_data);
275 void id_remap_cb(
276         struct bContext *C, struct ReportList *reports, struct Scene *scene, struct TreeElement *te,
277         struct TreeStoreElem *tsep, struct TreeStoreElem *tselem, void *user_data);
278
279 void item_object_mode_enter_cb(
280         struct bContext *C, struct ReportList *reports, struct Scene *scene,
281         TreeElement *te, struct TreeStoreElem *tsep, struct TreeStoreElem *tselem, void *user_data);
282 void item_object_mode_exit_cb(
283         struct bContext *C, struct ReportList *reports, struct Scene *scene,
284         TreeElement *te, struct TreeStoreElem *tsep, struct TreeStoreElem *tselem, void *user_data);
285
286 TreeElement *outliner_dropzone_find(const struct SpaceOops *soops, const float fmval[2], const bool children);
287
288 void outliner_set_coordinates(struct ARegion *ar, struct SpaceOops *soops);
289
290 /* ...................................................... */
291
292 void OUTLINER_OT_highlight_update(struct wmOperatorType *ot);
293
294 void OUTLINER_OT_item_activate(struct wmOperatorType *ot);
295 void OUTLINER_OT_item_openclose(struct wmOperatorType *ot);
296 void OUTLINER_OT_item_rename(struct wmOperatorType *ot);
297 void OUTLINER_OT_lib_relocate(struct wmOperatorType *ot);
298 void OUTLINER_OT_lib_reload(struct wmOperatorType *ot);
299
300 void OUTLINER_OT_id_delete(struct wmOperatorType *ot);
301
302 void OUTLINER_OT_show_one_level(struct wmOperatorType *ot);
303 void OUTLINER_OT_show_active(struct wmOperatorType *ot);
304 void OUTLINER_OT_show_hierarchy(struct wmOperatorType *ot);
305
306 void OUTLINER_OT_select_border(struct wmOperatorType *ot);
307
308 void OUTLINER_OT_selected_toggle(struct wmOperatorType *ot);
309 void OUTLINER_OT_expanded_toggle(struct wmOperatorType *ot);
310
311 void OUTLINER_OT_scroll_page(struct wmOperatorType *ot);
312
313 void OUTLINER_OT_keyingset_add_selected(struct wmOperatorType *ot);
314 void OUTLINER_OT_keyingset_remove_selected(struct wmOperatorType *ot);
315
316 void OUTLINER_OT_drivers_add_selected(struct wmOperatorType *ot);
317 void OUTLINER_OT_drivers_delete_selected(struct wmOperatorType *ot);
318
319 void OUTLINER_OT_orphans_purge(struct wmOperatorType *ot);
320
321 void OUTLINER_OT_parent_drop(struct wmOperatorType *ot);
322 void OUTLINER_OT_parent_clear(struct wmOperatorType *ot);
323 void OUTLINER_OT_scene_drop(struct wmOperatorType *ot);
324 void OUTLINER_OT_material_drop(struct wmOperatorType *ot);
325 void OUTLINER_OT_collection_drop(struct wmOperatorType *ot);
326
327 /* outliner_tools.c ---------------------------------------------- */
328
329 void OUTLINER_OT_operation(struct wmOperatorType *ot);
330 void OUTLINER_OT_scene_operation(struct wmOperatorType *ot);
331 void OUTLINER_OT_object_operation(struct wmOperatorType *ot);
332 void OUTLINER_OT_lib_operation(struct wmOperatorType *ot);
333 void OUTLINER_OT_id_operation(struct wmOperatorType *ot);
334 void OUTLINER_OT_id_remap(struct wmOperatorType *ot);
335 void OUTLINER_OT_data_operation(struct wmOperatorType *ot);
336 void OUTLINER_OT_animdata_operation(struct wmOperatorType *ot);
337 void OUTLINER_OT_action_set(struct wmOperatorType *ot);
338 void OUTLINER_OT_constraint_operation(struct wmOperatorType *ot);
339 void OUTLINER_OT_modifier_operation(struct wmOperatorType *ot);
340
341 /* ---------------------------------------------------------------- */
342
343 /* outliner_ops.c */
344 void outliner_operatortypes(void);
345 void outliner_keymap(struct wmKeyConfig *keyconf);
346
347 /* outliner_collections.c */
348
349 bool outliner_is_collection_tree_element(const TreeElement *te);
350 struct Collection *outliner_collection_from_tree_element(const TreeElement *te);
351
352 void OUTLINER_OT_collection_new(struct wmOperatorType *ot);
353 void OUTLINER_OT_collection_duplicate(struct wmOperatorType *ot);
354 void OUTLINER_OT_collection_delete(struct wmOperatorType *ot);
355 void OUTLINER_OT_collection_objects_select(struct wmOperatorType *ot);
356 void OUTLINER_OT_collection_objects_deselect(struct wmOperatorType *ot);
357 void OUTLINER_OT_collection_link(struct wmOperatorType *ot);
358 void OUTLINER_OT_collection_instance(struct wmOperatorType *ot);
359 void OUTLINER_OT_collection_exclude_set(struct wmOperatorType *ot);
360 void OUTLINER_OT_collection_include_set(struct wmOperatorType *ot);
361
362 /* outliner_utils.c ---------------------------------------------- */
363
364 TreeElement *outliner_find_item_at_y(const SpaceOops *soops, const ListBase *tree, float view_co_y);
365 TreeElement *outliner_find_item_at_x_in_row(const SpaceOops *soops, const TreeElement *parent_te, float view_co_x);
366 TreeElement *outliner_find_tse(struct SpaceOops *soops, const TreeStoreElem *tse);
367 TreeElement *outliner_find_tree_element(ListBase *lb, const TreeStoreElem *store_elem);
368 TreeElement *outliner_find_parent_element(ListBase *lb, TreeElement *parent_te, const TreeElement *child_te);
369 TreeElement *outliner_find_id(struct SpaceOops *soops, ListBase *lb, const struct ID *id);
370 TreeElement *outliner_find_posechannel(ListBase *lb, const struct bPoseChannel *pchan);
371 TreeElement *outliner_find_editbone(ListBase *lb, const struct EditBone *ebone);
372 struct ID *outliner_search_back(SpaceOops *soops, TreeElement *te, short idcode);
373 bool outliner_tree_traverse(const SpaceOops *soops, ListBase *tree, int filter_te_flag, int filter_tselem_flag,
374                             TreeTraversalFunc func, void *customdata);
375
376
377 #endif /* __OUTLINER_INTERN_H__ */