This commit replaces old "manual" Editors menu with nice RNA-based one (so once again...
[blender.git] / source / blender / makesrna / intern / rna_screen.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributor(s): Blender Foundation (2008), Nathan Letwory
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/makesrna/intern/rna_screen.c
24  *  \ingroup RNA
25  */
26
27
28 #include <stdlib.h>
29 #include <stddef.h>
30
31 #include "RNA_define.h"
32 #include "RNA_enum_types.h"
33
34 #include "rna_internal.h"
35
36 #include "DNA_screen_types.h"
37 #include "DNA_scene_types.h"
38
39 EnumPropertyItem region_type_items[] = {
40         {RGN_TYPE_WINDOW, "WINDOW", 0, "Window", ""},
41         {RGN_TYPE_HEADER, "HEADER", 0, "Header", ""},
42         {RGN_TYPE_CHANNELS, "CHANNELS", 0, "Channels", ""},
43         {RGN_TYPE_TEMPORARY, "TEMPORARY", 0, "Temporary", ""},
44         {RGN_TYPE_UI, "UI", 0, "UI", ""},
45         {RGN_TYPE_TOOLS, "TOOLS", 0, "Tools", ""},
46         {RGN_TYPE_TOOL_PROPS, "TOOL_PROPS", 0, "Tool Properties", ""},
47         {RGN_TYPE_PREVIEW, "PREVIEW", 0, "Preview", ""},
48         {0, NULL, 0, NULL, NULL}
49 };
50
51 #include "ED_screen.h"
52
53 #include "WM_api.h"
54 #include "WM_types.h"
55
56 #ifdef RNA_RUNTIME
57
58 #include "BKE_global.h"
59
60 #include "UI_view2d.h"
61
62 static void rna_Screen_scene_set(PointerRNA *ptr, PointerRNA value)
63 {
64         bScreen *sc = (bScreen *)ptr->data;
65
66         if (value.data == NULL)
67                 return;
68
69         sc->newscene = value.data;
70 }
71
72 static void rna_Screen_scene_update(bContext *C, PointerRNA *ptr)
73 {
74         bScreen *sc = (bScreen *)ptr->data;
75
76         /* exception: must use context so notifier gets to the right window  */
77         if (sc->newscene) {
78                 ED_screen_set_scene(C, sc, sc->newscene);
79                 WM_event_add_notifier(C, NC_SCENE | ND_SCENEBROWSE, sc->newscene);
80
81                 if (G.debug & G_DEBUG)
82                         printf("scene set %p\n", sc->newscene);
83
84                 sc->newscene = NULL;
85         }
86 }
87
88 static void rna_Screen_redraw_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
89 {
90         bScreen *screen = (bScreen *)ptr->data;
91
92         /* the settings for this are currently only available from a menu in the TimeLine, hence refresh=SPACE_TIME */
93         ED_screen_animation_timer_update(screen, screen->redraws_flag, SPACE_TIME);
94 }
95
96
97 static int rna_Screen_is_animation_playing_get(PointerRNA *ptr)
98 {
99         return (ED_screen_animation_playing(G.main->wm.first) != NULL);
100 }
101
102 static int rna_Screen_fullscreen_get(PointerRNA *ptr)
103 {
104         bScreen *sc = (bScreen *)ptr->data;
105         return (sc->full != 0);
106 }
107
108
109 static void rna_Area_type_set(PointerRNA *ptr, int value)
110 {
111         ScrArea *sa = (ScrArea *)ptr->data;
112         sa->butspacetype = value;
113 }
114
115 static void rna_Area_type_update(bContext *C, PointerRNA *ptr)
116 {
117         wmWindowManager *wm = CTX_wm_manager(C);
118         wmWindow *win;
119         bScreen *sc = (bScreen *)ptr->id.data;
120         ScrArea *sa = (ScrArea *)ptr->data;
121
122         /* XXX this call still use context, so we trick it to work in the right context */
123         for (win = wm->windows.first; win; win = win->next) {
124                 if (sc == win->screen) {
125                         wmWindow *prevwin = CTX_wm_window(C);
126                         ScrArea *prevsa = CTX_wm_area(C);
127                         ARegion *prevar = CTX_wm_region(C);
128
129                         CTX_wm_window_set(C, win);
130                         CTX_wm_area_set(C, sa);
131                         CTX_wm_region_set(C, NULL);
132
133                         ED_area_newspace(C, sa, sa->butspacetype);
134                         ED_area_tag_redraw(sa);
135
136                         CTX_wm_window_set(C, prevwin);
137                         CTX_wm_area_set(C, prevsa);
138                         CTX_wm_region_set(C, prevar);
139                         break;
140                 }
141         }
142 }
143
144 static void rna_View2D_region_to_view(struct View2D *v2d, int x, int y, float result[2])
145 {
146         UI_view2d_region_to_view(v2d, x, y, &result[0], &result[1]);
147 }
148
149 static void rna_View2D_view_to_region(struct View2D *v2d, float x, float y, int clip, int result[2])
150 {
151         if (clip)
152                 UI_view2d_view_to_region(v2d, x, y, &result[0], &result[1]);
153         else
154                 UI_view2d_to_region_no_clip(v2d, x, y, &result[0], &result[1]);
155 }
156
157 #else
158
159 /* Area.spaces */
160 static void rna_def_area_spaces(BlenderRNA *brna, PropertyRNA *cprop)
161 {
162         StructRNA *srna;
163         PropertyRNA *prop;
164
165         RNA_def_property_srna(cprop, "AreaSpaces");
166         srna = RNA_def_struct(brna, "AreaSpaces", NULL);
167         RNA_def_struct_sdna(srna, "ScrArea");
168         RNA_def_struct_ui_text(srna, "Area Spaces", "Collection of spaces");
169
170         prop = RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
171         RNA_def_property_pointer_sdna(prop, NULL, "spacedata.first");
172         RNA_def_property_struct_type(prop, "Space");
173         RNA_def_property_ui_text(prop, "Active Space", "Space currently being displayed in this area");
174 }
175
176 static void rna_def_area(BlenderRNA *brna)
177 {
178         StructRNA *srna;
179         PropertyRNA *prop;
180         FunctionRNA *func;
181
182         srna = RNA_def_struct(brna, "Area", NULL);
183         RNA_def_struct_ui_text(srna, "Area", "Area in a subdivided screen, containing an editor");
184         RNA_def_struct_sdna(srna, "ScrArea");
185
186         prop = RNA_def_property(srna, "spaces", PROP_COLLECTION, PROP_NONE);
187         RNA_def_property_collection_sdna(prop, NULL, "spacedata", NULL);
188         RNA_def_property_struct_type(prop, "Space");
189         RNA_def_property_ui_text(prop, "Spaces",
190                                  "Spaces contained in this area, the first being the active space "
191                                  "(NOTE: Useful for example to restore a previously used 3D view space "
192                                  "in a certain area to get the old view orientation)");
193         rna_def_area_spaces(brna, prop);
194
195         prop = RNA_def_property(srna, "regions", PROP_COLLECTION, PROP_NONE);
196         RNA_def_property_collection_sdna(prop, NULL, "regionbase", NULL);
197         RNA_def_property_struct_type(prop, "Region");
198         RNA_def_property_ui_text(prop, "Regions", "Regions this area is subdivided in");
199
200         prop = RNA_def_property(srna, "show_menus", PROP_BOOLEAN, PROP_NONE);
201         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", HEADER_NO_PULLDOWN);
202         RNA_def_property_ui_text(prop, "Show Menus", "Show menus in the header");
203
204         prop = RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
205         RNA_def_property_enum_sdna(prop, NULL, "spacetype");
206         RNA_def_property_enum_items(prop, space_type_items);
207         RNA_def_property_enum_funcs(prop, NULL, "rna_Area_type_set", NULL);
208         RNA_def_property_ui_text(prop, "Editor Type", "Current editor type for this area");
209         RNA_def_property_flag(prop, PROP_CONTEXT_UPDATE);
210         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
211         RNA_def_property_update(prop, 0, "rna_Area_type_update");
212
213         prop = RNA_def_property(srna, "x", PROP_INT, PROP_NONE);
214         RNA_def_property_int_sdna(prop, NULL, "totrct.xmin");
215         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
216         RNA_def_property_ui_text(prop, "X Position", "The window relative vertical location of the area");
217
218         prop = RNA_def_property(srna, "y", PROP_INT, PROP_NONE);
219         RNA_def_property_int_sdna(prop, NULL, "totrct.ymin");
220         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
221         RNA_def_property_ui_text(prop, "Y Position", "The window relative horizontal location of the area");
222
223         prop = RNA_def_property(srna, "width", PROP_INT, PROP_UNSIGNED);
224         RNA_def_property_int_sdna(prop, NULL, "winx");
225         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
226         RNA_def_property_ui_text(prop, "Width", "Area width");
227
228         prop = RNA_def_property(srna, "height", PROP_INT, PROP_UNSIGNED);
229         RNA_def_property_int_sdna(prop, NULL, "winy");
230         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
231         RNA_def_property_ui_text(prop, "Height", "Area height");
232
233         RNA_def_function(srna, "tag_redraw", "ED_area_tag_redraw");
234
235         func = RNA_def_function(srna, "header_text_set", "ED_area_headerprint");
236         RNA_def_function_ui_description(func, "Set the header text");
237         RNA_def_string(func, "text", NULL, 0, "Text", "New string for the header, no argument clears the text");
238 }
239
240 static void rna_def_view2d_api(StructRNA *srna)
241 {
242         FunctionRNA *func;
243         PropertyRNA *parm;
244         
245         static const float view_default[2] = {0.0f, 0.0f};
246         static const int region_default[2] = {0.0f, 0.0f};
247         
248         func = RNA_def_function(srna, "region_to_view", "rna_View2D_region_to_view");
249         RNA_def_function_ui_description(func, "Transform region coordinates to 2D view");
250         parm = RNA_def_int(func, "x", 0, INT_MIN, INT_MAX, "x", "Region x coordinate", -10000, 10000);
251         RNA_def_property_flag(parm, PROP_REQUIRED);
252         parm = RNA_def_int(func, "y", 0, INT_MIN, INT_MAX, "y", "Region y coordinate", -10000, 10000);
253         RNA_def_property_flag(parm, PROP_REQUIRED);
254         parm = RNA_def_float_array(func, "result", 2, view_default, -FLT_MAX, FLT_MAX, "Result", "View coordinates", -10000.0f, 10000.0f);
255         RNA_def_property_flag(parm, PROP_THICK_WRAP);
256         RNA_def_function_output(func, parm);
257
258         func = RNA_def_function(srna, "view_to_region", "rna_View2D_view_to_region");
259         RNA_def_function_ui_description(func, "Transform 2D view coordinates to region");
260         parm = RNA_def_float(func, "x", 0.0f, -FLT_MAX, FLT_MAX, "x", "2D View x coordinate", -10000.0f, 10000.0f);
261         RNA_def_property_flag(parm, PROP_REQUIRED);
262         parm = RNA_def_float(func, "y", 0.0f, -FLT_MAX, FLT_MAX, "y", "2D View y coordinate", -10000.0f, 10000.0f);
263         RNA_def_property_flag(parm, PROP_REQUIRED);
264         RNA_def_boolean(func, "clip", 1, "Clip", "Clip coordinates to the visible region");
265         parm = RNA_def_int_array(func, "result", 2, region_default, INT_MIN, INT_MAX, "Result", "Region coordinates", -10000, 10000);
266         RNA_def_property_flag(parm, PROP_THICK_WRAP);
267         RNA_def_function_output(func, parm);
268 }
269
270 static void rna_def_view2d(BlenderRNA *brna)
271 {
272         StructRNA *srna;
273         /* PropertyRNA *prop; */
274
275         srna = RNA_def_struct(brna, "View2D", NULL);
276         RNA_def_struct_ui_text(srna, "View2D", "Scroll and zoom for a 2D region");
277         RNA_def_struct_sdna(srna, "View2D");
278         
279         /* TODO more View2D properties could be exposed here (read-only) */
280         
281         rna_def_view2d_api(srna);
282 }
283
284 static void rna_def_region(BlenderRNA *brna)
285 {
286         StructRNA *srna;
287         PropertyRNA *prop;
288
289         srna = RNA_def_struct(brna, "Region", NULL);
290         RNA_def_struct_ui_text(srna, "Region", "Region in a subdivided screen area");
291         RNA_def_struct_sdna(srna, "ARegion");
292
293         prop = RNA_def_property(srna, "id", PROP_INT, PROP_NONE);
294         RNA_def_property_int_sdna(prop, NULL, "swinid");
295         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
296         RNA_def_property_ui_text(prop, "Region ID", "Unique ID for this region");
297
298         prop = RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
299         RNA_def_property_enum_sdna(prop, NULL, "regiontype");
300         RNA_def_property_enum_items(prop, region_type_items);
301         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
302         RNA_def_property_ui_text(prop, "Region Type", "Type of this region");
303
304         prop = RNA_def_property(srna, "x", PROP_INT, PROP_NONE);
305         RNA_def_property_int_sdna(prop, NULL, "winrct.xmin");
306         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
307         RNA_def_property_ui_text(prop, "X Position", "The window relative vertical location of the region");
308
309         prop = RNA_def_property(srna, "y", PROP_INT, PROP_NONE);
310         RNA_def_property_int_sdna(prop, NULL, "winrct.ymin");
311         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
312         RNA_def_property_ui_text(prop, "Y Position", "The window relative horizontal location of the region");
313
314         prop = RNA_def_property(srna, "width", PROP_INT, PROP_UNSIGNED);
315         RNA_def_property_int_sdna(prop, NULL, "winx");
316         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
317         RNA_def_property_ui_text(prop, "Width", "Region width");
318
319         prop = RNA_def_property(srna, "height", PROP_INT, PROP_UNSIGNED);
320         RNA_def_property_int_sdna(prop, NULL, "winy");
321         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
322         RNA_def_property_ui_text(prop, "Height", "Region height");
323
324         prop = RNA_def_property(srna, "view2d", PROP_POINTER, PROP_NONE);
325         RNA_def_property_pointer_sdna(prop, NULL, "v2d");
326         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
327         RNA_def_property_flag(prop, PROP_NEVER_NULL);
328         RNA_def_property_ui_text(prop, "View2D", "2D view of the region");
329
330         RNA_def_function(srna, "tag_redraw", "ED_region_tag_redraw");
331 }
332
333 static void rna_def_screen(BlenderRNA *brna)
334 {
335         StructRNA *srna;
336         PropertyRNA *prop;
337
338         srna = RNA_def_struct(brna, "Screen", "ID");
339         RNA_def_struct_sdna(srna, "Screen"); /* it is actually bScreen but for 2.5 the dna is patched! */
340         RNA_def_struct_ui_text(srna, "Screen", "Screen datablock, defining the layout of areas in a window");
341         RNA_def_struct_ui_icon(srna, ICON_SPLITSCREEN);
342
343         /* pointers */
344         prop = RNA_def_property(srna, "scene", PROP_POINTER, PROP_NONE);
345         RNA_def_property_flag(prop, PROP_EDITABLE | PROP_NEVER_NULL);
346         RNA_def_property_pointer_funcs(prop, NULL, "rna_Screen_scene_set", NULL, NULL);
347         RNA_def_property_ui_text(prop, "Scene", "Active scene to be edited in the screen");
348         RNA_def_property_flag(prop, PROP_CONTEXT_UPDATE);
349         RNA_def_property_update(prop, 0, "rna_Screen_scene_update");
350
351         /* collections */
352         prop = RNA_def_property(srna, "areas", PROP_COLLECTION, PROP_NONE);
353         RNA_def_property_collection_sdna(prop, NULL, "areabase", NULL);
354         RNA_def_property_struct_type(prop, "Area");
355         RNA_def_property_ui_text(prop, "Areas", "Areas the screen is subdivided into");
356
357         /* readonly status indicators */
358         prop = RNA_def_property(srna, "is_animation_playing", PROP_BOOLEAN, PROP_NONE);
359         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
360         RNA_def_property_boolean_funcs(prop, "rna_Screen_is_animation_playing_get", NULL);
361         RNA_def_property_ui_text(prop, "Animation Playing", "Animation playback is active");
362
363         prop = RNA_def_property(srna, "show_fullscreen", PROP_BOOLEAN, PROP_NONE);
364         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
365         RNA_def_property_boolean_funcs(prop, "rna_Screen_fullscreen_get", NULL);
366         RNA_def_property_ui_text(prop, "Fullscreen", "An area is maximized, filling this screen");
367
368         /* Define Anim Playback Areas */
369         prop = RNA_def_property(srna, "use_play_top_left_3d_editor", PROP_BOOLEAN, PROP_NONE);
370         RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_REGION);
371         RNA_def_property_ui_text(prop, "Top-Left 3D Editor", "");
372         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_TIME, "rna_Screen_redraw_update");
373
374         prop = RNA_def_property(srna, "use_play_3d_editors", PROP_BOOLEAN, PROP_NONE);
375         RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_ALL_3D_WIN);
376         RNA_def_property_ui_text(prop, "All 3D View Editors", "");
377         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_TIME, "rna_Screen_redraw_update");
378
379         prop = RNA_def_property(srna, "use_play_animation_editors", PROP_BOOLEAN, PROP_NONE);
380         RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_ALL_ANIM_WIN);
381         RNA_def_property_ui_text(prop, "Animation Editors", "");
382         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_TIME, "rna_Screen_redraw_update");
383
384         prop = RNA_def_property(srna, "use_play_properties_editors", PROP_BOOLEAN, PROP_NONE);
385         RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_ALL_BUTS_WIN);
386         RNA_def_property_ui_text(prop, "Property Editors", "");
387         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_TIME, "rna_Screen_redraw_update");
388
389         prop = RNA_def_property(srna, "use_play_image_editors", PROP_BOOLEAN, PROP_NONE);
390         RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_ALL_IMAGE_WIN);
391         RNA_def_property_ui_text(prop, "Image Editors", "");
392         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_TIME, "rna_Screen_redraw_update");
393
394         prop = RNA_def_property(srna, "use_play_sequence_editors", PROP_BOOLEAN, PROP_NONE);
395         RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_SEQ);
396         RNA_def_property_ui_text(prop, "Sequencer Editors", "");
397         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_TIME, "rna_Screen_redraw_update");
398
399         prop = RNA_def_property(srna, "use_play_node_editors", PROP_BOOLEAN, PROP_NONE);
400         RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_NODES);
401         RNA_def_property_ui_text(prop, "Node Editors", "");
402         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_TIME, "rna_Screen_redraw_update");
403
404         prop = RNA_def_property(srna, "use_play_clip_editors", PROP_BOOLEAN, PROP_NONE);
405         RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_CLIPS);
406         RNA_def_property_ui_text(prop, "Clip Editors", "");
407         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_TIME, "rna_Screen_redraw_update");
408 }
409
410 void RNA_def_screen(BlenderRNA *brna)
411 {
412         rna_def_screen(brna);
413         rna_def_area(brna);
414         rna_def_region(brna);
415         rna_def_view2d(brna);
416 }
417
418 #endif
419