Context
[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 #include "RNA_types.h"
37
38 struct ARegion;
39 struct bScreen;
40 struct EditMesh;
41 struct ListBase;
42 struct Main;
43 struct Object;
44 struct PointerRNA;
45 struct ReportList;
46 struct Scene;
47 struct ScrArea;
48 struct SpaceLink;
49 struct View3D;
50 struct RegionView3D;
51 struct StructRNA;
52 struct ToolSettings;
53 struct Image;
54 struct Text;
55 struct ImBuf;
56 struct EditBone;
57 struct bPoseChannel;
58 struct wmWindow;
59 struct wmWindowManager;
60 struct SpaceText;
61 struct SpaceImage;
62 struct ID;
63
64 /* Structs */
65
66 struct bContext;
67 typedef struct bContext bContext;
68
69 struct bContextDataResult;
70 typedef struct bContextDataResult bContextDataResult;
71
72 typedef int (*bContextDataCallback)(const bContext *C,
73         const char *member, bContextDataResult *result);
74
75 /* Context */
76
77 bContext *CTX_create(void);
78 void CTX_free(bContext *C);
79
80 bContext *CTX_copy(const bContext *C, int thread);
81 int CTX_thread(const bContext *C);
82
83 /* Context Task and Reports */
84
85 typedef enum bContextTask {
86         CTX_DRAWING = 0,
87         CTX_EDITING = 1,
88         CTX_EVALUATING = 2,
89         CTX_UNDEFINED = 3
90 } bContextTask;
91
92 bContextTask CTX_task(const bContext *C);
93 void CTX_task_set(bContext *C, bContextTask task);
94
95 struct ReportList *CTX_reports(const bContext *C);
96 void CTX_reports_set(bContext *C, struct ReportList *reports);
97
98 /* Window Manager Context */
99
100 struct wmWindowManager *CTX_wm_manager(const bContext *C);
101 struct wmWindow *CTX_wm_window(const bContext *C);
102 struct bScreen *CTX_wm_screen(const bContext *C);
103 struct ScrArea *CTX_wm_area(const bContext *C);
104 struct SpaceLink *CTX_wm_space_data(const bContext *C);
105 struct ARegion *CTX_wm_region(const bContext *C);
106 void *CTX_wm_region_data(const bContext *C);
107 struct uiBlock *CTX_wm_ui_block(const bContext *C);
108
109 struct View3D *CTX_wm_view3d(const bContext *C);
110 struct RegionView3D *CTX_wm_region_view3d(const bContext *C);
111 struct SpaceText *CTX_wm_space_text(const bContext *C);
112 struct SpaceImage *CTX_wm_space_image(const bContext *C);
113
114 void CTX_wm_manager_set(bContext *C, struct wmWindowManager *wm);
115 void CTX_wm_window_set(bContext *C, struct wmWindow *win);
116 void CTX_wm_screen_set(bContext *C, struct bScreen *screen); /* to be removed */
117 void CTX_wm_area_set(bContext *C, struct ScrArea *win);
118 void CTX_wm_region_set(bContext *C, struct ARegion *win);
119 void CTX_wm_ui_block_set(bContext *C, struct uiBlock *block, bContextDataCallback cb);
120
121 /* Data Context
122
123    - note: listbases consist of LinkData items and must be
124      freed with BLI_freelistN! */
125
126 PointerRNA CTX_data_pointer_get(bContext *C, const char *member);
127 ListBase CTX_data_collection_get(bContext *C, const char *member);
128 void CTX_data_get(bContext *C, const char *member, PointerRNA *r_ptr, ListBase *r_lb);
129
130 void CTX_data_id_pointer_set(bContextDataResult *result, struct ID *id);
131 void CTX_data_pointer_set(bContextDataResult *result, struct ID *id, StructRNA *type, void *data);
132
133 void CTX_data_id_list_add(bContextDataResult *result, struct ID *id);
134 void CTX_data_list_add(bContextDataResult *result, struct ID *id, StructRNA *type, void *data);
135
136 int CTX_data_equals(const char *member, const char *str);
137
138 /*void CTX_data_pointer_set(bContextDataResult *result, void *data);
139 void CTX_data_list_add(bContextDataResult *result, void *data);*/
140
141 #define CTX_DATA_BEGIN(C, Type, instance, member) \
142         { \
143                 ListBase ctx_data_list; \
144                 CollectionPointerLink *ctx_link; \
145                 CTX_data_##member(C, &ctx_data_list); \
146                 for(ctx_link=ctx_data_list.first; ctx_link; ctx_link=ctx_link->next) { \
147                         Type instance= ctx_link->ptr.data;
148
149 #define CTX_DATA_END \
150                 } \
151                 BLI_freelistN(&ctx_data_list); \
152         }
153
154 int ctx_data_list_count(const bContext *C, int (*func)(const bContext*, ListBase*));
155
156 #define CTX_DATA_COUNT(C, member) \
157         ctx_data_list_count(C, CTX_data_##member)
158
159 /* Data Context Members */
160
161 struct Main *CTX_data_main(const bContext *C);
162 struct Scene *CTX_data_scene(const bContext *C);
163 struct ToolSettings *CTX_data_tool_settings(const bContext *C);
164
165 void CTX_data_main_set(bContext *C, struct Main *bmain);
166 void CTX_data_scene_set(bContext *C, struct Scene *bmain);
167
168 int CTX_data_selected_editable_objects(const bContext *C, ListBase *list);
169 int CTX_data_selected_editable_bases(const bContext *C, ListBase *list);
170
171 int CTX_data_selected_objects(const bContext *C, ListBase *list);
172 int CTX_data_selected_bases(const bContext *C, ListBase *list);
173
174 int CTX_data_visible_objects(const bContext *C, ListBase *list);
175 int CTX_data_visible_bases(const bContext *C, ListBase *list);
176
177 struct Object *CTX_data_active_object(const bContext *C);
178 struct Base *CTX_data_active_base(const bContext *C);
179 struct Object *CTX_data_edit_object(const bContext *C);
180
181 struct Image *CTX_data_edit_image(const bContext *C);
182
183 struct Text *CTX_data_edit_text(const bContext *C);
184
185 int CTX_data_selected_nodes(const bContext *C, ListBase *list);
186
187 struct EditBone *CTX_data_active_bone(const bContext *C);
188 int CTX_data_selected_bones(const bContext *C, ListBase *list);
189 int CTX_data_selected_editable_bones(const bContext *C, ListBase *list);
190 int CTX_data_visible_bones(const bContext *C, ListBase *list);
191 int CTX_data_editable_bones(const bContext *C, ListBase *list);
192
193 struct bPoseChannel *CTX_data_active_pchan(const bContext *C);
194 int CTX_data_selected_pchans(const bContext *C, ListBase *list);
195 int CTX_data_visible_pchans(const bContext *C, ListBase *list);
196
197 /* Data Evaluation Context */
198
199 float CTX_eval_frame(const bContext *C);
200
201 int CTX_eval_render_resolution(const bContext *C);
202 void CTX_eval_render_resolution_set(bContext *C, int render);
203
204 #ifdef __cplusplus
205 }
206 #endif
207         
208 #endif
209