49c6a07df786d2e65c54897ded5c11d0112038b0
[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 *UNUSED(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 /* UI compatible list: should not be needed, but for now we need to keep EMPTY
109  * at least in the static version of this enum for python scripts. */
110 static EnumPropertyItem *rna_Area_type_itemf(bContext *UNUSED(C), PointerRNA *UNUSED(ptr),
111                                              PropertyRNA *UNUSED(prop), int *free)
112 {
113         /* +1 to skip SPACE_EMPTY */
114         *free = 0;
115         return space_type_items + 1;
116 }
117
118 static void rna_Area_type_set(PointerRNA *ptr, int value)
119 {
120         ScrArea *sa = (ScrArea *)ptr->data;
121         sa->butspacetype = value;
122 }
123
124 static void rna_Area_type_update(bContext *C, PointerRNA *ptr)
125 {
126         wmWindowManager *wm = CTX_wm_manager(C);
127         wmWindow *win;
128         bScreen *sc = (bScreen *)ptr->id.data;
129         ScrArea *sa = (ScrArea *)ptr->data;
130
131         /* XXX this call still use context, so we trick it to work in the right context */
132         for (win = wm->windows.first; win; win = win->next) {
133                 if (sc == win->screen) {
134                         wmWindow *prevwin = CTX_wm_window(C);
135                         ScrArea *prevsa = CTX_wm_area(C);
136                         ARegion *prevar = CTX_wm_region(C);
137
138                         CTX_wm_window_set(C, win);
139                         CTX_wm_area_set(C, sa);
140                         CTX_wm_region_set(C, NULL);
141
142                         ED_area_newspace(C, sa, sa->butspacetype);
143                         ED_area_tag_redraw(sa);
144
145                         CTX_wm_window_set(C, prevwin);
146                         CTX_wm_area_set(C, prevsa);
147                         CTX_wm_region_set(C, prevar);
148                         break;
149                 }
150         }
151 }
152
153 static void rna_View2D_region_to_view(struct View2D *v2d, int x, int y, float result[2])
154 {
155         UI_view2d_region_to_view(v2d, x, y, &result[0], &result[1]);
156 }
157
158 static void rna_View2D_view_to_region(struct View2D *v2d, float x, float y, int clip, int result[2])
159 {
160         if (clip)
161                 UI_view2d_view_to_region(v2d, x, y, &result[0], &result[1]);
162         else
163                 UI_view2d_to_region_no_clip(v2d, x, y, &result[0], &result[1]);
164 }
165
166 #else
167
168 /* Area.spaces */
169 static void rna_def_area_spaces(BlenderRNA *brna, PropertyRNA *cprop)
170 {
171         StructRNA *srna;
172         PropertyRNA *prop;
173
174         RNA_def_property_srna(cprop, "AreaSpaces");
175         srna = RNA_def_struct(brna, "AreaSpaces", NULL);
176         RNA_def_struct_sdna(srna, "ScrArea");
177         RNA_def_struct_ui_text(srna, "Area Spaces", "Collection of spaces");
178
179         prop = RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
180         RNA_def_property_pointer_sdna(prop, NULL, "spacedata.first");
181         RNA_def_property_struct_type(prop, "Space");
182         RNA_def_property_ui_text(prop, "Active Space", "Space currently being displayed in this area");
183 }
184
185 static void rna_def_area(BlenderRNA *brna)
186 {
187         StructRNA *srna;
188         PropertyRNA *prop;
189         FunctionRNA *func;
190
191         srna = RNA_def_struct(brna, "Area", NULL);
192         RNA_def_struct_ui_text(srna, "Area", "Area in a subdivided screen, containing an editor");
193         RNA_def_struct_sdna(srna, "ScrArea");
194
195         prop = RNA_def_property(srna, "spaces", PROP_COLLECTION, PROP_NONE);
196         RNA_def_property_collection_sdna(prop, NULL, "spacedata", NULL);
197         RNA_def_property_struct_type(prop, "Space");
198         RNA_def_property_ui_text(prop, "Spaces",
199                                  "Spaces contained in this area, the first being the active space "
200                                  "(NOTE: Useful for example to restore a previously used 3D view space "
201                                  "in a certain area to get the old view orientation)");
202         rna_def_area_spaces(brna, prop);
203
204         prop = RNA_def_property(srna, "regions", PROP_COLLECTION, PROP_NONE);
205         RNA_def_property_collection_sdna(prop, NULL, "regionbase", NULL);
206         RNA_def_property_struct_type(prop, "Region");
207         RNA_def_property_ui_text(prop, "Regions", "Regions this area is subdivided in");
208
209         prop = RNA_def_property(srna, "show_menus", PROP_BOOLEAN, PROP_NONE);
210         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", HEADER_NO_PULLDOWN);
211         RNA_def_property_ui_text(prop, "Show Menus", "Show menus in the header");
212
213         prop = RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
214         RNA_def_property_enum_sdna(prop, NULL, "spacetype");
215         RNA_def_property_enum_items(prop, space_type_items);
216         RNA_def_property_enum_funcs(prop, NULL, "rna_Area_type_set", "rna_Area_type_itemf");
217         RNA_def_property_ui_text(prop, "Editor Type", "Current editor type for this area");
218         RNA_def_property_flag(prop, PROP_CONTEXT_UPDATE);
219         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
220         RNA_def_property_update(prop, 0, "rna_Area_type_update");
221
222         prop = RNA_def_property(srna, "x", PROP_INT, PROP_NONE);
223         RNA_def_property_int_sdna(prop, NULL, "totrct.xmin");
224         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
225         RNA_def_property_ui_text(prop, "X Position", "The window relative vertical location of the area");
226
227         prop = RNA_def_property(srna, "y", PROP_INT, PROP_NONE);
228         RNA_def_property_int_sdna(prop, NULL, "totrct.ymin");
229         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
230         RNA_def_property_ui_text(prop, "Y Position", "The window relative horizontal location of the area");
231
232         prop = RNA_def_property(srna, "width", PROP_INT, PROP_UNSIGNED);
233         RNA_def_property_int_sdna(prop, NULL, "winx");
234         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
235         RNA_def_property_ui_text(prop, "Width", "Area width");
236
237         prop = RNA_def_property(srna, "height", PROP_INT, PROP_UNSIGNED);
238         RNA_def_property_int_sdna(prop, NULL, "winy");
239         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
240         RNA_def_property_ui_text(prop, "Height", "Area height");
241
242         RNA_def_function(srna, "tag_redraw", "ED_area_tag_redraw");
243
244         func = RNA_def_function(srna, "header_text_set", "ED_area_headerprint");
245         RNA_def_function_ui_description(func, "Set the header text");
246         RNA_def_string(func, "text", NULL, 0, "Text", "New string for the header, no argument clears the text");
247 }
248
249 static void rna_def_view2d_api(StructRNA *srna)
250 {
251         FunctionRNA *func;
252         PropertyRNA *parm;
253         
254         static const float view_default[2] = {0.0f, 0.0f};
255         static const int region_default[2] = {0.0f, 0.0f};
256         
257         func = RNA_def_function(srna, "region_to_view", "rna_View2D_region_to_view");
258         RNA_def_function_ui_description(func, "Transform region coordinates to 2D view");
259         parm = RNA_def_int(func, "x", 0, INT_MIN, INT_MAX, "x", "Region x coordinate", -10000, 10000);
260         RNA_def_property_flag(parm, PROP_REQUIRED);
261         parm = RNA_def_int(func, "y", 0, INT_MIN, INT_MAX, "y", "Region y coordinate", -10000, 10000);
262         RNA_def_property_flag(parm, PROP_REQUIRED);
263         parm = RNA_def_float_array(func, "result", 2, view_default, -FLT_MAX, FLT_MAX, "Result", "View coordinates", -10000.0f, 10000.0f);
264         RNA_def_property_flag(parm, PROP_THICK_WRAP);
265         RNA_def_function_output(func, parm);
266
267         func = RNA_def_function(srna, "view_to_region", "rna_View2D_view_to_region");
268         RNA_def_function_ui_description(func, "Transform 2D view coordinates to region");
269         parm = RNA_def_float(func, "x", 0.0f, -FLT_MAX, FLT_MAX, "x", "2D View x coordinate", -10000.0f, 10000.0f);
270         RNA_def_property_flag(parm, PROP_REQUIRED);
271         parm = RNA_def_float(func, "y", 0.0f, -FLT_MAX, FLT_MAX, "y", "2D View y coordinate", -10000.0f, 10000.0f);
272         RNA_def_property_flag(parm, PROP_REQUIRED);
273         RNA_def_boolean(func, "clip", 1, "Clip", "Clip coordinates to the visible region");
274         parm = RNA_def_int_array(func, "result", 2, region_default, INT_MIN, INT_MAX, "Result", "Region coordinates", -10000, 10000);
275         RNA_def_property_flag(parm, PROP_THICK_WRAP);
276         RNA_def_function_output(func, parm);
277 }
278
279 static void rna_def_view2d(BlenderRNA *brna)
280 {
281         StructRNA *srna;
282         /* PropertyRNA *prop; */
283
284         srna = RNA_def_struct(brna, "View2D", NULL);
285         RNA_def_struct_ui_text(srna, "View2D", "Scroll and zoom for a 2D region");
286         RNA_def_struct_sdna(srna, "View2D");
287         
288         /* TODO more View2D properties could be exposed here (read-only) */
289         
290         rna_def_view2d_api(srna);
291 }
292
293 static void rna_def_region(BlenderRNA *brna)
294 {
295         StructRNA *srna;
296         PropertyRNA *prop;
297
298         srna = RNA_def_struct(brna, "Region", NULL);
299         RNA_def_struct_ui_text(srna, "Region", "Region in a subdivided screen area");
300         RNA_def_struct_sdna(srna, "ARegion");
301
302         prop = RNA_def_property(srna, "id", PROP_INT, PROP_NONE);
303         RNA_def_property_int_sdna(prop, NULL, "swinid");
304         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
305         RNA_def_property_ui_text(prop, "Region ID", "Unique ID for this region");
306
307         prop = RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
308         RNA_def_property_enum_sdna(prop, NULL, "regiontype");
309         RNA_def_property_enum_items(prop, region_type_items);
310         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
311         RNA_def_property_ui_text(prop, "Region Type", "Type of this region");
312
313         prop = RNA_def_property(srna, "x", PROP_INT, PROP_NONE);
314         RNA_def_property_int_sdna(prop, NULL, "winrct.xmin");
315         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
316         RNA_def_property_ui_text(prop, "X Position", "The window relative vertical location of the region");
317
318         prop = RNA_def_property(srna, "y", PROP_INT, PROP_NONE);
319         RNA_def_property_int_sdna(prop, NULL, "winrct.ymin");
320         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
321         RNA_def_property_ui_text(prop, "Y Position", "The window relative horizontal location of the region");
322
323         prop = RNA_def_property(srna, "width", PROP_INT, PROP_UNSIGNED);
324         RNA_def_property_int_sdna(prop, NULL, "winx");
325         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
326         RNA_def_property_ui_text(prop, "Width", "Region width");
327
328         prop = RNA_def_property(srna, "height", PROP_INT, PROP_UNSIGNED);
329         RNA_def_property_int_sdna(prop, NULL, "winy");
330         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
331         RNA_def_property_ui_text(prop, "Height", "Region height");
332
333         prop = RNA_def_property(srna, "view2d", PROP_POINTER, PROP_NONE);
334         RNA_def_property_pointer_sdna(prop, NULL, "v2d");
335         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
336         RNA_def_property_flag(prop, PROP_NEVER_NULL);
337         RNA_def_property_ui_text(prop, "View2D", "2D view of the region");
338
339         RNA_def_function(srna, "tag_redraw", "ED_region_tag_redraw");
340 }
341
342 static void rna_def_screen(BlenderRNA *brna)
343 {
344         StructRNA *srna;
345         PropertyRNA *prop;
346
347         srna = RNA_def_struct(brna, "Screen", "ID");
348         RNA_def_struct_sdna(srna, "Screen"); /* it is actually bScreen but for 2.5 the dna is patched! */
349         RNA_def_struct_ui_text(srna, "Screen", "Screen datablock, defining the layout of areas in a window");
350         RNA_def_struct_ui_icon(srna, ICON_SPLITSCREEN);
351
352         /* pointers */
353         prop = RNA_def_property(srna, "scene", PROP_POINTER, PROP_NONE);
354         RNA_def_property_flag(prop, PROP_EDITABLE | PROP_NEVER_NULL);
355         RNA_def_property_pointer_funcs(prop, NULL, "rna_Screen_scene_set", NULL, NULL);
356         RNA_def_property_ui_text(prop, "Scene", "Active scene to be edited in the screen");
357         RNA_def_property_flag(prop, PROP_CONTEXT_UPDATE);
358         RNA_def_property_update(prop, 0, "rna_Screen_scene_update");
359
360         /* collections */
361         prop = RNA_def_property(srna, "areas", PROP_COLLECTION, PROP_NONE);
362         RNA_def_property_collection_sdna(prop, NULL, "areabase", NULL);
363         RNA_def_property_struct_type(prop, "Area");
364         RNA_def_property_ui_text(prop, "Areas", "Areas the screen is subdivided into");
365
366         /* readonly status indicators */
367         prop = RNA_def_property(srna, "is_animation_playing", PROP_BOOLEAN, PROP_NONE);
368         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
369         RNA_def_property_boolean_funcs(prop, "rna_Screen_is_animation_playing_get", NULL);
370         RNA_def_property_ui_text(prop, "Animation Playing", "Animation playback is active");
371
372         prop = RNA_def_property(srna, "show_fullscreen", PROP_BOOLEAN, PROP_NONE);
373         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
374         RNA_def_property_boolean_funcs(prop, "rna_Screen_fullscreen_get", NULL);
375         RNA_def_property_ui_text(prop, "Fullscreen", "An area is maximized, filling this screen");
376
377         /* Define Anim Playback Areas */
378         prop = RNA_def_property(srna, "use_play_top_left_3d_editor", PROP_BOOLEAN, PROP_NONE);
379         RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_REGION);
380         RNA_def_property_ui_text(prop, "Top-Left 3D Editor", "");
381         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_TIME, "rna_Screen_redraw_update");
382
383         prop = RNA_def_property(srna, "use_play_3d_editors", PROP_BOOLEAN, PROP_NONE);
384         RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_ALL_3D_WIN);
385         RNA_def_property_ui_text(prop, "All 3D View Editors", "");
386         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_TIME, "rna_Screen_redraw_update");
387
388         prop = RNA_def_property(srna, "use_play_animation_editors", PROP_BOOLEAN, PROP_NONE);
389         RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_ALL_ANIM_WIN);
390         RNA_def_property_ui_text(prop, "Animation Editors", "");
391         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_TIME, "rna_Screen_redraw_update");
392
393         prop = RNA_def_property(srna, "use_play_properties_editors", PROP_BOOLEAN, PROP_NONE);
394         RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_ALL_BUTS_WIN);
395         RNA_def_property_ui_text(prop, "Property Editors", "");
396         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_TIME, "rna_Screen_redraw_update");
397
398         prop = RNA_def_property(srna, "use_play_image_editors", PROP_BOOLEAN, PROP_NONE);
399         RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_ALL_IMAGE_WIN);
400         RNA_def_property_ui_text(prop, "Image Editors", "");
401         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_TIME, "rna_Screen_redraw_update");
402
403         prop = RNA_def_property(srna, "use_play_sequence_editors", PROP_BOOLEAN, PROP_NONE);
404         RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_SEQ);
405         RNA_def_property_ui_text(prop, "Sequencer Editors", "");
406         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_TIME, "rna_Screen_redraw_update");
407
408         prop = RNA_def_property(srna, "use_play_node_editors", PROP_BOOLEAN, PROP_NONE);
409         RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_NODES);
410         RNA_def_property_ui_text(prop, "Node Editors", "");
411         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_TIME, "rna_Screen_redraw_update");
412
413         prop = RNA_def_property(srna, "use_play_clip_editors", PROP_BOOLEAN, PROP_NONE);
414         RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_CLIPS);
415         RNA_def_property_ui_text(prop, "Clip Editors", "");
416         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_TIME, "rna_Screen_redraw_update");
417 }
418
419 void RNA_def_screen(BlenderRNA *brna)
420 {
421         rna_def_screen(brna);
422         rna_def_area(brna);
423         rna_def_region(brna);
424         rna_def_view2d(brna);
425 }
426
427 #endif
428