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