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