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