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