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