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