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