Dependency graph API changes
[blender.git] / source / blender / blenkernel / BKE_context.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) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19
20 #ifndef __BKE_CONTEXT_H__
21 #define __BKE_CONTEXT_H__
22
23 /** \file
24  * \ingroup bke
25  */
26
27 #include "DNA_listBase.h"
28 #include "RNA_types.h"
29
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33
34 struct ARegion;
35 struct Base;
36 struct Brush;
37 struct CacheFile;
38 struct Collection;
39 struct Depsgraph;
40 struct EditBone;
41 struct ID;
42 struct Image;
43 struct LayerCollection;
44 struct ListBase;
45 struct Main;
46 struct Object;
47 struct PointerRNA;
48 struct RegionView3D;
49 struct RenderEngineType;
50 struct ReportList;
51 struct Scene;
52 struct ScrArea;
53 struct SpaceClip;
54 struct SpaceImage;
55 struct SpaceLink;
56 struct SpaceText;
57 struct StructRNA;
58 struct Text;
59 struct ToolSettings;
60 struct View3D;
61 struct ViewLayer;
62 struct ViewRender;
63 struct bGPDframe;
64 struct bGPDlayer;
65 struct bGPdata;
66 struct bPoseChannel;
67 struct bScreen;
68 struct wmWindow;
69 struct wmWindowManager;
70
71 #include "DNA_object_enums.h"
72
73 /* Structs */
74
75 struct bContext;
76 typedef struct bContext bContext;
77
78 struct bContextDataResult;
79 typedef struct bContextDataResult bContextDataResult;
80
81 typedef int (*bContextDataCallback)(const bContext *C,
82                                     const char *member,
83                                     bContextDataResult *result);
84
85 typedef struct bContextStoreEntry {
86   struct bContextStoreEntry *next, *prev;
87
88   char name[128];
89   PointerRNA ptr;
90 } bContextStoreEntry;
91
92 typedef struct bContextStore {
93   struct bContextStore *next, *prev;
94
95   ListBase entries;
96   bool used;
97 } bContextStore;
98
99 /* for the context's rna mode enum
100  * keep aligned with data_mode_strings in context.c */
101 enum eContextObjectMode {
102   CTX_MODE_EDIT_MESH = 0,
103   CTX_MODE_EDIT_CURVE,
104   CTX_MODE_EDIT_SURFACE,
105   CTX_MODE_EDIT_TEXT,
106   CTX_MODE_EDIT_ARMATURE,
107   CTX_MODE_EDIT_METABALL,
108   CTX_MODE_EDIT_LATTICE,
109   CTX_MODE_POSE,
110   CTX_MODE_SCULPT,
111   CTX_MODE_PAINT_WEIGHT,
112   CTX_MODE_PAINT_VERTEX,
113   CTX_MODE_PAINT_TEXTURE,
114   CTX_MODE_PARTICLE,
115   CTX_MODE_OBJECT,
116   CTX_MODE_PAINT_GPENCIL,
117   CTX_MODE_EDIT_GPENCIL,
118   CTX_MODE_SCULPT_GPENCIL,
119   CTX_MODE_WEIGHT_GPENCIL,
120 };
121 #define CTX_MODE_NUM (CTX_MODE_WEIGHT_GPENCIL + 1)
122
123 /* Context */
124
125 bContext *CTX_create(void);
126 void CTX_free(bContext *C);
127
128 bContext *CTX_copy(const bContext *C);
129
130 /* Stored Context */
131
132 bContextStore *CTX_store_add(ListBase *contexts, const char *name, PointerRNA *ptr);
133 bContextStore *CTX_store_add_all(ListBase *contexts, bContextStore *context);
134 void CTX_store_set(bContext *C, bContextStore *store);
135 bContextStore *CTX_store_copy(bContextStore *store);
136 void CTX_store_free(bContextStore *store);
137 void CTX_store_free_list(ListBase *contexts);
138
139 /* need to store if python is initialized or not */
140 int CTX_py_init_get(bContext *C);
141 void CTX_py_init_set(bContext *C, int value);
142
143 void *CTX_py_dict_get(const bContext *C);
144 void CTX_py_dict_set(bContext *C, void *value);
145
146 /* Window Manager Context */
147
148 struct wmWindowManager *CTX_wm_manager(const bContext *C);
149 struct wmWindow *CTX_wm_window(const bContext *C);
150 struct WorkSpace *CTX_wm_workspace(const bContext *C);
151 struct bScreen *CTX_wm_screen(const bContext *C);
152 struct ScrArea *CTX_wm_area(const bContext *C);
153 struct SpaceLink *CTX_wm_space_data(const bContext *C);
154 struct ARegion *CTX_wm_region(const bContext *C);
155 void *CTX_wm_region_data(const bContext *C);
156 struct ARegion *CTX_wm_menu(const bContext *C);
157 struct wmGizmoGroup *CTX_wm_gizmo_group(const bContext *C);
158 struct wmMsgBus *CTX_wm_message_bus(const bContext *C);
159 struct ReportList *CTX_wm_reports(const bContext *C);
160
161 struct View3D *CTX_wm_view3d(const bContext *C);
162 struct RegionView3D *CTX_wm_region_view3d(const bContext *C);
163 struct SpaceText *CTX_wm_space_text(const bContext *C);
164 struct SpaceImage *CTX_wm_space_image(const bContext *C);
165 struct SpaceConsole *CTX_wm_space_console(const bContext *C);
166 struct SpaceProperties *CTX_wm_space_properties(const bContext *C);
167 struct SpaceFile *CTX_wm_space_file(const bContext *C);
168 struct SpaceSeq *CTX_wm_space_seq(const bContext *C);
169 struct SpaceOutliner *CTX_wm_space_outliner(const bContext *C);
170 struct SpaceNla *CTX_wm_space_nla(const bContext *C);
171 struct SpaceNode *CTX_wm_space_node(const bContext *C);
172 struct SpaceGraph *CTX_wm_space_graph(const bContext *C);
173 struct SpaceAction *CTX_wm_space_action(const bContext *C);
174 struct SpaceInfo *CTX_wm_space_info(const bContext *C);
175 struct SpaceUserPref *CTX_wm_space_userpref(const bContext *C);
176 struct SpaceClip *CTX_wm_space_clip(const bContext *C);
177 struct SpaceTopBar *CTX_wm_space_topbar(const bContext *C);
178
179 void CTX_wm_manager_set(bContext *C, struct wmWindowManager *wm);
180 void CTX_wm_window_set(bContext *C, struct wmWindow *win);
181 void CTX_wm_screen_set(bContext *C, struct bScreen *screen); /* to be removed */
182 void CTX_wm_area_set(bContext *C, struct ScrArea *sa);
183 void CTX_wm_region_set(bContext *C, struct ARegion *region);
184 void CTX_wm_menu_set(bContext *C, struct ARegion *menu);
185 void CTX_wm_gizmo_group_set(bContext *C, struct wmGizmoGroup *gzgroup);
186 const char *CTX_wm_operator_poll_msg_get(struct bContext *C);
187 void CTX_wm_operator_poll_msg_set(struct bContext *C, const char *msg);
188
189 /* Data Context
190  *
191  * - listbases consist of CollectionPointerLink items and must be
192  *   freed with BLI_freelistN!
193  * - the dir listbase consists of LinkData items */
194
195 /* data type, needed so we can tell between a NULL pointer and an empty list */
196 enum {
197   CTX_DATA_TYPE_POINTER = 0,
198   CTX_DATA_TYPE_COLLECTION,
199 };
200
201 PointerRNA CTX_data_pointer_get(const bContext *C, const char *member);
202 PointerRNA CTX_data_pointer_get_type(const bContext *C, const char *member, StructRNA *type);
203 ListBase CTX_data_collection_get(const bContext *C, const char *member);
204 ListBase CTX_data_dir_get_ex(const bContext *C,
205                              const bool use_store,
206                              const bool use_rna,
207                              const bool use_all);
208 ListBase CTX_data_dir_get(const bContext *C);
209 int CTX_data_get(
210     const bContext *C, const char *member, PointerRNA *r_ptr, ListBase *r_lb, short *r_type);
211
212 void CTX_data_id_pointer_set(bContextDataResult *result, struct ID *id);
213 void CTX_data_pointer_set(bContextDataResult *result, struct ID *id, StructRNA *type, void *data);
214
215 void CTX_data_id_list_add(bContextDataResult *result, struct ID *id);
216 void CTX_data_list_add(bContextDataResult *result, struct ID *id, StructRNA *type, void *data);
217
218 void CTX_data_dir_set(bContextDataResult *result, const char **member);
219
220 void CTX_data_type_set(struct bContextDataResult *result, short type);
221 short CTX_data_type_get(struct bContextDataResult *result);
222
223 bool CTX_data_equals(const char *member, const char *str);
224 bool CTX_data_dir(const char *member);
225
226 #define CTX_DATA_BEGIN(C, Type, instance, member) \
227   { \
228     ListBase ctx_data_list; \
229     CollectionPointerLink *ctx_link; \
230     CTX_data_##member(C, &ctx_data_list); \
231     for (ctx_link = ctx_data_list.first; ctx_link; ctx_link = ctx_link->next) { \
232       Type instance = ctx_link->ptr.data;
233
234 #define CTX_DATA_END \
235   } \
236   BLI_freelistN(&ctx_data_list); \
237   } \
238   (void)0
239
240 #define CTX_DATA_BEGIN_WITH_ID(C, Type, instance, member, Type_id, instance_id) \
241   CTX_DATA_BEGIN (C, Type, instance, member) \
242     Type_id instance_id = ctx_link->ptr.id.data;
243
244 int ctx_data_list_count(const bContext *C, int (*func)(const bContext *, ListBase *));
245
246 #define CTX_DATA_COUNT(C, member) ctx_data_list_count(C, CTX_data_##member)
247
248 /* Data Context Members */
249
250 struct Main *CTX_data_main(const bContext *C);
251 struct Scene *CTX_data_scene(const bContext *C);
252 struct LayerCollection *CTX_data_layer_collection(const bContext *C);
253 struct Collection *CTX_data_collection(const bContext *C);
254 struct ViewLayer *CTX_data_view_layer(const bContext *C);
255 struct RenderEngineType *CTX_data_engine_type(const bContext *C);
256 struct ToolSettings *CTX_data_tool_settings(const bContext *C);
257
258 const char *CTX_data_mode_string(const bContext *C);
259 enum eContextObjectMode CTX_data_mode_enum_ex(const struct Object *obedit,
260                                               const struct Object *ob,
261                                               const eObjectMode object_mode);
262 enum eContextObjectMode CTX_data_mode_enum(const bContext *C);
263
264 void CTX_data_main_set(bContext *C, struct Main *bmain);
265 void CTX_data_scene_set(bContext *C, struct Scene *bmain);
266
267 int CTX_data_selected_editable_objects(const bContext *C, ListBase *list);
268 int CTX_data_selected_editable_bases(const bContext *C, ListBase *list);
269
270 int CTX_data_editable_objects(const bContext *C, ListBase *list);
271 int CTX_data_editable_bases(const bContext *C, ListBase *list);
272
273 int CTX_data_selected_objects(const bContext *C, ListBase *list);
274 int CTX_data_selected_bases(const bContext *C, ListBase *list);
275
276 int CTX_data_visible_objects(const bContext *C, ListBase *list);
277 int CTX_data_visible_bases(const bContext *C, ListBase *list);
278
279 int CTX_data_selectable_objects(const bContext *C, ListBase *list);
280 int CTX_data_selectable_bases(const bContext *C, ListBase *list);
281
282 struct Object *CTX_data_active_object(const bContext *C);
283 struct Base *CTX_data_active_base(const bContext *C);
284 struct Object *CTX_data_edit_object(const bContext *C);
285
286 struct Image *CTX_data_edit_image(const bContext *C);
287
288 struct Text *CTX_data_edit_text(const bContext *C);
289 struct MovieClip *CTX_data_edit_movieclip(const bContext *C);
290 struct Mask *CTX_data_edit_mask(const bContext *C);
291
292 struct CacheFile *CTX_data_edit_cachefile(const bContext *C);
293
294 int CTX_data_selected_nodes(const bContext *C, ListBase *list);
295
296 struct EditBone *CTX_data_active_bone(const bContext *C);
297 int CTX_data_selected_bones(const bContext *C, ListBase *list);
298 int CTX_data_selected_editable_bones(const bContext *C, ListBase *list);
299 int CTX_data_visible_bones(const bContext *C, ListBase *list);
300 int CTX_data_editable_bones(const bContext *C, ListBase *list);
301
302 struct bPoseChannel *CTX_data_active_pose_bone(const bContext *C);
303 int CTX_data_selected_pose_bones(const bContext *C, ListBase *list);
304 int CTX_data_selected_pose_bones_from_active_object(const bContext *C, ListBase *list);
305 int CTX_data_visible_pose_bones(const bContext *C, ListBase *list);
306
307 struct bGPdata *CTX_data_gpencil_data(const bContext *C);
308 struct bGPDlayer *CTX_data_active_gpencil_layer(const bContext *C);
309 struct bGPDframe *CTX_data_active_gpencil_frame(const bContext *C);
310 int CTX_data_visible_gpencil_layers(const bContext *C, ListBase *list);
311 int CTX_data_editable_gpencil_layers(const bContext *C, ListBase *list);
312 int CTX_data_editable_gpencil_strokes(const bContext *C, ListBase *list);
313
314 /* Gets pointer to the dependency graph.
315  * If it doesn't exist yet, it will be allocated.
316  *
317  * The result dependency graph is NOT guaranteed to be up-to-date neither from relation nor from
318  * evaluated data points of view.
319  *
320  * NOTE: Can not be used if access to a fully evaluated datablock is needed. */
321 struct Depsgraph *CTX_data_depsgraph(const bContext *C);
322
323 /* Gets fully updated and evaluated dependency graph.
324  *
325  * All the relations and evaluated objects are guaranteed to be up to date.
326  *
327  * NOTE: Will be expensive if there are relations or objects tagged for update.
328  * NOTE: If there are pending updates depsgraph hooks will be invoked. */
329 struct Depsgraph *CTX_data_evaluated_depsgraph(const bContext *C);
330
331 /* Will Return NULL if depsgraph is not allocated yet.
332  * Only used by handful of operators which are run on file load.
333  */
334 struct Depsgraph *CTX_data_depsgraph_on_load(const bContext *C);
335
336 #ifdef __cplusplus
337 }
338 #endif
339
340 #endif