2.50: svn merge https://svn.blender.org/svnroot/bf-blender/trunk/blender -r18677...
[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 Text;
54 struct ImBuf;
55 struct EditBone;
56 struct bPoseChannel;
57 struct wmWindow;
58 struct wmWindowManager;
59 struct SpaceText;
60 struct SpaceImage;
61
62 /* Structs */
63
64 struct bContext;
65 typedef struct bContext bContext;
66
67 struct bContextDataResult;
68 typedef struct bContextDataResult bContextDataResult;
69
70 enum {
71         CTX_DATA_MAIN,
72         CTX_DATA_SCENE,
73         CTX_DATA_TOOL_SETTINGS,
74
75         CTX_DATA_SELECTED_OBJECTS,
76         CTX_DATA_SELECTED_BASES,
77         CTX_DATA_SELECTED_EDITABLE_OBJECTS,
78         CTX_DATA_SELECTED_EDITABLE_BASES,
79         CTX_DATA_VISIBLE_OBJECTS,
80         CTX_DATA_VISIBLE_BASES,
81
82         CTX_DATA_ACTIVE_OBJECT,
83         CTX_DATA_ACTIVE_BASE,
84         CTX_DATA_EDIT_OBJECT,
85
86         CTX_DATA_EDIT_IMAGE,
87         CTX_DATA_EDIT_IMAGE_BUFFER,
88
89         CTX_DATA_EDIT_TEXT,
90
91         CTX_DATA_SELECTED_NODES,
92         
93         CTX_DATA_SELECTED_BONES,
94         CTX_DATA_SELECTED_EDITABLE_BONES,
95         CTX_DATA_SELECTED_PCHANS,
96         
97         CTX_DATA_ACTIVE_BONE,
98         CTX_DATA_ACTIVE_PCHAN,
99         
100         CTX_DATA_VISIBLE_BONES,
101         CTX_DATA_EDITABLE_BONES,
102         CTX_DATA_VISIBLE_PCHANS,
103 };
104
105 typedef int bContextDataMember;
106
107 typedef int (*bContextDataCallback)(const bContext *C,
108         bContextDataMember member, bContextDataResult *result);
109
110 /* Context */
111
112 bContext *CTX_create(void);
113 void CTX_free(bContext *C);
114
115 bContext *CTX_copy(const bContext *C, int thread);
116 int CTX_thread(const bContext *C);
117
118 /* Context Task and Reports */
119
120 typedef enum bContextTask {
121         CTX_DRAWING = 0,
122         CTX_EDITING = 1,
123         CTX_EVALUATING = 2,
124         CTX_UNDEFINED = 3
125 } bContextTask;
126
127 bContextTask CTX_task(const bContext *C);
128 void CTX_task_set(bContext *C, bContextTask task);
129
130 struct ReportList *CTX_reports(const bContext *C);
131 void CTX_reports_set(bContext *C, struct ReportList *reports);
132
133 /* Window Manager Context */
134
135 struct wmWindowManager *CTX_wm_manager(const bContext *C);
136 struct wmWindow *CTX_wm_window(const bContext *C);
137 struct bScreen *CTX_wm_screen(const bContext *C);
138 struct ScrArea *CTX_wm_area(const bContext *C);
139 struct SpaceLink *CTX_wm_space_data(const bContext *C);
140 struct ARegion *CTX_wm_region(const bContext *C);
141 void *CTX_wm_region_data(const bContext *C);
142 struct uiBlock *CTX_wm_ui_block(const bContext *C);
143
144 struct View3D *CTX_wm_view3d(const bContext *C);
145 struct RegionView3D *CTX_wm_region_view3d(const bContext *C);
146 struct SpaceText *CTX_wm_space_text(const bContext *C);
147 struct SpaceImage *CTX_wm_space_image(const bContext *C);
148
149 void CTX_wm_manager_set(bContext *C, struct wmWindowManager *wm);
150 void CTX_wm_window_set(bContext *C, struct wmWindow *win);
151 void CTX_wm_screen_set(bContext *C, struct bScreen *screen); /* to be removed */
152 void CTX_wm_area_set(bContext *C, struct ScrArea *win);
153 void CTX_wm_region_set(bContext *C, struct ARegion *win);
154 void CTX_wm_ui_block_set(bContext *C, struct uiBlock *block, bContextDataCallback cb);
155
156 /* Data Context
157
158    - note: listbases consist of LinkData items and must be
159      freed with BLI_freelistN! */
160
161 void CTX_data_pointer_set(bContextDataResult *result, void *data);
162 void CTX_data_list_add(bContextDataResult *result, void *data);
163
164 #define CTX_DATA_BEGIN(C, Type, instance, member) \
165         { \
166                 ListBase ctx_data_list; \
167                 LinkData *link; \
168                 CTX_data_##member(C, &ctx_data_list); \
169                 for(link=ctx_data_list.first; link; link=link->next) { \
170                         Type instance= link->data;
171
172 #define CTX_DATA_END \
173                 } \
174                 BLI_freelistN(&ctx_data_list); \
175         }
176
177 int ctx_data_list_count(const bContext *C, int (*func)(const bContext*, ListBase*));
178
179 #define CTX_DATA_COUNT(C, member) \
180         ctx_data_list_count(C, CTX_data_##member)
181
182 /* Data Context Members */
183
184 struct Main *CTX_data_main(const bContext *C);
185 struct Scene *CTX_data_scene(const bContext *C);
186 struct ToolSettings *CTX_data_tool_settings(const bContext *C);
187
188 void CTX_data_main_set(bContext *C, struct Main *bmain);
189 void CTX_data_scene_set(bContext *C, struct Scene *bmain);
190
191 int CTX_data_selected_editable_objects(const bContext *C, ListBase *list);
192 int CTX_data_selected_editable_bases(const bContext *C, ListBase *list);
193
194 int CTX_data_selected_objects(const bContext *C, ListBase *list);
195 int CTX_data_selected_bases(const bContext *C, ListBase *list);
196
197 int CTX_data_visible_objects(const bContext *C, ListBase *list);
198 int CTX_data_visible_bases(const bContext *C, ListBase *list);
199
200 struct Object *CTX_data_active_object(const bContext *C);
201 struct Base *CTX_data_active_base(const bContext *C);
202 struct Object *CTX_data_edit_object(const bContext *C);
203
204 struct Image *CTX_data_edit_image(const bContext *C);
205 struct ImBuf *CTX_data_edit_image_buffer(const bContext *C);
206
207 struct Text *CTX_data_edit_text(const bContext *C);
208
209 int CTX_data_selected_nodes(const bContext *C, ListBase *list);
210
211 struct EditBone *CTX_data_active_bone(const bContext *C);
212 int CTX_data_selected_bones(const bContext *C, ListBase *list);
213 int CTX_data_selected_editable_bones(const bContext *C, ListBase *list);
214 int CTX_data_visible_bones(const bContext *C, ListBase *list);
215 int CTX_data_editable_bones(const bContext *C, ListBase *list);
216
217 struct bPoseChannel *CTX_data_active_pchan(const bContext *C);
218 int CTX_data_selected_pchans(const bContext *C, ListBase *list);
219 int CTX_data_visible_pchans(const bContext *C, ListBase *list);
220
221 /* Data Evaluation Context */
222
223 float CTX_eval_frame(const bContext *C);
224
225 int CTX_eval_render_resolution(const bContext *C);
226 void CTX_eval_render_resolution_set(bContext *C, int render);
227
228 #ifdef __cplusplus
229 }
230 #endif
231         
232 #endif
233