2.5: Fix for windows editmode tab crashes. This was due to
[blender.git] / source / blender / blenkernel / BKE_context.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * Contributor(s): Blender Foundation (2008).
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 #ifndef BKE_CONTEXT_H
29 #define BKE_CONTEXT_H
30
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34
35 #include "DNA_listBase.h"
36
37 struct ARegion;
38 struct bScreen;
39 struct EditMesh;
40 struct ListBase;
41 struct Main;
42 struct Object;
43 struct PointerRNA;
44 struct ReportList;
45 struct Scene;
46 struct ScrArea;
47 struct SpaceLink;
48 struct View3D;
49 struct RegionView3D;
50 struct StructRNA;
51 struct ToolSettings;
52 struct Image;
53 struct ImBuf;
54 struct wmWindow;
55 struct wmWindowManager;
56
57 /* Structs */
58
59 struct bContext;
60 typedef struct bContext bContext;
61
62 struct bContextDataResult;
63 typedef struct bContextDataResult bContextDataResult;
64
65 enum {
66         CTX_DATA_MAIN,
67         CTX_DATA_SCENE,
68         CTX_DATA_TOOL_SETTINGS,
69
70         CTX_DATA_SELECTED_OBJECTS,
71         CTX_DATA_SELECTED_BASES,
72         CTX_DATA_SELECTED_EDITABLE_OBJECTS,
73         CTX_DATA_SELECTED_EDITABLE_BASES,
74         CTX_DATA_VISIBLE_OBJECTS,
75         CTX_DATA_VISIBLE_BASES,
76
77         CTX_DATA_ACTIVE_OBJECT,
78         CTX_DATA_ACTIVE_BASE,
79         CTX_DATA_EDIT_OBJECT,
80
81         CTX_DATA_EDIT_IMAGE,
82         CTX_DATA_EDIT_IMAGE_BUFFER,
83
84         CTX_DATA_SELECTED_NODES
85 };
86
87 typedef int bContextDataMember;
88
89 typedef int (*bContextDataCallback)(const bContext *C,
90         bContextDataMember member, bContextDataResult *result);
91
92 /* Context */
93
94 bContext *CTX_create(void);
95 void CTX_free(bContext *C);
96
97 bContext *CTX_copy(const bContext *C, int thread);
98 int CTX_thread(const bContext *C);
99
100 /* Context Task and Reports */
101
102 typedef enum bContextTask {
103         CTX_DRAWING = 0,
104         CTX_EDITING = 1,
105         CTX_EVALUATING = 2,
106         CTX_UNDEFINED = 3
107 } bContextTask;
108
109 bContextTask CTX_task(const bContext *C);
110 void CTX_task_set(bContext *C, bContextTask task);
111
112 struct ReportList *CTX_reports(const bContext *C);
113 void CTX_reports_set(bContext *C, struct ReportList *reports);
114
115 /* Window Manager Context */
116
117 struct wmWindowManager *CTX_wm_manager(const bContext *C);
118 struct wmWindow *CTX_wm_window(const bContext *C);
119 struct bScreen *CTX_wm_screen(const bContext *C);
120 struct ScrArea *CTX_wm_area(const bContext *C);
121 struct SpaceLink *CTX_wm_space_data(const bContext *C);
122 struct View3D *CTX_wm_view3d(const bContext *C);
123 struct RegionView3D *CTX_wm_region_view3d(const bContext *C);
124 struct ARegion *CTX_wm_region(const bContext *C);
125 void *CTX_wm_region_data(const bContext *C);
126 struct uiBlock *CTX_wm_ui_block(const bContext *C);
127
128 void CTX_wm_manager_set(bContext *C, struct wmWindowManager *wm);
129 void CTX_wm_window_set(bContext *C, struct wmWindow *win);
130 void CTX_wm_screen_set(bContext *C, struct bScreen *screen); /* to be removed */
131 void CTX_wm_area_set(bContext *C, struct ScrArea *win);
132 void CTX_wm_region_set(bContext *C, struct ARegion *win);
133 void CTX_wm_ui_block_set(bContext *C, struct uiBlock *block, bContextDataCallback cb);
134
135 /* Data Context
136
137    - note: listbases consist of LinkData items and must be
138      freed with BLI_freelistN! */
139
140 void CTX_data_pointer_set(bContextDataResult *result, void *data);
141 void CTX_data_list_add(bContextDataResult *result, void *data);
142
143 #define CTX_DATA_BEGIN(C, Type, instance, member) \
144         { \
145                 ListBase ctx_data_list; \
146                 LinkData *link; \
147                 CTX_data_##member(C, &ctx_data_list); \
148                 for(link=ctx_data_list.first; link; link=link->next) { \
149                         Type instance= link->data;
150
151 #define CTX_DATA_END \
152                 } \
153                 BLI_freelistN(&ctx_data_list); \
154         }
155
156 int ctx_data_list_count(const bContext *C, int (*func)(const bContext*, ListBase*));
157
158 #define CTX_DATA_COUNT(C, member) \
159         ctx_data_list_count(C, CTX_data_##member)
160
161 /* Data Context Members */
162
163 struct Main *CTX_data_main(const bContext *C);
164 struct Scene *CTX_data_scene(const bContext *C);
165 struct ToolSettings *CTX_data_tool_settings(const bContext *C);
166
167 void CTX_data_main_set(bContext *C, struct Main *bmain);
168 void CTX_data_scene_set(bContext *C, struct Scene *bmain);
169
170 int CTX_data_selected_editable_objects(const bContext *C, ListBase *list);
171 int CTX_data_selected_editable_bases(const bContext *C, ListBase *list);
172
173 int CTX_data_selected_objects(const bContext *C, ListBase *list);
174 int CTX_data_selected_bases(const bContext *C, ListBase *list);
175
176 int CTX_data_visible_objects(const bContext *C, ListBase *list);
177 int CTX_data_visible_bases(const bContext *C, ListBase *list);
178
179 struct Object *CTX_data_active_object(const bContext *C);
180 struct Base *CTX_data_active_base(const bContext *C);
181 struct Object *CTX_data_edit_object(const bContext *C);
182
183 struct Image *CTX_data_edit_image(const bContext *C);
184 struct ImBuf *CTX_data_edit_image_buffer(const bContext *C);
185
186 int CTX_data_selected_nodes(const bContext *C, ListBase *list);
187
188 /* Data Evaluation Context */
189
190 float CTX_eval_frame(const bContext *C);
191
192 int CTX_eval_render_resolution(const bContext *C);
193 void CTX_eval_render_resolution_set(bContext *C, int render);
194
195 #ifdef __cplusplus
196 }
197 #endif
198         
199 #endif
200