2.5: Image window operators, quite a few of these still have
[blender-staging.git] / source / blender / makesrna / intern / rna_space.c
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  * Contributor(s): Blender Foundation (2008)
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #include <stdlib.h>
26
27 #include "RNA_define.h"
28 #include "RNA_types.h"
29
30 #include "rna_internal.h"
31
32 #include "DNA_space_types.h"
33
34 #ifdef RNA_RUNTIME
35
36 #include "DNA_scene_types.h"
37
38 #include "BKE_brush.h"
39 #include "BKE_context.h"
40
41 static StructRNA* rna_Space_refine(struct PointerRNA *ptr)
42 {
43         SpaceLink *space= (SpaceLink*)ptr->data;
44
45         switch(space->spacetype) {
46                 /*case SPACE_VIEW3D:
47                         return &RNA_SpaceView3D;
48                 case SPACE_IPO:
49                         return &RNA_SpaceGraphEditor;
50                 case SPACE_OOPS:
51                         return &RNA_SpaceOutliner;
52                 case SPACE_BUTS:
53                         return &RNA_SpaceButtonsWindow;
54                 case SPACE_FILE:
55                         return &RNA_SpaceFileBrowser;*/
56                 case SPACE_IMAGE:
57                         return &RNA_SpaceImageEditor;
58                 /*case SPACE_INFO:
59                         return &RNA_SpaceUserPreferences;
60                 case SPACE_SEQ:
61                         return &RNA_SpaceSequenceEditor;
62                 case SPACE_TEXT:
63                         return &RNA_SpaceTextEditor;
64                 //case SPACE_IMASEL:
65                 //      return &RNA_SpaceImageBrowser;
66                 case SPACE_SOUND:
67                         return &RNA_SpaceAudioWindow;
68                 case SPACE_ACTION:
69                         return &RNA_SpaceDopeSheetEditor;
70                 case SPACE_NLA:
71                         return &RNA_SpaceNLAEditor;
72                 case SPACE_SCRIPT:
73                         return &RNA_SpaceScriptsWindow;
74                 case SPACE_TIME:
75                         return &RNA_SpaceTimeline;
76                 case SPACE_NODE:
77                         return &RNA_SpaceNodeEditor;*/
78                 default:
79                         return &RNA_Space;
80         }
81 }
82
83 static PointerRNA rna_SpaceImage_uvedit_get(PointerRNA *ptr)
84 {
85         return rna_pointer_inherit_refine(ptr, &RNA_SpaceUVEditor, ptr->data);
86 }
87
88 static void rna_SpaceImage_paint_update(bContext *C, PointerRNA *ptr)
89 {
90         Scene *scene= CTX_data_scene(C);
91
92         if(scene)
93                 brush_check_exists(&scene->toolsettings->imapaint.brush);
94 }
95
96 #else
97
98 static void rna_def_space(BlenderRNA *brna)
99 {
100         StructRNA *srna;
101         PropertyRNA *prop;
102
103         static EnumPropertyItem type_items[] = {
104                 {SPACE_EMPTY, "EMPTY", "Empty", ""},
105                 {SPACE_VIEW3D, "VIEW_3D", "3D View", ""},
106                 {SPACE_IPO, "GRAPH_EDITOR", "Graph Editor", ""},
107                 {SPACE_OOPS, "OUTLINER", "Outliner", ""},
108                 {SPACE_BUTS, "BUTTONS_WINDOW", "Buttons Window", ""},
109                 {SPACE_FILE, "FILE_BROWSER", "File Browser", ""},
110                 {SPACE_IMAGE, "IMAGE_EDITOR", "Image Editor", ""},
111                 {SPACE_INFO, "USER_PREFERENCES", "User Preferences", ""},
112                 {SPACE_SEQ, "SEQUENCE_EDITOR", "Sequence Editor", ""},
113                 {SPACE_TEXT, "TEXT_EDITOR", "Text Editor", ""},
114                 //{SPACE_IMASEL, "IMAGE_BROWSER", "Image Browser", ""},
115                 {SPACE_SOUND, "AUDIO_WINDOW", "Audio Window", ""},
116                 {SPACE_ACTION, "DOPESHEET_EDITOR", "DopeSheet Editor", ""},
117                 {SPACE_NLA, "NLA_EDITOR", "NLA Editor", ""},
118                 {SPACE_SCRIPT, "SCRIPTS_WINDOW", "Scripts Window", ""},
119                 {SPACE_TIME, "TIMELINE", "Timeline", ""},
120                 {SPACE_NODE, "NODE_EDITOR", "Node Editor", ""},
121                 {0, NULL, NULL, NULL}};
122         
123         srna= RNA_def_struct(brna, "Space", NULL);
124         RNA_def_struct_sdna(srna, "SpaceLink");
125         RNA_def_struct_ui_text(srna, "Space", "Space data for a screen area.");
126         RNA_def_struct_refine_func(srna, "rna_Space_refine");
127         
128         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
129         RNA_def_property_enum_sdna(prop, NULL, "spacetype");
130         RNA_def_property_enum_items(prop, type_items);
131         RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
132         RNA_def_property_ui_text(prop, "Type", "Space data type.");
133 }
134
135 static void rna_def_space_image_uv(BlenderRNA *brna)
136 {
137         StructRNA *srna;
138         PropertyRNA *prop;
139
140 #if 0
141         static EnumPropertyItem select_mode_items[] = {
142                 {SI_SELECT_VERTEX, "VERTEX", "Vertex", "Vertex selection mode."},
143                 //{SI_SELECT_EDGE, "Edge", "Edge", "Edge selection mode."},
144                 {SI_SELECT_FACE, "FACE", "Face", "Face selection mode."},
145                 {SI_SELECT_ISLAND, "ISLAND", "Island", "Island selection mode."},
146                 {0, NULL, NULL, NULL}};
147 #endif
148
149         static EnumPropertyItem sticky_mode_items[] = {
150                 {SI_STICKY_DISABLE, "DISABLED", "Disabled", "Sticky vertex selection disabled."},
151                 {SI_STICKY_LOC, "SHARED_LOCATION", "SHARED_LOCATION", "Select UVs that are at the same location and share a mesh vertex."},
152                 {SI_STICKY_VERTEX, "SHARED_VERTEX", "SHARED_VERTEX", "Select UVs that share mesh vertex, irrespective if they are in the same location."},
153                 {0, NULL, NULL, NULL}};
154
155         static EnumPropertyItem dt_uv_items[] = {
156                 {SI_UVDT_OUTLINE, "OUTLINE", "Outline", "Draw white edges with black outline."},
157                 {SI_UVDT_DASH, "DASH", "Dash", "Draw dashed black-white edges."},
158                 {SI_UVDT_BLACK, "BLACK", "Black", "Draw black edges."},
159                 {SI_UVDT_WHITE, "WHITE", "White", "Draw white edges."},
160                 {0, NULL, NULL, NULL}};
161
162         static EnumPropertyItem dt_uvstretch_items[] = {
163                 {SI_UVDT_STRETCH_ANGLE, "ANGLE", "Angle", "Angular distortion between UV and 3D angles."},
164                 {SI_UVDT_STRETCH_AREA, "AREA", "Area", "Area distortion between UV and 3D faces."},
165                 {0, NULL, NULL, NULL}};
166
167         srna= RNA_def_struct(brna, "SpaceUVEditor", NULL);
168         RNA_def_struct_sdna(srna, "SpaceImage");
169         RNA_def_struct_nested(brna, srna, "SpaceImageEditor");
170         RNA_def_struct_ui_text(srna, "Space UV Editor", "UV editor data for the image editor space.");
171
172         /* selection */
173         /*prop= RNA_def_property(srna, "selection_mode", PROP_ENUM, PROP_NONE);
174         RNA_def_property_enum_sdna(prop, NULL, "selectmode");
175         RNA_def_property_enum_items(prop, select_mode_items);
176         RNA_def_property_ui_text(prop, "Selection Mode", "UV selection and display mode.");*/
177
178         prop= RNA_def_property(srna, "sticky_selection_mode", PROP_ENUM, PROP_NONE);
179         RNA_def_property_enum_sdna(prop, NULL, "sticky");
180         RNA_def_property_enum_items(prop, sticky_mode_items);
181         RNA_def_property_ui_text(prop, "Sticky Selection Mode", "Automatically select also UVs sharing the same vertex as the ones being selected.");
182
183         /* drawing */
184         prop= RNA_def_property(srna, "edge_draw_type", PROP_ENUM, PROP_NONE);
185         RNA_def_property_enum_sdna(prop, NULL, "dt_uv");
186         RNA_def_property_enum_items(prop, dt_uv_items);
187         RNA_def_property_ui_text(prop, "Edge Draw Type", "Draw type for drawing UV edges.");
188
189         prop= RNA_def_property(srna, "draw_smooth_edges", PROP_BOOLEAN, PROP_NONE);
190         RNA_def_property_boolean_sdna(prop, NULL, "flag", SI_SMOOTH_UV);
191         RNA_def_property_ui_text(prop, "Draw Smooth Edges", "Draw UV edges anti-aliased.");
192
193         prop= RNA_def_property(srna, "draw_stretch", PROP_BOOLEAN, PROP_NONE);
194         RNA_def_property_boolean_sdna(prop, NULL, "flag", SI_DRAW_STRETCH);
195         RNA_def_property_ui_text(prop, "Draw Stretch", "Draw faces colored according to the difference in shape between UVs and their 3D coordinates (blue for low distortion, red for high distortion).");
196
197         prop= RNA_def_property(srna, "draw_stretch_type", PROP_ENUM, PROP_NONE);
198         RNA_def_property_enum_sdna(prop, NULL, "dt_uvstretch");
199         RNA_def_property_enum_items(prop, dt_uvstretch_items);
200         RNA_def_property_ui_text(prop, "Draw Stretch Type", "Type of stretch to draw.");
201
202         prop= RNA_def_property(srna, "draw_modified_edges", PROP_ENUM, PROP_NONE);
203         RNA_def_property_enum_sdna(prop, NULL, "dt_uvstretch");
204         RNA_def_property_enum_items(prop, dt_uvstretch_items);
205         RNA_def_property_ui_text(prop, "Draw Modified Edges", "Draw edges from the final mesh after object modifier evaluation.");
206
207         /*prop= RNA_def_property(srna, "local_view", PROP_BOOLEAN, PROP_NONE);
208         RNA_def_property_boolean_sdna(prop, NULL, "flag", SI_LOCAL_UV);
209         RNA_def_property_ui_text(prop, "Local View", "Draw only faces with the currently displayed image assigned.");*/
210
211         prop= RNA_def_property(srna, "display_normalized_coordinates", PROP_BOOLEAN, PROP_NONE);
212         RNA_def_property_boolean_sdna(prop, NULL, "flag", SI_COORDFLOATS);
213         RNA_def_property_ui_text(prop, "Display Normalized Coordinates", "Display UV coordinates from 0.0 to 1.0 rather than in pixels.");
214
215         /* todo: move edge and face drawing options here from G.f */
216
217         /* editing */
218         /*prop= RNA_def_property(srna, "sync_selection", PROP_BOOLEAN, PROP_NONE);
219         RNA_def_property_boolean_sdna(prop, NULL, "flag", SI_SYNC_UVSEL);
220         RNA_def_property_ui_text(prop, "Sync Selection", "Keep UV and edit mode mesh selection in sync.");*/
221
222         prop= RNA_def_property(srna, "snap_to_pixels", PROP_BOOLEAN, PROP_NONE);
223         RNA_def_property_boolean_sdna(prop, NULL, "flag", SI_PIXELSNAP);
224         RNA_def_property_ui_text(prop, "Snap to Pixels", "Snap UVs to pixel locations while editing.");
225
226         prop= RNA_def_property(srna, "constrain_to_image_bounds", PROP_BOOLEAN, PROP_NONE);
227         RNA_def_property_boolean_sdna(prop, NULL, "flag", SI_CLIP_UV);
228         RNA_def_property_ui_text(prop, "Constrain to Image Bounds", "Constraint to stay within the image bounds while editing.");
229
230         prop= RNA_def_property(srna, "live_unwrap", PROP_BOOLEAN, PROP_NONE);
231         RNA_def_property_boolean_sdna(prop, NULL, "flag", SI_LIVE_UNWRAP);
232         RNA_def_property_ui_text(prop, "Live Unwrap", "Continuously unwrap the selected UV island while transforming pinned vertices.");
233 }
234
235 static void rna_def_space_image(BlenderRNA *brna)
236 {
237         StructRNA *srna;
238         PropertyRNA *prop;
239
240         static EnumPropertyItem draw_channels_items[] = {
241                 {0, "COLOR", "Color", "Draw image with RGB colors."},
242                 {SI_USE_ALPHA, "COLOR_ALPHA", "Color and Alpha", "Draw image with RGB colors and alpha transparency."},
243                 {SI_SHOW_ALPHA, "ALPHA", "Alpha", "Draw alpha transparency channel."},
244                 {SI_SHOW_ZBUF, "Z_BUFFER", "Z-Buffer", "Draw Z-buffer associated with image (mapped from camera clip start to end)."},
245                 {0, NULL, NULL, NULL}};
246
247         srna= RNA_def_struct(brna, "SpaceImageEditor", "Space");
248         RNA_def_struct_sdna(srna, "SpaceImage");
249         RNA_def_struct_ui_text(srna, "Space Image Editor", "Image and UV editor space data.");
250
251         /* image */
252         prop= RNA_def_property(srna, "image", PROP_POINTER, PROP_NONE);
253         RNA_def_property_ui_text(prop, "Image", "Image displayed and edited in this space.");
254
255         prop= RNA_def_property(srna, "image_user", PROP_POINTER, PROP_NEVER_NULL);
256         RNA_def_property_pointer_sdna(prop, NULL, "iuser");
257         RNA_def_property_ui_text(prop, "Image User", "Parameters defining which layer, pass and frame of the image is displayed.");
258
259         prop= RNA_def_property(srna, "curves", PROP_POINTER, PROP_NONE);
260         RNA_def_property_pointer_sdna(prop, NULL, "cumap");
261         RNA_def_property_ui_text(prop, "Curves", "Color curve mapping to use for displaying the image.");
262
263         prop= RNA_def_property(srna, "image_pin", PROP_BOOLEAN, PROP_NONE);
264         RNA_def_property_boolean_sdna(prop, NULL, "pin", 0);
265         RNA_def_property_ui_text(prop, "Image Pin", "Display current image regardless of object selection.");
266
267         /* image draw */
268         prop= RNA_def_property(srna, "draw_repeated", PROP_BOOLEAN, PROP_NONE);
269         RNA_def_property_boolean_sdna(prop, NULL, "flag", SI_DRAW_TILE);
270         RNA_def_property_ui_text(prop, "Draw Repeated", "Draw the image repeated outside of the main view.");
271
272         prop= RNA_def_property(srna, "draw_channels", PROP_ENUM, PROP_NONE);
273         RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
274         RNA_def_property_enum_items(prop, draw_channels_items);
275         RNA_def_property_ui_text(prop, "Draw Channels", "Channels of the image to draw.");
276
277         /* uv */
278         prop= RNA_def_property(srna, "uv_editor", PROP_POINTER, PROP_NEVER_NULL);
279         RNA_def_property_struct_type(prop, "SpaceUVEditor");
280         RNA_def_property_pointer_funcs(prop, "rna_SpaceImage_uvedit_get", NULL);
281         RNA_def_property_ui_text(prop, "UV Editor", "UV editor settings.");
282         
283         /* paint */
284         prop= RNA_def_property(srna, "image_painting", PROP_BOOLEAN, PROP_NONE);
285         RNA_def_property_boolean_sdna(prop, NULL, "flag", SI_DRAWTOOL);
286         RNA_def_property_ui_text(prop, "Image Painting", "Enable image painting mode.");
287         RNA_def_property_update(prop, 0, "rna_SpaceImage_paint_update");
288
289         /* grease pencil */
290         prop= RNA_def_property(srna, "grease_pencil", PROP_POINTER, PROP_NONE);
291         RNA_def_property_pointer_sdna(prop, NULL, "gpd");
292         RNA_def_property_struct_type(prop, "UnknownType");
293         RNA_def_property_ui_text(prop, "Grease Pencil", "Grease pencil data for this space.");
294
295         prop= RNA_def_property(srna, "use_grease_pencil", PROP_BOOLEAN, PROP_NONE);
296         RNA_def_property_boolean_sdna(prop, NULL, "flag", SI_DISPGP);
297         RNA_def_property_ui_text(prop, "Use Grease Pencil", "Display and edit the grease pencil freehand annotations overlay.");
298
299         /* update */
300         prop= RNA_def_property(srna, "update_automatically", PROP_BOOLEAN, PROP_NONE);
301         RNA_def_property_boolean_sdna(prop, NULL, "lock", 0);
302         RNA_def_property_ui_text(prop, "Update Automatically", "Update other affected window spaces automatically to reflect changes during interactive operations such as transform.");
303
304         rna_def_space_image_uv(brna);
305 }
306
307 void RNA_def_space(BlenderRNA *brna)
308 {
309         rna_def_space(brna);
310         rna_def_space_image(brna);
311 }
312
313 #endif
314