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