Image Panels
[blender.git] / source / blender / makesrna / intern / rna_image.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): Brecht Van Lommel
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_image_types.h"
33 #include "DNA_scene_types.h"
34
35 #include "BKE_context.h"
36 #include "BKE_image.h"
37
38 #include "WM_types.h"
39
40 static EnumPropertyItem image_source_items[]= {
41         {IMA_SRC_FILE, "FILE", 0, "File", "Single image file"},
42         {IMA_SRC_SEQUENCE, "SEQUENCE", 0, "Sequence", "Multiple image files, as a sequence"},
43         {IMA_SRC_MOVIE, "MOVIE", 0, "Movie", "Movie file"},
44         {IMA_SRC_GENERATED, "GENERATED", 0, "Generated", "Generated image"},
45         {IMA_SRC_VIEWER, "VIEWER", 0, "Viewer", "Compositing node viewer"},
46         {0, NULL, 0, NULL, NULL}};
47
48 #ifdef RNA_RUNTIME
49
50 #include "IMB_imbuf_types.h"
51
52 static void rna_Image_animated_update(bContext *C, PointerRNA *ptr)
53 {
54         Image *ima= (Image*)ptr->data;
55         int  nr;
56
57         if(ima->flag & IMA_TWINANIM) {
58                 nr= ima->xrep*ima->yrep;
59                 if(ima->twsta>=nr) ima->twsta= 1;
60                 if(ima->twend>=nr) ima->twend= nr-1;
61                 if(ima->twsta>ima->twend) ima->twsta= 1;
62         }
63 }
64
65 static int rna_Image_dirty_get(PointerRNA *ptr)
66 {
67         Image *ima= (Image*)ptr->data;
68         ImBuf *ibuf;
69
70         for(ibuf=ima->ibufs.first; ibuf; ibuf=ibuf->next)
71                 if(ibuf->userflags & IB_BITMAPDIRTY)
72                         return 1;
73         
74         return 0;
75 }
76
77 static void rna_Image_source_update(bContext *C, PointerRNA *ptr)
78 {
79         Image *ima= ptr->id.data;
80         BKE_image_signal(ima, NULL, IMA_SIGNAL_SRC_CHANGE);
81 }
82
83 static void rna_Image_fields_update(bContext *C, PointerRNA *ptr)
84 {
85         Image *ima= ptr->id.data;
86         ImBuf *ibuf;
87
88         ibuf= BKE_image_get_ibuf(ima, NULL);
89
90         if(ibuf) {
91                 short nr= 0;
92
93                 if(!(ima->flag & IMA_FIELDS) && (ibuf->flags & IB_fields)) nr= 1;
94                 if((ima->flag & IMA_FIELDS) && !(ibuf->flags & IB_fields)) nr= 1;
95
96                 if(nr)
97                         BKE_image_signal(ima, NULL, IMA_SIGNAL_FREE);
98         }
99 }
100
101 static void rna_Image_reload_update(bContext *C, PointerRNA *ptr)
102 {
103         Image *ima= ptr->id.data;
104         BKE_image_signal(ima, NULL, IMA_SIGNAL_RELOAD);
105         printf("reload %p\n", ima);
106 }
107
108 static void rna_Image_generated_update(bContext *C, PointerRNA *ptr)
109 {
110         Image *ima= ptr->id.data;
111         BKE_image_signal(ima, NULL, IMA_SIGNAL_FREE);
112 }
113
114 static void rna_ImageUser_update(bContext *C, PointerRNA *ptr)
115 {
116     Scene *scene= CTX_data_scene(C);
117         ImageUser *iuser= ptr->data;
118
119         BKE_image_user_calc_imanr(iuser, scene->r.cfra, 0);
120 }
121
122 static EnumPropertyItem *rna_Image_source_itemf(bContext *C, PointerRNA *ptr, int *free)
123 {
124         Image *ima= (Image*)ptr->data;
125         EnumPropertyItem *item= NULL;
126         int totitem= 0;
127         
128         if(C==NULL) /* needed for doc generation */
129                 return image_source_items;
130         
131         if(ima->source == IMA_SRC_VIEWER) {
132                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_VIEWER);
133         }
134         else {
135                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_FILE);
136                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_SEQUENCE);
137                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_MOVIE);
138                 RNA_enum_items_add_value(&item, &totitem, image_source_items, IMA_SRC_GENERATED);
139         }
140
141         RNA_enum_item_end(&item, &totitem);
142         *free= 1;
143
144         return item;
145 }
146
147 #else
148
149 static void rna_def_imageuser(BlenderRNA *brna)
150 {
151         StructRNA *srna;
152         PropertyRNA *prop;
153
154         srna= RNA_def_struct(brna, "ImageUser", NULL);
155         RNA_def_struct_ui_text(srna, "Image User", "Parameters defining how an Image datablock is used by another datablock.");
156
157         prop= RNA_def_property(srna, "auto_refresh", PROP_BOOLEAN, PROP_NONE);
158         RNA_def_property_boolean_sdna(prop, NULL, "flag", IMA_ANIM_ALWAYS);
159         RNA_def_property_ui_text(prop, "Auto Refresh", "Always refresh image on frame changes.");
160         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
161
162         /* animation */
163         prop= RNA_def_property(srna, "cyclic", PROP_BOOLEAN, PROP_NONE);
164         RNA_def_property_boolean_sdna(prop, NULL, "cycl", 0);
165         RNA_def_property_ui_text(prop, "Cyclic", "Cycle the images in the movie.");
166         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
167
168         prop= RNA_def_property(srna, "frames", PROP_INT, PROP_NONE);
169         RNA_def_property_range(prop, 0, MAXFRAMEF);
170         RNA_def_property_ui_text(prop, "Frames", "Sets the number of images of a movie to use.");
171         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
172
173         prop= RNA_def_property(srna, "offset", PROP_INT, PROP_NONE);
174         RNA_def_property_range(prop, -MAXFRAMEF, MAXFRAMEF);
175         RNA_def_property_ui_text(prop, "Offset", "Offsets the number of the frame to use in the animation.");
176         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
177
178         prop= RNA_def_property(srna, "start_frame", PROP_INT, PROP_TIME);
179         RNA_def_property_int_sdna(prop, NULL, "sfra");
180         RNA_def_property_range(prop, 1.0f, MAXFRAMEF);
181         RNA_def_property_ui_text(prop, "Start Frame", "Sets the global starting frame of the movie.");
182         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
183
184         prop= RNA_def_property(srna, "fields_per_frame", PROP_INT, PROP_NONE);
185         RNA_def_property_int_sdna(prop, NULL, "fie_ima");
186         RNA_def_property_range(prop, -MAXFRAMEF, MAXFRAMEF);
187         RNA_def_property_ui_text(prop, "Fields per Frame", "The number of fields per rendered frame (2 fields is 1 image).");
188         RNA_def_property_update(prop, 0, "rna_ImageUser_update");
189
190         prop= RNA_def_property(srna, "multilayer_layer", PROP_INT, PROP_UNSIGNED);
191         RNA_def_property_int_sdna(prop, NULL, "layer");
192         RNA_def_property_clear_flag(prop, PROP_EDITABLE); /* image_multi_cb */
193         RNA_def_property_ui_text(prop, "Layer", "Layer in multilayer image.");
194
195         prop= RNA_def_property(srna, "multilayer_pass", PROP_INT, PROP_UNSIGNED);
196         RNA_def_property_int_sdna(prop, NULL, "pass");
197         RNA_def_property_clear_flag(prop, PROP_EDITABLE); /* image_multi_cb */
198         RNA_def_property_ui_text(prop, "Pass", "Pass in multilayer image.");
199 }
200
201 static void rna_def_image(BlenderRNA *brna)
202 {
203         StructRNA *srna;
204         PropertyRNA *prop;
205         static const EnumPropertyItem prop_type_items[]= {
206                 {IMA_TYPE_IMAGE, "IMAGE", 0, "Image", ""},
207                 {IMA_TYPE_MULTILAYER, "MULTILAYER", 0, "Multilayer", ""},
208                 {IMA_TYPE_UV_TEST, "UV_TEST", 0, "UV Test", ""},
209                 {IMA_TYPE_R_RESULT, "RENDER_RESULT", 0, "Render Result", ""},
210                 {IMA_TYPE_COMPOSITE, "COMPOSITING", 0, "Compositing", ""},
211                 {0, NULL, 0, NULL, NULL}};
212         static const EnumPropertyItem prop_generated_type_items[]= {
213                 {0, "BLANK", 0, "Blank", "Generate a blank image"},
214                 {1, "UVTESTGRID", 0, "UV Test Grid", "Generated grid to test UV mappings"},
215                 {0, NULL, 0, NULL, NULL}};
216         static const EnumPropertyItem prop_mapping_items[]= {
217                 {0, "UV", 0, "UV Coordinates", "Use UV coordinates for mapping the image"},
218                 {IMA_REFLECT, "REFLECTION", 0, "Reflection", "Use reflection mapping for mapping the image"},
219                 {0, NULL, 0, NULL, NULL}};
220
221         srna= RNA_def_struct(brna, "Image", "ID");
222         RNA_def_struct_ui_text(srna, "Image", "Image datablock referencing an external or packed image.");
223         RNA_def_struct_ui_icon(srna, ICON_IMAGE_DATA);
224
225         prop= RNA_def_property(srna, "filename", PROP_STRING, PROP_FILEPATH);
226         RNA_def_property_string_sdna(prop, NULL, "name");
227         RNA_def_property_ui_text(prop, "Filename", "Image/Movie file name.");
228         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, "rna_Image_reload_update");
229
230         prop= RNA_def_property(srna, "source", PROP_ENUM, PROP_NONE);
231         RNA_def_property_enum_items(prop, image_source_items);
232         RNA_def_property_enum_funcs(prop, NULL, NULL, "rna_Image_source_itemf");
233         RNA_def_property_ui_text(prop, "Source", "Where the image comes from.");
234         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, "rna_Image_source_update");
235
236         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
237         RNA_def_property_enum_items(prop, prop_type_items);
238         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
239         RNA_def_property_ui_text(prop, "Type", "How to generate the image.");
240         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, NULL);
241
242         prop= RNA_def_property(srna, "packed_file", PROP_POINTER, PROP_NONE);
243         RNA_def_property_pointer_sdna(prop, NULL, "packedfile");
244         RNA_def_property_ui_text(prop, "Packed File", "");
245
246         /* booleans */
247         prop= RNA_def_property(srna, "fields", PROP_BOOLEAN, PROP_NONE);
248         RNA_def_property_boolean_sdna(prop, NULL, "flag", IMA_FIELDS);
249         RNA_def_property_ui_text(prop, "Fields", "Use fields of the image.");
250         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, "rna_Image_fields_update");
251
252         prop= RNA_def_property(srna, "odd_fields", PROP_BOOLEAN, PROP_NONE);
253         RNA_def_property_boolean_sdna(prop, NULL, "flag", IMA_STD_FIELD);
254         RNA_def_property_ui_text(prop, "Odd Fields", "Standard field toggle.");
255         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, "rna_Image_reload_update");
256
257         prop= RNA_def_property(srna, "antialias", PROP_BOOLEAN, PROP_NONE);
258         RNA_def_property_boolean_sdna(prop, NULL, "flag", IMA_ANTIALI);
259         RNA_def_property_ui_text(prop, "Anti-alias", "Toggles image anti-aliasing, only works with solid colors");
260         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, NULL);
261
262         prop= RNA_def_property(srna, "premultiply", PROP_BOOLEAN, PROP_NONE);
263         RNA_def_property_boolean_sdna(prop, NULL, "flag", IMA_DO_PREMUL);
264         RNA_def_property_ui_text(prop, "Premultiply", "Convert RGB from key alpha to premultiplied alpha.");
265         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, NULL);
266
267         prop= RNA_def_property(srna, "dirty", PROP_BOOLEAN, PROP_NONE);
268         RNA_def_property_boolean_funcs(prop, "rna_Image_dirty_get", NULL);
269         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
270         RNA_def_property_ui_text(prop, "Dirty", "Image has changed and is not saved.");
271
272         /* generated image (image_generated_change_cb) */
273         prop= RNA_def_property(srna, "generated_type", PROP_ENUM, PROP_NONE);
274         RNA_def_property_enum_sdna(prop, NULL, "gen_type");
275         RNA_def_property_enum_items(prop, prop_generated_type_items);
276         RNA_def_property_ui_text(prop, "Generated Type", "Generated image type.");
277         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, "rna_Image_generated_update");
278
279         prop= RNA_def_property(srna, "generated_width", PROP_INT, PROP_NONE);
280         RNA_def_property_int_sdna(prop, NULL, "gen_x");
281         RNA_def_property_range(prop, 1, 16384);
282         RNA_def_property_ui_text(prop, "Generated Width", "Generated image width.");
283         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, "rna_Image_generated_update");
284
285         prop= RNA_def_property(srna, "generated_height", PROP_INT, PROP_NONE);
286         RNA_def_property_int_sdna(prop, NULL, "gen_y");
287         RNA_def_property_range(prop, 1, 16384);
288         RNA_def_property_ui_text(prop, "Generated Height", "Generated image height.");
289         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, "rna_Image_generated_update");
290
291         /* realtime properties */
292         prop= RNA_def_property(srna, "mapping", PROP_ENUM, PROP_NONE);
293         RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
294         RNA_def_property_enum_items(prop, prop_mapping_items);
295         RNA_def_property_ui_text(prop, "Mapping", "Mapping type to use for this image in the game engine.");
296         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, NULL);
297
298         prop= RNA_def_property(srna, "display_aspect", PROP_FLOAT, PROP_XYZ);
299         RNA_def_property_float_sdna(prop, NULL, "aspx");
300         RNA_def_property_array(prop, 2);
301         RNA_def_property_range(prop, 0.1f, 5000.0f);
302         RNA_def_property_ui_text(prop, "Display Aspect", "Display Aspect for this image, does not affect rendering.");
303         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, NULL);
304
305         prop= RNA_def_property(srna, "animated", PROP_BOOLEAN, PROP_NONE);
306         RNA_def_property_boolean_sdna(prop, NULL, "tpageflag", IMA_TWINANIM);
307         RNA_def_property_ui_text(prop, "Animated", "Use as animated texture in the game engine.");
308         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, "rna_Image_animated_update");
309
310         prop= RNA_def_property(srna, "animation_start", PROP_INT, PROP_NONE);
311         RNA_def_property_int_sdna(prop, NULL, "twsta");
312         RNA_def_property_range(prop, 0, 128);
313         RNA_def_property_ui_text(prop, "Animation Start", "Start frame of an animated texture.");
314         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, "rna_Image_animated_update");
315
316         prop= RNA_def_property(srna, "animation_end", PROP_INT, PROP_NONE);
317         RNA_def_property_int_sdna(prop, NULL, "twend");
318         RNA_def_property_range(prop, 0, 128);
319         RNA_def_property_ui_text(prop, "Animation End", "End frame of an animated texture.");
320         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, "rna_Image_animated_update");
321
322         prop= RNA_def_property(srna, "animation_speed", PROP_INT, PROP_NONE);
323         RNA_def_property_int_sdna(prop, NULL, "animspeed");
324         RNA_def_property_range(prop, 1, 100);
325         RNA_def_property_ui_text(prop, "Animation Speed", "Speed of the animation in frames per second.");
326         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, NULL);
327
328         prop= RNA_def_property(srna, "tiles", PROP_BOOLEAN, PROP_NONE);
329         RNA_def_property_boolean_sdna(prop, NULL, "tpageflag", IMA_TILES);
330         RNA_def_property_ui_text(prop, "Tiles", "Use of tilemode for faces (default shift-LMB to pick the tile for selected faces).");
331         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, NULL);
332
333         prop= RNA_def_property(srna, "tiles_x", PROP_INT, PROP_NONE);
334         RNA_def_property_int_sdna(prop, NULL, "xrep");
335         RNA_def_property_range(prop, 1, 16);
336         RNA_def_property_ui_text(prop, "Tiles X", "Degree of repetition in the X direction.");
337         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, NULL);
338
339         prop= RNA_def_property(srna, "tiles_y", PROP_INT, PROP_NONE);
340         RNA_def_property_int_sdna(prop, NULL, "yrep");
341         RNA_def_property_range(prop, 1, 16);
342         RNA_def_property_ui_text(prop, "Tiles Y", "Degree of repetition in the Y direction.");
343         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, NULL);
344
345         prop= RNA_def_property(srna, "clamp_x", PROP_BOOLEAN, PROP_NONE);
346         RNA_def_property_boolean_sdna(prop, NULL, "tpageflag", IMA_CLAMP_U);
347         RNA_def_property_ui_text(prop, "Clamp X", "Disable texture repeating horizontally.");
348         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, NULL);
349
350         prop= RNA_def_property(srna, "clamp_y", PROP_BOOLEAN, PROP_NONE);
351         RNA_def_property_boolean_sdna(prop, NULL, "tpageflag", IMA_CLAMP_V);
352         RNA_def_property_ui_text(prop, "Clamp Y", "Disable texture repeating vertically.");
353         RNA_def_property_update(prop, NC_IMAGE|ND_DISPLAY, NULL);
354 }
355
356 void RNA_def_image(BlenderRNA *brna)
357 {
358         rna_def_image(brna);
359         rna_def_imageuser(brna);
360 }
361
362 #endif
363