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