copy of docs from 2.4x for python modules that have been kept
[blender.git] / source / blender / editors / space_api / spacetypes.c
1 /**
2  * $Id: spacetypes.c
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) Blender Foundation, 2008
21  *
22  * ***** END GPL/BL DUAL LICENSE BLOCK *****
23  */
24
25 #include <stdlib.h>
26
27 #include "MEM_guardedalloc.h"
28 #include "BLI_blenlib.h"
29
30 #include "DNA_object_types.h"
31 #include "DNA_scene_types.h"
32 #include "DNA_windowmanager_types.h"
33
34 #include "BKE_context.h"
35 #include "BKE_screen.h"
36
37 #include "UI_interface.h"
38 #include "UI_view2d.h"
39
40 #include "BIF_gl.h"
41
42 #include "ED_anim_api.h"
43 #include "ED_armature.h"
44 #include "ED_curve.h"
45 #include "ED_fileselect.h"
46 #include "ED_gpencil.h"
47 #include "ED_markers.h"
48 #include "ED_mesh.h"
49 #include "ED_node.h"
50 #include "ED_object.h"
51 #include "ED_physics.h"
52 #include "ED_render.h"
53 #include "ED_screen.h"
54 #include "ED_sculpt.h"
55 #include "ED_space_api.h"
56 #include "ED_sound.h"
57 #include "ED_uvedit.h"
58 #include "ED_mball.h"
59
60 /* only call once on startup, storage is global in BKE kernel listbase */
61 void ED_spacetypes_init(void)
62 {
63         const ListBase *spacetypes;
64         SpaceType *type;
65
66         /* create space types */
67         ED_spacetype_outliner();
68         ED_spacetype_time();
69         ED_spacetype_view3d();
70         ED_spacetype_ipo();
71         ED_spacetype_image();
72         ED_spacetype_node();
73         ED_spacetype_buttons();
74         ED_spacetype_info();
75         ED_spacetype_file();
76         ED_spacetype_sound();
77         ED_spacetype_action();
78         ED_spacetype_nla();
79         ED_spacetype_script();
80         ED_spacetype_text();
81         ED_spacetype_sequencer();
82         ED_spacetype_logic();
83         ED_spacetype_console();
84         ED_spacetype_userpref();
85 //      ...
86         
87         /* register operator types for screen and all spaces */
88         ED_operatortypes_screen();
89         ED_operatortypes_anim();
90         ED_operatortypes_animchannels();
91         ED_operatortypes_gpencil();
92         ED_operatortypes_object();
93         ED_operatortypes_mesh();
94         ED_operatortypes_sculpt();
95         ED_operatortypes_uvedit();
96         ED_operatortypes_paint();
97         ED_operatortypes_physics();
98         ED_operatortypes_curve();
99         ED_operatortypes_armature();
100         ED_operatortypes_marker();
101         ED_operatortypes_metaball();
102         ED_operatortypes_sound();
103         ED_operatortypes_render();
104         
105         UI_view2d_operatortypes();
106         UI_buttons_operatortypes();
107         
108         spacetypes = BKE_spacetypes_list();
109         for(type=spacetypes->first; type; type=type->next)
110                 type->operatortypes();
111
112
113         /* Macros's must go last since they reference other operators
114          * maybe we'll need to have them go after python operators too? */
115         ED_operatormacros_armature();
116         ED_operatormacros_mesh();
117         ED_operatormacros_node();
118         ED_operatormacros_object();
119         ED_operatormacros_file();
120 }
121
122 /* called in wm.c */
123 /* keymap definitions are registered only once per WM initialize, usually on file read,
124    using the keymap the actual areas/regions add the handlers */
125 void ED_spacetypes_keymap(wmKeyConfig *keyconf)
126 {
127         const ListBase *spacetypes;
128         SpaceType *stype;
129         ARegionType *atype;
130
131         ED_keymap_screen(keyconf);
132         ED_keymap_anim(keyconf);
133         ED_keymap_animchannels(keyconf);
134         ED_keymap_gpencil(keyconf);
135         ED_keymap_object(keyconf); /* defines lattice also */
136         ED_keymap_mesh(keyconf);
137         ED_keymap_uvedit(keyconf);
138         ED_keymap_curve(keyconf);
139         ED_keymap_armature(keyconf);
140         ED_keymap_physics(keyconf);
141         ED_keymap_metaball(keyconf);
142         ED_keymap_paint(keyconf);
143         ED_marker_keymap(keyconf);
144
145         UI_view2d_keymap(keyconf);
146
147         spacetypes = BKE_spacetypes_list();
148         for(stype=spacetypes->first; stype; stype=stype->next) {
149                 if(stype->keymap)
150                         stype->keymap(keyconf);
151                 for(atype=stype->regiontypes.first; atype; atype=atype->next) {
152                         if(atype->keymap)
153                                 atype->keymap(keyconf);
154                 }
155         }
156 }
157
158 /* ********************** custom drawcall api ***************** */
159
160 typedef struct RegionDrawCB {
161         struct RegionDrawCB *next, *prev;
162         
163         void (*draw)(const struct bContext *, struct ARegion *, void *);        
164         void *customdata;
165         
166         int type;
167         
168 } RegionDrawCB;
169
170 void *ED_region_draw_cb_activate(ARegionType *art, 
171                                                                  void   (*draw)(const struct bContext *, struct ARegion *, void *),
172                                                                  void *customdata, int type)
173 {
174         RegionDrawCB *rdc= MEM_callocN(sizeof(RegionDrawCB), "RegionDrawCB");
175         
176         BLI_addtail(&art->drawcalls, rdc);
177         rdc->draw= draw;
178         rdc->customdata= customdata;
179         rdc->type= type;
180         
181         return rdc;
182 }
183
184 void ED_region_draw_cb_exit(ARegionType *art, void *handle)
185 {
186         RegionDrawCB *rdc;
187         
188         for(rdc= art->drawcalls.first; rdc; rdc= rdc->next) {
189                 if(rdc==(RegionDrawCB *)handle) {
190                         BLI_remlink(&art->drawcalls, rdc);
191                         MEM_freeN(rdc);
192                         return;
193                 }
194         }
195 }
196
197 void ED_region_draw_cb_draw(const bContext *C, ARegion *ar, int type)
198 {
199         RegionDrawCB *rdc;
200         
201         for(rdc= ar->type->drawcalls.first; rdc; rdc= rdc->next) {
202                 if(rdc->type==type)
203                         rdc->draw(C, ar, rdc->customdata);
204         }               
205 }
206
207
208
209 /* ********************* space template *********************** */
210
211 /* allocate and init some vars */
212 static SpaceLink *xxx_new(const bContext *C)
213 {
214         return NULL;
215 }
216
217 /* not spacelink itself */
218 static void xxx_free(SpaceLink *sl)
219 {
220
221 }
222
223 /* spacetype; init callback for usage, should be redoable */
224 static void xxx_init(wmWindowManager *wm, ScrArea *sa)
225 {
226         
227         /* link area to SpaceXXX struct */
228         
229         /* define how many regions, the order and types */
230         
231         /* add types to regions */
232 }
233
234 static SpaceLink *xxx_duplicate(SpaceLink *sl)
235 {
236         
237         return NULL;
238 }
239
240 static void xxx_operatortypes(void)
241 {
242         /* register operator types for this space */
243 }
244
245 static void xxx_keymap(wmKeyConfig *keyconf)
246 {
247         /* add default items to keymap */
248 }
249
250 /* only called once, from screen/spacetypes.c */
251 void ED_spacetype_xxx(void)
252 {
253         static SpaceType st;
254         
255         st.spaceid= SPACE_VIEW3D;
256         
257         st.new= xxx_new;
258         st.free= xxx_free;
259         st.init= xxx_init;
260         st.duplicate= xxx_duplicate;
261         st.operatortypes= xxx_operatortypes;
262         st.keymap= xxx_keymap;
263         
264         BKE_spacetype_register(&st);
265 }
266
267 /* ****************************** end template *********************** */
268
269
270
271