msvc: Fix build error with msvc 2017
[blender.git] / source / blender / editors / space_outliner / outliner_intern.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) 2008 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup spoutliner
22  */
23
24 #pragma once
25
26 #include "RNA_types.h"
27
28 /* internal exports only */
29
30 struct ARegion;
31 struct EditBone;
32 struct ID;
33 struct ListBase;
34 struct Main;
35 struct Object;
36 struct Scene;
37 struct TreeElement;
38 struct TreeStoreElem;
39 struct ViewLayer;
40 struct bContext;
41 struct bPoseChannel;
42 struct wmKeyConfig;
43 struct wmOperatorType;
44
45 typedef enum TreeElementInsertType {
46   TE_INSERT_BEFORE,
47   TE_INSERT_AFTER,
48   TE_INSERT_INTO,
49 } TreeElementInsertType;
50
51 typedef enum TreeTraversalAction {
52   /** Continue traversal regularly, don't skip children. */
53   TRAVERSE_CONTINUE = 0,
54   /** Stop traversal. */
55   TRAVERSE_BREAK,
56   /** Continue traversal, but skip children of traversed element. */
57   TRAVERSE_SKIP_CHILDS,
58 } TreeTraversalAction;
59
60 typedef TreeTraversalAction (*TreeTraversalFunc)(struct TreeElement *te, void *customdata);
61
62 typedef struct TreeElement {
63   struct TreeElement *next, *prev, *parent;
64   ListBase subtree;
65   int xs, ys;                /* Do selection. */
66   TreeStoreElem *store_elem; /* Element in tree store. */
67   short flag;                /* Flag for non-saved stuff. */
68   short index;               /* Index for data arrays. */
69   short idcode;              /* From TreeStore id. */
70   short xend;                /* Width of item display, for select. */
71   const char *name;
72   void *directdata;  /* Armature Bones, Base, Sequence, Strip... */
73   PointerRNA rnaptr; /* RNA Pointer. */
74 } TreeElement;
75
76 typedef struct TreeElementIcon {
77   struct ID *drag_id, *drag_parent;
78   int icon;
79 } TreeElementIcon;
80
81 #define TREESTORE_ID_TYPE(_id) \
82   (ELEM(GS((_id)->name), \
83         ID_SCE, \
84         ID_LI, \
85         ID_OB, \
86         ID_ME, \
87         ID_CU, \
88         ID_MB, \
89         ID_NT, \
90         ID_MA, \
91         ID_TE, \
92         ID_IM, \
93         ID_LT, \
94         ID_LA, \
95         ID_CA) || \
96    ELEM(GS((_id)->name), \
97         ID_KE, \
98         ID_WO, \
99         ID_SPK, \
100         ID_GR, \
101         ID_AR, \
102         ID_AC, \
103         ID_BR, \
104         ID_PA, \
105         ID_GD, \
106         ID_LS, \
107         ID_LP, \
108         ID_HA, \
109         ID_PT, \
110         ID_VO, \
111         ID_SIM) || /* Only in 'blendfile' mode ... :/ */ \
112    ELEM(GS((_id)->name), \
113         ID_SCR, \
114         ID_WM, \
115         ID_TXT, \
116         ID_VF, \
117         ID_SO, \
118         ID_CF, \
119         ID_PAL, \
120         ID_MC, \
121         ID_WS, \
122         ID_MSK, \
123         ID_PC))
124
125 /* TreeElement->flag */
126 enum {
127   TE_ACTIVE = (1 << 0),
128   /* Closed items display their children as icon within the row. TE_ICONROW is for
129    * these child-items that are visible but only within the row of the closed parent. */
130   TE_ICONROW = (1 << 1),
131   TE_LAZY_CLOSED = (1 << 2),
132   TE_FREE_NAME = (1 << 3),
133   TE_DISABLED = (1 << 4),
134   TE_DRAGGING = (1 << 5),
135   TE_CHILD_NOT_IN_COLLECTION = (1 << 6),
136   /* Child elements of the same type in the icon-row are drawn merged as one icon.
137    * This flag is set for an element that is part of these merged child icons. */
138   TE_ICONROW_MERGED = (1 << 7),
139 };
140
141 /* button events */
142 #define OL_NAMEBUTTON 1
143
144 typedef enum {
145   OL_DRAWSEL_NONE = 0,   /* inactive (regular black text) */
146   OL_DRAWSEL_NORMAL = 1, /* active object (draws white text) */
147   OL_DRAWSEL_ACTIVE = 2, /* active obdata (draws a circle around the icon) */
148 } eOLDrawState;
149
150 typedef enum {
151   OL_SETSEL_NONE = 0,   /* don't change the selection state */
152   OL_SETSEL_NORMAL = 1, /* select the item */
153   OL_SETSEL_EXTEND = 2, /* select the item and extend (also toggles selection) */
154 } eOLSetState;
155
156 /* get TreeStoreElem associated with a TreeElement
157  * < a: (TreeElement) tree element to find stored element for
158  */
159 #define TREESTORE(a) ((a)->store_elem)
160
161 /* size constants */
162 #define OL_Y_OFFSET 2
163
164 #define OL_TOG_USER_BUTS_USERS (UI_UNIT_X * 2.0f + V2D_SCROLL_WIDTH)
165 #define OL_TOG_USER_BUTS_STATUS (UI_UNIT_X + V2D_SCROLL_WIDTH)
166
167 #define OL_RNA_COLX (UI_UNIT_X * 15)
168 #define OL_RNA_COL_SIZEX (UI_UNIT_X * 7.5f)
169 #define OL_RNA_COL_SPACEX (UI_UNIT_X * 2.5f)
170
171 /* The outliner display modes that support the filter system.
172  * Note: keep it synced with space_outliner.py */
173 #define SUPPORT_FILTER_OUTLINER(space_outliner_) \
174   (ELEM((space_outliner_)->outlinevis, SO_VIEW_LAYER))
175
176 /* Outliner Searching --
177  *
178  * Are we looking for something in the outliner?
179  * If so finding matches in child items makes it more useful
180  *
181  * - We want to flag parents to act as being open to filter child matches
182  * - and also flag matches so we can highlight them
183  * - Flags are stored in TreeStoreElem->flag
184  * - Flag options defined in DNA_outliner_types.h
185  * - SO_SEARCH_RECURSIVE defined in DNA_space_types.h
186  *
187  * - NOT in data-blocks view - searching all data-blocks takes way too long
188  *   to be useful
189  * - not searching into RNA items helps but isn't the complete solution
190  */
191
192 #define SEARCHING_OUTLINER(sov) (sov->search_flags & SO_SEARCH_RECURSIVE)
193
194 /* is the current element open? if so we also show children */
195 #define TSELEM_OPEN(telm, sv) \
196   (((telm)->flag & TSE_CLOSED) == 0 || \
197    (SEARCHING_OUTLINER(sv) && ((telm)->flag & TSE_CHILDSEARCH)))
198
199 /**
200  * Container to avoid passing around these variables to many functions.
201  * Also so we can have one place to assign these variables.
202  */
203 typedef struct TreeViewContext {
204   /* Scene level. */
205   struct Scene *scene;
206   struct ViewLayer *view_layer;
207
208   /* Object level. */
209   /** Avoid OBACT macro everywhere. */
210   Object *obact;
211   Object *ob_edit;
212   /**
213    * The pose object may not be the active object (when in weight paint mode).
214    * Checking this in draw loops isn't efficient, so set only once. */
215   Object *ob_pose;
216 } TreeViewContext;
217
218 typedef enum TreeItemSelectAction {
219   OL_ITEM_DESELECT = 0,           /* Deselect the item */
220   OL_ITEM_SELECT = (1 << 0),      /* Select the item */
221   OL_ITEM_SELECT_DATA = (1 << 1), /* Select object data */
222   OL_ITEM_ACTIVATE = (1 << 2),    /* Activate the item */
223   OL_ITEM_EXTEND = (1 << 3),      /* Extend the current selection */
224   OL_ITEM_RECURSIVE = (1 << 4),   /* Select recursively */
225   OL_ITEM_TOGGLE_MODE = (1 << 5)  /* Temporary */
226 } TreeItemSelectAction;
227
228 /* outliner_tree.c ----------------------------------------------- */
229
230 void outliner_free_tree(ListBase *tree);
231 void outliner_cleanup_tree(struct SpaceOutliner *space_outliner);
232 void outliner_free_tree_element(TreeElement *element, ListBase *parent_subtree);
233
234 void outliner_build_tree(struct Main *mainvar,
235                          struct Scene *scene,
236                          struct ViewLayer *view_layer,
237                          struct SpaceOutliner *space_outliner,
238                          struct ARegion *region);
239
240 bool outliner_element_needs_rebuild_on_open_change(const TreeStoreElem *tselem);
241
242 typedef struct IDsSelectedData {
243   struct ListBase selected_array;
244 } IDsSelectedData;
245
246 TreeTraversalAction outliner_find_selected_collections(struct TreeElement *te, void *customdata);
247 TreeTraversalAction outliner_find_selected_objects(struct TreeElement *te, void *customdata);
248
249 /* outliner_draw.c ---------------------------------------------- */
250
251 void draw_outliner(const struct bContext *C);
252
253 TreeElementIcon tree_element_get_icon(TreeStoreElem *tselem, TreeElement *te);
254
255 void outliner_collection_isolate_flag(struct Scene *scene,
256                                       struct ViewLayer *view_layer,
257                                       struct LayerCollection *layer_collection,
258                                       struct Collection *collection,
259                                       struct PropertyRNA *layer_or_collection_prop,
260                                       const char *propname,
261                                       const bool value);
262
263 int tree_element_id_type_to_index(TreeElement *te);
264
265 /* outliner_select.c -------------------------------------------- */
266 eOLDrawState tree_element_type_active(struct bContext *C,
267                                       const TreeViewContext *tvc,
268                                       struct SpaceOutliner *space_outliner,
269                                       TreeElement *te,
270                                       TreeStoreElem *tselem,
271                                       const eOLSetState set,
272                                       bool recursive);
273 eOLDrawState tree_element_active(struct bContext *C,
274                                  const TreeViewContext *tvc,
275                                  SpaceOutliner *space_outliner,
276                                  TreeElement *te,
277                                  const eOLSetState set,
278                                  const bool handle_all_types);
279
280 void outliner_item_select(struct bContext *C,
281                           struct SpaceOutliner *space_outliner,
282                           struct TreeElement *te,
283                           const short select_flag);
284
285 void outliner_object_mode_toggle(struct bContext *C,
286                                  Scene *scene,
287                                  ViewLayer *view_layer,
288                                  Base *base);
289
290 bool outliner_item_is_co_over_name_icons(const TreeElement *te, float view_co_x);
291 bool outliner_item_is_co_within_close_toggle(const TreeElement *te, float view_co_x);
292
293 /* outliner_edit.c ---------------------------------------------- */
294 typedef void (*outliner_operation_fn)(struct bContext *C,
295                                       struct ReportList *,
296                                       struct Scene *scene,
297                                       struct TreeElement *,
298                                       struct TreeStoreElem *,
299                                       TreeStoreElem *,
300                                       void *);
301
302 void outliner_do_object_operation_ex(struct bContext *C,
303                                      struct ReportList *reports,
304                                      struct Scene *scene,
305                                      struct SpaceOutliner *space_outliner,
306                                      struct ListBase *lb,
307                                      outliner_operation_fn operation_fn,
308                                      void *user_data,
309                                      bool recurse_selected);
310 void outliner_do_object_operation(struct bContext *C,
311                                   struct ReportList *reports,
312                                   struct Scene *scene,
313                                   struct SpaceOutliner *space_outliner,
314                                   struct ListBase *lb,
315                                   outliner_operation_fn operation_fn);
316
317 int common_restrict_check(struct bContext *C, struct Object *ob);
318
319 int outliner_flag_is_any_test(ListBase *lb, short flag, const int curlevel);
320 bool outliner_flag_set(ListBase *lb, short flag, short set);
321 bool outliner_flag_flip(ListBase *lb, short flag);
322
323 void item_rename_fn(struct bContext *C,
324                     struct ReportList *reports,
325                     struct Scene *scene,
326                     TreeElement *te,
327                     struct TreeStoreElem *tsep,
328                     struct TreeStoreElem *tselem,
329                     void *user_data);
330 void lib_relocate_fn(struct bContext *C,
331                      struct ReportList *reports,
332                      struct Scene *scene,
333                      struct TreeElement *te,
334                      struct TreeStoreElem *tsep,
335                      struct TreeStoreElem *tselem,
336                      void *user_data);
337 void lib_reload_fn(struct bContext *C,
338                    struct ReportList *reports,
339                    struct Scene *scene,
340                    struct TreeElement *te,
341                    struct TreeStoreElem *tsep,
342                    struct TreeStoreElem *tselem,
343                    void *user_data);
344
345 void id_delete_fn(struct bContext *C,
346                   struct ReportList *reports,
347                   struct Scene *scene,
348                   struct TreeElement *te,
349                   struct TreeStoreElem *tsep,
350                   struct TreeStoreElem *tselem,
351                   void *user_data);
352 void id_remap_fn(struct bContext *C,
353                  struct ReportList *reports,
354                  struct Scene *scene,
355                  struct TreeElement *te,
356                  struct TreeStoreElem *tsep,
357                  struct TreeStoreElem *tselem,
358                  void *user_data);
359
360 void item_object_mode_enter_fn(struct bContext *C,
361                                struct ReportList *reports,
362                                struct Scene *scene,
363                                TreeElement *te,
364                                struct TreeStoreElem *tsep,
365                                struct TreeStoreElem *tselem,
366                                void *user_data);
367 void item_object_mode_exit_fn(struct bContext *C,
368                               struct ReportList *reports,
369                               struct Scene *scene,
370                               TreeElement *te,
371                               struct TreeStoreElem *tsep,
372                               struct TreeStoreElem *tselem,
373                               void *user_data);
374
375 void outliner_set_coordinates(struct ARegion *region, struct SpaceOutliner *space_outliner);
376
377 void outliner_item_openclose(TreeElement *te, bool open, bool toggle_all);
378
379 /* outliner_dragdrop.c */
380 void outliner_dropboxes(void);
381
382 void OUTLINER_OT_item_drag_drop(struct wmOperatorType *ot);
383 void OUTLINER_OT_parent_drop(struct wmOperatorType *ot);
384 void OUTLINER_OT_parent_clear(struct wmOperatorType *ot);
385 void OUTLINER_OT_scene_drop(struct wmOperatorType *ot);
386 void OUTLINER_OT_material_drop(struct wmOperatorType *ot);
387 void OUTLINER_OT_collection_drop(struct wmOperatorType *ot);
388
389 /* ...................................................... */
390
391 void OUTLINER_OT_highlight_update(struct wmOperatorType *ot);
392
393 void OUTLINER_OT_item_activate(struct wmOperatorType *ot);
394 void OUTLINER_OT_item_openclose(struct wmOperatorType *ot);
395 void OUTLINER_OT_item_rename(struct wmOperatorType *ot);
396 void OUTLINER_OT_lib_relocate(struct wmOperatorType *ot);
397 void OUTLINER_OT_lib_reload(struct wmOperatorType *ot);
398
399 void OUTLINER_OT_id_delete(struct wmOperatorType *ot);
400
401 void OUTLINER_OT_show_one_level(struct wmOperatorType *ot);
402 void OUTLINER_OT_show_active(struct wmOperatorType *ot);
403 void OUTLINER_OT_show_hierarchy(struct wmOperatorType *ot);
404
405 void OUTLINER_OT_select_box(struct wmOperatorType *ot);
406 void OUTLINER_OT_select_walk(struct wmOperatorType *ot);
407
408 void OUTLINER_OT_select_all(struct wmOperatorType *ot);
409 void OUTLINER_OT_expanded_toggle(struct wmOperatorType *ot);
410
411 void OUTLINER_OT_scroll_page(struct wmOperatorType *ot);
412
413 void OUTLINER_OT_keyingset_add_selected(struct wmOperatorType *ot);
414 void OUTLINER_OT_keyingset_remove_selected(struct wmOperatorType *ot);
415
416 void OUTLINER_OT_drivers_add_selected(struct wmOperatorType *ot);
417 void OUTLINER_OT_drivers_delete_selected(struct wmOperatorType *ot);
418
419 void OUTLINER_OT_orphans_purge(struct wmOperatorType *ot);
420
421 /* outliner_tools.c ---------------------------------------------- */
422
423 void merged_element_search_menu_invoke(struct bContext *C,
424                                        TreeElement *parent_te,
425                                        TreeElement *activate_te);
426
427 void OUTLINER_OT_operation(struct wmOperatorType *ot);
428 void OUTLINER_OT_scene_operation(struct wmOperatorType *ot);
429 void OUTLINER_OT_object_operation(struct wmOperatorType *ot);
430 void OUTLINER_OT_lib_operation(struct wmOperatorType *ot);
431 void OUTLINER_OT_id_operation(struct wmOperatorType *ot);
432 void OUTLINER_OT_id_remap(struct wmOperatorType *ot);
433 void OUTLINER_OT_id_copy(struct wmOperatorType *ot);
434 void OUTLINER_OT_id_paste(struct wmOperatorType *ot);
435 void OUTLINER_OT_data_operation(struct wmOperatorType *ot);
436 void OUTLINER_OT_animdata_operation(struct wmOperatorType *ot);
437 void OUTLINER_OT_action_set(struct wmOperatorType *ot);
438 void OUTLINER_OT_constraint_operation(struct wmOperatorType *ot);
439 void OUTLINER_OT_modifier_operation(struct wmOperatorType *ot);
440 void OUTLINER_OT_delete(struct wmOperatorType *ot);
441
442 /* ---------------------------------------------------------------- */
443
444 /* outliner_ops.c */
445 void outliner_operatortypes(void);
446 void outliner_keymap(struct wmKeyConfig *keyconf);
447
448 /* outliner_collections.c */
449
450 bool outliner_is_collection_tree_element(const TreeElement *te);
451 struct Collection *outliner_collection_from_tree_element(const TreeElement *te);
452 void outliner_collection_delete(struct bContext *C,
453                                 struct Main *bmain,
454                                 struct Scene *scene,
455                                 struct ReportList *reports,
456                                 bool hierarchy);
457
458 void OUTLINER_OT_collection_new(struct wmOperatorType *ot);
459 void OUTLINER_OT_collection_duplicate_linked(struct wmOperatorType *ot);
460 void OUTLINER_OT_collection_duplicate(struct wmOperatorType *ot);
461 void OUTLINER_OT_collection_hierarchy_delete(struct wmOperatorType *ot);
462 void OUTLINER_OT_collection_objects_select(struct wmOperatorType *ot);
463 void OUTLINER_OT_collection_objects_deselect(struct wmOperatorType *ot);
464 void OUTLINER_OT_collection_link(struct wmOperatorType *ot);
465 void OUTLINER_OT_collection_instance(struct wmOperatorType *ot);
466 void OUTLINER_OT_collection_exclude_set(struct wmOperatorType *ot);
467 void OUTLINER_OT_collection_exclude_clear(struct wmOperatorType *ot);
468 void OUTLINER_OT_collection_holdout_set(struct wmOperatorType *ot);
469 void OUTLINER_OT_collection_holdout_clear(struct wmOperatorType *ot);
470 void OUTLINER_OT_collection_indirect_only_set(struct wmOperatorType *ot);
471 void OUTLINER_OT_collection_indirect_only_clear(struct wmOperatorType *ot);
472
473 void OUTLINER_OT_collection_isolate(struct wmOperatorType *ot);
474 void OUTLINER_OT_collection_show(struct wmOperatorType *ot);
475 void OUTLINER_OT_collection_hide(struct wmOperatorType *ot);
476 void OUTLINER_OT_collection_show_inside(struct wmOperatorType *ot);
477 void OUTLINER_OT_collection_hide_inside(struct wmOperatorType *ot);
478 void OUTLINER_OT_collection_enable(struct wmOperatorType *ot);
479 void OUTLINER_OT_collection_disable(struct wmOperatorType *ot);
480 void OUTLINER_OT_collection_enable_render(struct wmOperatorType *ot);
481 void OUTLINER_OT_collection_disable_render(struct wmOperatorType *ot);
482 void OUTLINER_OT_hide(struct wmOperatorType *ot);
483 void OUTLINER_OT_unhide_all(struct wmOperatorType *ot);
484
485 /* outliner_utils.c ---------------------------------------------- */
486
487 void outliner_viewcontext_init(const struct bContext *C, TreeViewContext *tvc);
488
489 TreeElement *outliner_find_item_at_y(const SpaceOutliner *space_outliner,
490                                      const ListBase *tree,
491                                      float view_co_y);
492 TreeElement *outliner_find_item_at_x_in_row(const SpaceOutliner *space_outliner,
493                                             const TreeElement *parent_te,
494                                             float view_co_x,
495                                             bool *multiple_objects);
496 TreeElement *outliner_find_tse(struct SpaceOutliner *space_outliner, const TreeStoreElem *tse);
497 TreeElement *outliner_find_tree_element(ListBase *lb, const TreeStoreElem *store_elem);
498 TreeElement *outliner_find_parent_element(ListBase *lb,
499                                           TreeElement *parent_te,
500                                           const TreeElement *child_te);
501 TreeElement *outliner_find_id(struct SpaceOutliner *space_outliner,
502                               ListBase *lb,
503                               const struct ID *id);
504 TreeElement *outliner_find_posechannel(ListBase *lb, const struct bPoseChannel *pchan);
505 TreeElement *outliner_find_editbone(ListBase *lb, const struct EditBone *ebone);
506 TreeElement *outliner_search_back_te(TreeElement *te, short idcode);
507 struct ID *outliner_search_back(TreeElement *te, short idcode);
508 bool outliner_tree_traverse(const SpaceOutliner *space_outliner,
509                             ListBase *tree,
510                             int filter_te_flag,
511                             int filter_tselem_flag,
512                             TreeTraversalFunc func,
513                             void *customdata);
514 float outliner_restrict_columns_width(const struct SpaceOutliner *space_outliner);
515 TreeElement *outliner_find_element_with_flag(const ListBase *lb, short flag);
516 bool outliner_is_element_visible(const TreeElement *te);
517 void outliner_scroll_view(struct ARegion *region, int delta_y);
518
519 /* outliner_sync.c ---------------------------------------------- */
520
521 void outliner_sync_selection(const struct bContext *C, struct SpaceOutliner *space_outliner);