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