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 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 typedef void bContextDataMember;
63
64 struct bContextDataResult;
65 typedef struct bContextDataResult bContextDataResult;
66
67 typedef int (*bContextDataCallback)(const bContext *C,
68         const bContextDataMember *member, bContextDataResult *result);
69
70 /* Context */
71
72 bContext *CTX_create(void);
73 void CTX_free(bContext *C);
74
75 bContext *CTX_copy(const bContext *C, int thread);
76 int CTX_thread(const bContext *C);
77
78 /* Context Task and Reports */
79
80 typedef enum bContextTask {
81         CTX_DRAWING = 0,
82         CTX_EDITING = 1,
83         CTX_EVALUATING = 2,
84         CTX_UNDEFINED = 3
85 } bContextTask;
86
87 bContextTask CTX_task(const bContext *C);
88 void CTX_task_set(bContext *C, bContextTask task);
89
90 struct ReportList *CTX_reports(const bContext *C);
91 void CTX_reports_set(bContext *C, struct ReportList *reports);
92
93 /* Window Manager Context */
94
95 struct wmWindowManager *CTX_wm_manager(const bContext *C);
96 struct wmWindow *CTX_wm_window(const bContext *C);
97 struct bScreen *CTX_wm_screen(const bContext *C);
98 struct ScrArea *CTX_wm_area(const bContext *C);
99 struct SpaceLink *CTX_wm_space_data(const bContext *C);
100 struct View3D *CTX_wm_view3d(const bContext *C);
101 struct RegionView3D *CTX_wm_region_view3d(const bContext *C);
102 struct ARegion *CTX_wm_region(const bContext *C);
103 void *CTX_wm_region_data(const bContext *C);
104 struct uiBlock *CTX_wm_ui_block(const bContext *C);
105
106 void CTX_wm_manager_set(bContext *C, struct wmWindowManager *wm);
107 void CTX_wm_window_set(bContext *C, struct wmWindow *win);
108 void CTX_wm_screen_set(bContext *C, struct bScreen *screen); /* to be removed */
109 void CTX_wm_area_set(bContext *C, struct ScrArea *win);
110 void CTX_wm_region_set(bContext *C, struct ARegion *win);
111 void CTX_wm_ui_block_set(bContext *C, struct uiBlock *block, bContextDataCallback cb);
112
113 /* Data Context
114
115    - note: listbases consist of LinkData items and must be
116      freed with BLI_freelistN! */
117
118 void CTX_data_pointer_set(bContextDataResult *result, void *data);
119 void CTX_data_list_add(bContextDataResult *result, void *data);
120
121 #define CTX_DATA_BEGIN(C, Type, instance, member) \
122         { \
123                 ListBase ctx_data_list; \
124                 LinkData *link; \
125                 CTX_data_##member(C, &ctx_data_list); \
126                 for(link=ctx_data_list.first; link; link=link->next) { \
127                         Type instance= link->data;
128
129 #define CTX_DATA_END \
130                 } \
131                 BLI_freelistN(&ctx_data_list); \
132         }
133
134 int ctx_data_list_count(const bContext *C, int (*func)(const bContext*, ListBase*));
135
136 #define CTX_DATA_COUNT(C, member) \
137         ctx_data_list_count(C, CTX_data_##member)
138
139 /* Data Context Members */
140
141 struct Main *CTX_data_main(const bContext *C);
142 struct Scene *CTX_data_scene(const bContext *C);
143 struct ToolSettings *CTX_data_tool_settings(const bContext *C);
144
145 void CTX_data_main_set(bContext *C, struct Main *bmain);
146 void CTX_data_scene_set(bContext *C, struct Scene *bmain);
147
148 int CTX_data_selected_editable_objects(const bContext *C, ListBase *list);
149 int CTX_data_selected_editable_bases(const bContext *C, ListBase *list);
150
151 int CTX_data_selected_objects(const bContext *C, ListBase *list);
152 int CTX_data_selected_bases(const bContext *C, ListBase *list);
153
154 int CTX_data_visible_objects(const bContext *C, ListBase *list);
155 int CTX_data_visible_bases(const bContext *C, ListBase *list);
156
157 struct Object *CTX_data_active_object(const bContext *C);
158 struct Base *CTX_data_active_base(const bContext *C);
159 struct Object *CTX_data_edit_object(const bContext *C);
160
161 struct Image *CTX_data_edit_image(const bContext *C);
162 struct ImBuf *CTX_data_edit_image_buffer(const bContext *C);
163
164 int CTX_data_selected_nodes(const bContext *C, ListBase *list);
165
166 /* Data Evaluation Context */
167
168 float CTX_eval_frame(const bContext *C);
169
170 int CTX_eval_render_resolution(const bContext *C);
171 void CTX_eval_render_resolution_set(bContext *C, int render);
172
173 #ifdef __cplusplus
174 }
175 #endif
176         
177 #endif
178