Cleanup: use outliner_flag_* name prefix
[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 wmOperatorType;
40 struct TreeStoreElem;
41 struct bContext;
42 struct Scene;
43 struct ID;
44 struct Object;
45 struct bPoseChannel;
46 struct EditBone;
47
48 typedef struct TreeElement {
49         struct TreeElement *next, *prev, *parent;
50         ListBase subtree;
51         int xs, ys;                // do selection
52         TreeStoreElem *store_elem; // element in tree store
53         short flag;                // flag for non-saved stuff
54         short index;               // index for data arrays
55         short idcode;              // from TreeStore id
56         short xend;                // width of item display, for select
57         const char *name;
58         void *directdata;          // Armature Bones, Base, Sequence, Strip...
59         PointerRNA rnaptr;         // RNA Pointer
60 }  TreeElement;
61
62 #define TREESTORE_ID_TYPE(_id) \
63         (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) || \
64          ELEM(GS((_id)->name), ID_KE, ID_WO, ID_SPK, ID_GR, ID_AR, ID_AC, ID_BR, ID_PA, ID_GD, ID_LS) || \
65          ELEM(GS((_id)->name), ID_SCR, ID_WM, ID_TXT, ID_VF, ID_SO, ID_CF, ID_PAL, ID_MC))  /* Only in 'blendfile' mode ... :/ */
66
67 /* TreeElement->flag */
68 #define TE_ACTIVE       1
69 #define TE_ICONROW      2
70 #define TE_LAZY_CLOSED  4
71 #define TE_FREE_NAME    8
72
73 /* button events */
74 #define OL_NAMEBUTTON       1
75
76 typedef enum {
77         OL_DRAWSEL_NONE    = 0,  /* inactive (regular black text) */
78         OL_DRAWSEL_NORMAL  = 1,  /* active object (draws white text) */
79         OL_DRAWSEL_ACTIVE  = 2,  /* active obdata (draws a circle around the icon) */
80 } eOLDrawState;
81
82 typedef enum {
83         OL_SETSEL_NONE     = 0,  /* don't change the selection state */
84         OL_SETSEL_NORMAL   = 1,  /* select the item */
85         OL_SETSEL_EXTEND   = 2,  /* select the item and extend (also toggles selection) */
86 } eOLSetState;
87
88 /* get TreeStoreElem associated with a TreeElement
89  * < a: (TreeElement) tree element to find stored element for
90  */
91 #define TREESTORE(a) ((a)->store_elem)
92
93 /* size constants */
94 #define OL_Y_OFFSET 2
95
96 #define OL_TOG_RESTRICT_VIEWX   (UI_UNIT_X * 3.0f)
97 #define OL_TOG_RESTRICT_SELECTX (UI_UNIT_X * 2.0f)
98 #define OL_TOG_RESTRICT_RENDERX UI_UNIT_X
99
100 #define OL_TOGW OL_TOG_RESTRICT_VIEWX
101
102 #define OL_RNA_COLX         (UI_UNIT_X * 15)
103 #define OL_RNA_COL_SIZEX    (UI_UNIT_X * 7.5f)
104 #define OL_RNA_COL_SPACEX   (UI_UNIT_X * 2.5f)
105
106
107 /* Outliner Searching --
108  *
109  * Are we looking for something in the outliner?
110  * If so finding matches in child items makes it more useful
111  *
112  * - We want to flag parents to act as being open to filter child matches
113  * - and also flag matches so we can highlight them
114  * - Flags are stored in TreeStoreElem->flag
115  * - Flag options defined in DNA_outliner_types.h
116  * - SO_SEARCH_RECURSIVE defined in DNA_space_types.h
117  *
118  * - NOT in datablocks view - searching all datablocks takes way too long
119  *   to be useful
120  * - not searching into RNA items helps but isn't the complete solution
121  */
122
123 #define SEARCHING_OUTLINER(sov)   (sov->search_flags & SO_SEARCH_RECURSIVE)
124
125 /* is the currrent element open? if so we also show children */
126 #define TSELEM_OPEN(telm, sv)    ( (telm->flag & TSE_CLOSED) == 0 || (SEARCHING_OUTLINER(sv) && (telm->flag & TSE_CHILDSEARCH)) )
127
128 /* outliner_tree.c ----------------------------------------------- */
129
130 void outliner_free_tree(ListBase *lb);
131 void outliner_cleanup_tree(struct SpaceOops *soops);
132
133 TreeElement *outliner_find_tse(struct SpaceOops *soops, const TreeStoreElem *tse);
134 TreeElement *outliner_find_tree_element(ListBase *lb, const TreeStoreElem *store_elem);
135 TreeElement *outliner_find_id(struct SpaceOops *soops, ListBase *lb, const struct ID *id);
136 TreeElement *outliner_find_posechannel(ListBase *lb, const struct bPoseChannel *pchan);
137 TreeElement *outliner_find_editbone(ListBase *lb, const struct EditBone *ebone);
138 struct ID *outliner_search_back(SpaceOops *soops, TreeElement *te, short idcode);
139
140 void outliner_build_tree(struct Main *mainvar, struct Scene *scene, struct SpaceOops *soops);
141
142 /* outliner_draw.c ---------------------------------------------- */
143
144 void draw_outliner(const struct bContext *C);
145 void restrictbutton_gr_restrict_flag(void *poin, void *poin2, int flag);
146
147 /* outliner_select.c -------------------------------------------- */
148 eOLDrawState tree_element_type_active(
149         struct bContext *C, struct Scene *scene, struct SpaceOops *soops,
150         TreeElement *te, TreeStoreElem *tselem, const eOLSetState set, bool recursive);
151 eOLDrawState tree_element_active(struct bContext *C, struct Scene *scene, SpaceOops *soops,
152                                  TreeElement *te, const eOLSetState set, const bool handle_all_types);
153
154 void outliner_item_do_activate_from_tree_element(
155         struct bContext *C, TreeElement *te, TreeStoreElem *tselem,
156         bool extend, bool recursive);
157 int outliner_item_do_activate_from_cursor(
158         struct bContext *C, const int mval[2],
159         bool extend, bool recursive);
160
161 /* outliner_edit.c ---------------------------------------------- */
162 typedef void (*outliner_operation_cb)(
163         struct bContext *C, struct ReportList *, struct Scene *scene,
164         struct TreeElement *, struct TreeStoreElem *, TreeStoreElem *, void *);
165
166 void outliner_do_object_operation_ex(
167         struct bContext *C, ReportList *reports, struct Scene *scene, struct SpaceOops *soops, struct ListBase *lb,
168         outliner_operation_cb operation_cb, bool recurse_selected);
169 void outliner_do_object_operation(
170         struct bContext *C, ReportList *reports, struct Scene *scene, struct SpaceOops *soops, struct ListBase *lb,
171         outliner_operation_cb operation_cb);
172
173 int common_restrict_check(struct bContext *C, struct Object *ob);
174
175 int outliner_flag_is_any_test(ListBase *lb, short flag, const int curlevel);
176 void outliner_flag_set(ListBase *lb, short flag, short set);
177
178 void object_toggle_visibility_cb(
179         struct bContext *C, struct ReportList *reports, struct Scene *scene,
180         TreeElement *te, struct TreeStoreElem *tsep, struct TreeStoreElem *tselem, void *user_data);
181 void object_toggle_selectability_cb(
182         struct bContext *C, struct ReportList *reports, struct Scene *scene,
183         TreeElement *te, struct TreeStoreElem *tsep, struct TreeStoreElem *tselem, void *user_data);
184 void object_toggle_renderability_cb(
185         struct bContext *C, struct ReportList *reports, struct Scene *scene,
186         TreeElement *te, struct TreeStoreElem *tsep, struct TreeStoreElem *tselem, void *user_data);
187
188
189 void group_toggle_visibility_cb(
190         struct bContext *C, struct ReportList *reports, struct Scene *scene,
191         TreeElement *te, struct TreeStoreElem *tsep, struct TreeStoreElem *tselem, void *user_data);
192 void group_toggle_selectability_cb(
193         struct bContext *C, struct ReportList *reports, struct Scene *scene,
194         TreeElement *te, struct TreeStoreElem *tsep, struct TreeStoreElem *tselem, void *user_data);
195 void group_toggle_renderability_cb(
196         struct bContext *C, struct ReportList *reports, struct Scene *scene,
197         TreeElement *te, struct TreeStoreElem *tsep, struct TreeStoreElem *tselem, void *user_data);
198
199 void item_rename_cb(
200         struct bContext *C, struct ReportList *reports, struct Scene *scene,
201         TreeElement *te, struct TreeStoreElem *tsep, struct TreeStoreElem *tselem, void *user_data);
202 void lib_relocate_cb(
203         struct bContext *C, struct ReportList *reports, struct Scene *scene, struct TreeElement *te,
204         struct TreeStoreElem *tsep, struct TreeStoreElem *tselem, void *user_data);
205 void lib_reload_cb(
206         struct bContext *C, struct ReportList *reports, struct Scene *scene, struct TreeElement *te,
207         struct TreeStoreElem *tsep, struct TreeStoreElem *tselem, void *user_data);
208
209 void id_delete_cb(
210         struct bContext *C, struct ReportList *reports, struct Scene *scene, struct TreeElement *te,
211         struct TreeStoreElem *tsep, struct TreeStoreElem *tselem, void *user_data);
212 void id_remap_cb(
213         struct bContext *C, struct ReportList *reports, struct Scene *scene, struct TreeElement *te,
214         struct TreeStoreElem *tsep, struct TreeStoreElem *tselem, void *user_data);
215
216 TreeElement *outliner_dropzone_find(const struct SpaceOops *soops, const float fmval[2], const bool children);
217 /* ...................................................... */
218
219 void OUTLINER_OT_item_activate(struct wmOperatorType *ot);
220 void OUTLINER_OT_item_openclose(struct wmOperatorType *ot);
221 void OUTLINER_OT_item_rename(struct wmOperatorType *ot);
222 void OUTLINER_OT_lib_relocate(struct wmOperatorType *ot);
223 void OUTLINER_OT_lib_reload(struct wmOperatorType *ot);
224
225 void OUTLINER_OT_id_delete(struct wmOperatorType *ot);
226
227 void OUTLINER_OT_show_one_level(struct wmOperatorType *ot);
228 void OUTLINER_OT_show_active(struct wmOperatorType *ot);
229 void OUTLINER_OT_show_hierarchy(struct wmOperatorType *ot);
230
231 void OUTLINER_OT_select_border(struct wmOperatorType *ot);
232
233 void OUTLINER_OT_selected_toggle(struct wmOperatorType *ot);
234 void OUTLINER_OT_expanded_toggle(struct wmOperatorType *ot);
235
236 void OUTLINER_OT_scroll_page(struct wmOperatorType *ot);
237
238 void OUTLINER_OT_renderability_toggle(struct wmOperatorType *ot);
239 void OUTLINER_OT_selectability_toggle(struct wmOperatorType *ot);
240 void OUTLINER_OT_visibility_toggle(struct wmOperatorType *ot);
241
242 void OUTLINER_OT_keyingset_add_selected(struct wmOperatorType *ot);
243 void OUTLINER_OT_keyingset_remove_selected(struct wmOperatorType *ot);
244
245 void OUTLINER_OT_drivers_add_selected(struct wmOperatorType *ot);
246 void OUTLINER_OT_drivers_delete_selected(struct wmOperatorType *ot);
247
248 void OUTLINER_OT_orphans_purge(struct wmOperatorType *ot);
249
250 void OUTLINER_OT_parent_drop(struct wmOperatorType *ot);
251 void OUTLINER_OT_parent_clear(struct wmOperatorType *ot);
252 void OUTLINER_OT_scene_drop(struct wmOperatorType *ot);
253 void OUTLINER_OT_material_drop(struct wmOperatorType *ot);
254 void OUTLINER_OT_group_link(struct wmOperatorType *ot);
255
256 /* outliner_tools.c ---------------------------------------------- */
257
258 void OUTLINER_OT_operation(struct wmOperatorType *ot);
259 void OUTLINER_OT_scene_operation(struct wmOperatorType *ot);
260 void OUTLINER_OT_object_operation(struct wmOperatorType *ot);
261 void OUTLINER_OT_group_operation(struct wmOperatorType *ot);
262 void OUTLINER_OT_lib_operation(struct wmOperatorType *ot);
263 void OUTLINER_OT_id_operation(struct wmOperatorType *ot);
264 void OUTLINER_OT_id_remap(struct wmOperatorType *ot);
265 void OUTLINER_OT_data_operation(struct wmOperatorType *ot);
266 void OUTLINER_OT_animdata_operation(struct wmOperatorType *ot);
267 void OUTLINER_OT_action_set(struct wmOperatorType *ot);
268 void OUTLINER_OT_constraint_operation(struct wmOperatorType *ot);
269 void OUTLINER_OT_modifier_operation(struct wmOperatorType *ot);
270 /* ---------------------------------------------------------------- */
271
272 /* outliner_ops.c */
273 void outliner_operatortypes(void);
274 void outliner_keymap(struct wmKeyConfig *keyconf);
275
276 #endif /* __OUTLINER_INTERN_H__ */