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