RNA: review of commits in the past days, check the diffs for the
[blender.git] / source / blender / makesrna / intern / rna_curve.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): Blender Foundation (2008), Juho Vepsäläinen
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_curve_types.h"
33
34 #ifdef RNA_RUNTIME
35
36 static int rna_Curve_texspace_editable(PointerRNA *ptr)
37 {
38         Curve *cu= (Curve*)ptr->data;
39         return (cu->texflag & CU_AUTOSPACE)? PROP_NOT_EDITABLE: 0;
40 }
41
42 #else
43
44 static void rna_def_path(BlenderRNA *brna, StructRNA *srna);
45 static void rna_def_nurbs(BlenderRNA *brna, StructRNA *srna);
46 static void rna_def_font(BlenderRNA *brna, StructRNA *srna);
47
48 void rna_def_curve(BlenderRNA *brna)
49 {
50         StructRNA *srna;
51         PropertyRNA *prop;
52         
53         srna= RNA_def_struct(brna, "Curve", "ID", "Curve");
54
55         rna_def_ipo_common(srna);
56         rna_def_texmat_common(srna, "rna_Curve_texspace_editable");
57         
58         rna_def_path(brna, srna);
59         rna_def_nurbs(brna, srna);
60         rna_def_font(brna, srna);
61         
62         /* Number values */
63         prop= RNA_def_property(srna, "bevel_resolution", PROP_INT, PROP_NONE);
64         RNA_def_property_int_sdna(prop, NULL, "bevresol");
65         RNA_def_property_range(prop, 0, 32);
66         RNA_def_property_ui_text(prop, "Bevel Resolution", "Bevel resolution when depth is non-zero and no specific bevel object has been defined.");
67         
68         prop= RNA_def_property(srna, "width", PROP_FLOAT, PROP_NONE);
69         RNA_def_property_float_sdna(prop, NULL, "width");
70         RNA_def_property_range(prop, 0.0f, 2.0f);
71         RNA_def_property_ui_text(prop, "Width", "Scale the original width (1.0) based on given factor.");
72         
73         prop= RNA_def_property(srna, "extrude", PROP_FLOAT, PROP_NONE);
74         RNA_def_property_float_sdna(prop, NULL, "ext1");
75         RNA_def_property_range(prop, 0.0f, 100.0f);
76         RNA_def_property_ui_text(prop, "Extrude", "Amount of curve extrusion when not using a bevel object.");
77         
78         prop= RNA_def_property(srna, "bevel_depth", PROP_FLOAT, PROP_NONE);
79         RNA_def_property_float_sdna(prop, NULL, "ext2");
80         RNA_def_property_range(prop, 0.0f, 2.0f);
81         RNA_def_property_ui_text(prop, "Bevel Depth", "Bevel depth when not using a bevel object.");
82         
83         prop= RNA_def_property(srna, "resolution_u", PROP_INT, PROP_NONE);
84         RNA_def_property_int_sdna(prop, NULL, "resolu");
85         RNA_def_property_range(prop, 1, 1024);
86         RNA_def_property_ui_text(prop, "U Resolution", "Surface resolution in U direction.");
87         
88         prop= RNA_def_property(srna, "resolution_v", PROP_INT, PROP_NONE);
89         RNA_def_property_int_sdna(prop, NULL, "resolv");
90         RNA_def_property_range(prop, 1, 1024);
91         RNA_def_property_ui_text(prop, "V Resolution", "Surface resolution in V direction.");
92         
93         prop= RNA_def_property(srna, "resolution_u_rendering", PROP_INT, PROP_NONE);
94         RNA_def_property_int_sdna(prop, NULL, "resolu_ren");
95         RNA_def_property_range(prop, 0, 1024);
96         RNA_def_property_ui_text(prop, "U Resolution (Rendering)", "Surface resolution in U direction used while rendering. Zero skips this property.");
97         
98         prop= RNA_def_property(srna, "resolution_v_rendering", PROP_INT, PROP_NONE);
99         RNA_def_property_int_sdna(prop, NULL, "resolv_ren");
100         RNA_def_property_range(prop, 0, 1024);
101         RNA_def_property_ui_text(prop, "V Resolution (Rendering)", "Surface resolution in V direction used while rendering. Zero skips this property.");
102         
103         /* pointers */
104         prop= RNA_def_property(srna, "bevel_object", PROP_POINTER, PROP_NONE);
105         RNA_def_property_struct_type(prop, "Object");
106         RNA_def_property_pointer_sdna(prop, NULL, "bevobj");
107         RNA_def_property_ui_text(prop, "Bevel Object", "Curve object name that defines the bevel shape.");
108         
109         prop= RNA_def_property(srna, "taper_object", PROP_POINTER, PROP_NONE);
110         RNA_def_property_struct_type(prop, "Object");
111         RNA_def_property_pointer_sdna(prop, NULL, "taperobj");
112         RNA_def_property_ui_text(prop, "Taper Object", "Curve object name that defines the taper (width).");
113         
114         /* Flags */
115         prop= RNA_def_property(srna, "3d", PROP_BOOLEAN, PROP_NONE);
116         RNA_def_property_boolean_sdna(prop, NULL, "flag", CU_3D);
117         RNA_def_property_ui_text(prop, "3D Curve", "Define curve in three dimensions. Note that in this case fill won't work.");
118         
119         prop= RNA_def_property(srna, "front", PROP_BOOLEAN, PROP_NONE);
120         RNA_def_property_boolean_sdna(prop, NULL, "flag", CU_FRONT);
121         RNA_def_property_ui_text(prop, "Front", "Draw filled front for extruded/beveled curves.");
122         
123         prop= RNA_def_property(srna, "back", PROP_BOOLEAN, PROP_NONE);
124         RNA_def_property_boolean_sdna(prop, NULL, "flag", CU_BACK);
125         RNA_def_property_ui_text(prop, "Back", "Draw filled back for extruded/beveled curves.");
126         
127         prop= RNA_def_property(srna, "retopo", PROP_BOOLEAN, PROP_NONE);
128         RNA_def_property_boolean_sdna(prop, NULL, "flag", CU_RETOPO);
129         RNA_def_property_ui_text(prop, "Retopo", "Turn on the re-topology tool.");
130 }
131
132 static void rna_def_path(BlenderRNA *brna, StructRNA *srna)
133 {
134         PropertyRNA *prop;
135         
136         /* number values */
137         prop= RNA_def_property(srna, "path_length", PROP_INT, PROP_NONE);
138         RNA_def_property_int_sdna(prop, NULL, "pathlen");
139         RNA_def_property_range(prop, 1, 32767);
140         RNA_def_property_ui_text(prop, "Path Length", "If no speed IPO was set, the length of path in frames.");
141         
142         /* flags */
143         prop= RNA_def_property(srna, "path", PROP_BOOLEAN, PROP_NONE);
144         RNA_def_property_boolean_sdna(prop, NULL, "flag", CU_PATH);
145         RNA_def_property_ui_text(prop, "Path", "Enable the curve to become a translation path.");
146         
147         prop= RNA_def_property(srna, "follow", PROP_BOOLEAN, PROP_NONE);
148         RNA_def_property_boolean_sdna(prop, NULL, "flag", CU_FOLLOW);
149         RNA_def_property_ui_text(prop, "Follow", "Make curve path children to rotate along the path.");
150         
151         prop= RNA_def_property(srna, "stretch", PROP_BOOLEAN, PROP_NONE);
152         RNA_def_property_boolean_sdna(prop, NULL, "flag", CU_STRETCH);
153         RNA_def_property_ui_text(prop, "Stretch", "Option for curve-deform: makes deformed child to stretch along entire path.");
154         
155         prop= RNA_def_property(srna, "offset_path_distance", PROP_BOOLEAN, PROP_NONE);
156         RNA_def_property_boolean_sdna(prop, NULL, "flag", CU_OFFS_PATHDIST);
157         RNA_def_property_ui_text(prop, "Offset Path Distance", "Children will use TimeOffs value as path distance offset.");
158 }
159
160 static void rna_def_nurbs(BlenderRNA *brna, StructRNA *srna)
161 {
162         PropertyRNA *prop;
163         
164         /* flags */
165         prop= RNA_def_property(srna, "uv_orco", PROP_BOOLEAN, PROP_NONE);
166         RNA_def_property_boolean_sdna(prop, NULL, "flag", CU_UV_ORCO);
167         RNA_def_property_ui_text(prop, "UV Orco", "Forces to use UV coordinates for texture mapping 'orco'.");
168         
169         prop= RNA_def_property(srna, "no_puno_flip", PROP_BOOLEAN, PROP_NONE);
170         RNA_def_property_boolean_sdna(prop, NULL, "flag", CU_NOPUNOFLIP);
171         RNA_def_property_ui_text(prop, "No Puno Flip", "Don't flip vertex normals while rendering.");
172 }
173
174 static void rna_def_font(BlenderRNA *brna, StructRNA *srna)
175 {
176         PropertyRNA *prop;
177         
178         /* number values */
179         prop= RNA_def_property(srna, "text_size", PROP_FLOAT, PROP_NONE);
180         RNA_def_property_float_sdna(prop, NULL, "fsize");
181         RNA_def_property_range(prop, 0.1f, 10.0f);
182         RNA_def_property_ui_text(prop, "Text Size", "");
183         
184         prop= RNA_def_property(srna, "line_dist", PROP_FLOAT, PROP_NONE);
185         RNA_def_property_float_sdna(prop, NULL, "linedist");
186         RNA_def_property_range(prop, 0.0f, 10.0f);
187         RNA_def_property_ui_text(prop, "Distance Between Lines of Text", "");
188         
189         prop= RNA_def_property(srna, "word_spacing", PROP_FLOAT, PROP_NONE);
190         RNA_def_property_float_sdna(prop, NULL, "wordspace");
191         RNA_def_property_range(prop, 0.0f, 10.0f);
192         RNA_def_property_ui_text(prop, "Word Spacing", "");
193         
194         prop= RNA_def_property(srna, "spacing", PROP_FLOAT, PROP_NONE);
195         RNA_def_property_float_sdna(prop, NULL, "spacing");
196         RNA_def_property_range(prop, 0.0f, 10.0f);
197         RNA_def_property_ui_text(prop, "Character Spacing", "");
198         
199         prop= RNA_def_property(srna, "shear", PROP_FLOAT, PROP_NONE);
200         RNA_def_property_float_sdna(prop, NULL, "shear");
201         RNA_def_property_range(prop, -1.0f, 1.0f);
202         RNA_def_property_ui_text(prop, "Shear", "Italic angle of the characters.");
203         
204         prop= RNA_def_property(srna, "x_offset", PROP_FLOAT, PROP_NONE);
205         RNA_def_property_float_sdna(prop, NULL, "xof");
206         RNA_def_property_range(prop, -50.0f, 50.0f);
207         RNA_def_property_ui_text(prop, "X Offset", "Horizontal offset from the object center.");
208         
209         prop= RNA_def_property(srna, "y_offset", PROP_FLOAT, PROP_NONE);
210         RNA_def_property_float_sdna(prop, NULL, "yof");
211         RNA_def_property_range(prop, -50.0f, 50.0f);
212         RNA_def_property_ui_text(prop, "Y Offset", "Vertical offset from the object center.");
213         
214         prop= RNA_def_property(srna, "ul_position", PROP_FLOAT, PROP_NONE);
215         RNA_def_property_float_sdna(prop, NULL, "ulpos");
216         RNA_def_property_range(prop, -0.2f, 0.8f);
217         RNA_def_property_ui_text(prop, "Underline Position", "Vertical position of underline.");
218         
219         prop= RNA_def_property(srna, "ul_height", PROP_FLOAT, PROP_NONE);
220         RNA_def_property_float_sdna(prop, NULL, "ulheight");
221         RNA_def_property_range(prop, -0.2f, 0.8f);
222         RNA_def_property_ui_text(prop, "Underline Thickness", "");
223         
224         prop= RNA_def_property(srna, "active_textbox", PROP_INT, PROP_NONE);
225         RNA_def_property_int_sdna(prop, NULL, "actbox");
226         RNA_def_property_range(prop, 0, 100);
227         RNA_def_property_ui_text(prop, "Active Textbox", "");
228         
229         /* strings */
230         prop= RNA_def_property(srna, "family", PROP_STRING, PROP_NONE);
231         RNA_def_property_string_maxlength(prop, 21);
232         RNA_def_property_ui_text(prop, "Family", "Blender uses font from selfmade objects.");
233         
234         prop= RNA_def_property(srna, "str", PROP_STRING, PROP_NONE);
235         RNA_def_property_string_sdna(prop, NULL, "str");
236         RNA_def_property_ui_text(prop, "String", "");
237         RNA_def_property_string_funcs(prop, "rna_ID_name_get", "rna_ID_name_length", "rna_ID_name_set");
238         RNA_def_property_string_maxlength(prop, 8192); /* note that originally str did not have a limit! */
239         RNA_def_struct_name_property(srna, prop);
240         
241         /* pointers */
242         prop= RNA_def_property(srna, "text_on_curve", PROP_POINTER, PROP_NONE);
243         RNA_def_property_struct_type(prop, "Object");
244         RNA_def_property_pointer_sdna(prop, NULL, "textoncurve");
245         RNA_def_property_ui_text(prop, "Text on Curve", "Curve deforming text object.");
246         
247         prop= RNA_def_property(srna, "font", PROP_POINTER, PROP_NONE);
248         RNA_def_property_struct_type(prop, "VectorFont");
249         RNA_def_property_pointer_sdna(prop, NULL, "vfont");
250         RNA_def_property_ui_text(prop, "Font", "");
251         
252         prop= RNA_def_property(srna, "textbox", PROP_POINTER, PROP_NONE);
253         RNA_def_property_struct_type(prop, "TextBox");
254         RNA_def_property_pointer_sdna(prop, NULL, "tb");
255         RNA_def_property_ui_text(prop, "Textbox", "");
256         
257         /*
258         TODO: struct CharInfo curinfo;
259         
260         Obviously a pointer won't work in this case.
261         */
262         /*
263         prop= RNA_def_property(srna, "curinfo", PROP_POINTER, PROP_NONE);
264         RNA_def_property_struct_type(prop, "CharInfo");
265         RNA_def_property_pointer_sdna(prop, NULL, "curinfo");
266         RNA_def_property_ui_text(prop, "curinfo", "");
267         */
268         
269         /* flags */
270         prop= RNA_def_property(srna, "fast", PROP_BOOLEAN, PROP_NONE);
271         RNA_def_property_boolean_sdna(prop, NULL, "flag", CU_FAST);
272         RNA_def_property_ui_text(prop, "Fast", "Don't fill polygons while editing.");
273         
274         prop= RNA_def_property(srna, "left_align", PROP_BOOLEAN, PROP_NONE);
275         RNA_def_property_boolean_sdna(prop, NULL, "spacemode", CU_LEFT);
276         RNA_def_property_ui_text(prop, "Left Align", "Left align the text from the object center.");
277         
278         prop= RNA_def_property(srna, "middle_align", PROP_BOOLEAN, PROP_NONE);
279         RNA_def_property_boolean_sdna(prop, NULL, "spacemode", CU_MIDDLE);
280         RNA_def_property_ui_text(prop, "Middle Align", "Middle align the text from the object center.");
281         
282         prop= RNA_def_property(srna, "right_align", PROP_BOOLEAN, PROP_NONE);
283         RNA_def_property_boolean_sdna(prop, NULL, "spacemode", CU_RIGHT);
284         RNA_def_property_ui_text(prop, "Right Align", "Right align the text from the object center.");
285         
286         prop= RNA_def_property(srna, "justify", PROP_BOOLEAN, PROP_NONE);
287         RNA_def_property_boolean_sdna(prop, NULL, "spacemode", CU_JUSTIFY);
288         RNA_def_property_ui_text(prop, "Justify", "Fill complete lines to maximum textframe width.");
289         
290         prop= RNA_def_property(srna, "flush", PROP_BOOLEAN, PROP_NONE);
291         RNA_def_property_boolean_sdna(prop, NULL, "spacemode", CU_FLUSH);
292         RNA_def_property_ui_text(prop, "Left Align", "Fill every line to maximum textframe width distributing space among all characters.");
293 }
294
295 void rna_def_textbox(BlenderRNA *brna)
296 {
297         StructRNA *srna;
298         PropertyRNA *prop;
299         
300         srna= RNA_def_struct(brna, "TextBox", NULL, "TextBox");
301         
302         /* number values */
303         prop= RNA_def_property(srna, "x", PROP_FLOAT, PROP_NONE);
304         RNA_def_property_float_sdna(prop, NULL, "x");
305         RNA_def_property_range(prop, -50.0f, 50.0f);
306         RNA_def_property_ui_text(prop, "Textbox X Offset", "");
307         
308         prop= RNA_def_property(srna, "y", PROP_FLOAT, PROP_NONE);
309         RNA_def_property_float_sdna(prop, NULL, "y");
310         RNA_def_property_range(prop, -50.0f, 50.0f);
311         RNA_def_property_ui_text(prop, "Textbox Y Offset", "");
312
313         prop= RNA_def_property(srna, "width", PROP_FLOAT, PROP_NONE);
314         RNA_def_property_float_sdna(prop, NULL, "w");
315         RNA_def_property_range(prop, 0.0f, 50.0f);
316         RNA_def_property_ui_text(prop, "Textbox Width", "");
317
318         prop= RNA_def_property(srna, "height", PROP_FLOAT, PROP_NONE);
319         RNA_def_property_float_sdna(prop, NULL, "h");
320         RNA_def_property_range(prop, 0.0f, 50.0f);
321         RNA_def_property_ui_text(prop, "Textbox Height", "");
322 }
323
324 void rna_def_charinfo(BlenderRNA *brna)
325 {
326         StructRNA *srna;
327         PropertyRNA *prop;
328         
329         srna= RNA_def_struct(brna, "CharInfo", NULL, "CharInfo");
330         
331         /* flags */
332         prop= RNA_def_property(srna, "style", PROP_BOOLEAN, PROP_NONE);
333         RNA_def_property_boolean_sdna(prop, NULL, "flag", CU_STYLE);
334         RNA_def_property_ui_text(prop, "Style", "");
335         
336         prop= RNA_def_property(srna, "bold", PROP_BOOLEAN, PROP_NONE);
337         RNA_def_property_boolean_sdna(prop, NULL, "flag", CU_BOLD);
338         RNA_def_property_ui_text(prop, "Bold", "");
339         
340         prop= RNA_def_property(srna, "italic", PROP_BOOLEAN, PROP_NONE);
341         RNA_def_property_boolean_sdna(prop, NULL, "flag", CU_ITALIC);
342         RNA_def_property_ui_text(prop, "Italic", "");
343         
344         prop= RNA_def_property(srna, "underline", PROP_BOOLEAN, PROP_NONE);
345         RNA_def_property_boolean_sdna(prop, NULL, "flag", CU_UNDERLINE);
346         RNA_def_property_ui_text(prop, "Underline", "");
347         
348         prop= RNA_def_property(srna, "wrap", PROP_BOOLEAN, PROP_NONE);
349         RNA_def_property_boolean_sdna(prop, NULL, "flag", CU_WRAP);
350         RNA_def_property_ui_text(prop, "Wrap", "");
351 }
352
353 void RNA_def_curve(BlenderRNA *brna)
354 {
355         rna_def_curve(brna);
356         rna_def_textbox(brna);
357         rna_def_charinfo(brna);
358 }
359
360 #endif