Node socket values now only have soft limits, rather than hard limits, so you
[blender.git] / source / blender / makesrna / intern / rna_lattice.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributor(s): Blender Foundation (2008).
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/makesrna/intern/rna_lattice.c
24  *  \ingroup RNA
25  */
26
27
28 #include <stdlib.h>
29
30 #include "RNA_define.h"
31
32 #include "rna_internal.h"
33
34 #include "DNA_curve_types.h"
35 #include "DNA_key_types.h"
36 #include "DNA_lattice_types.h"
37 #include "DNA_meshdata_types.h"
38
39 #ifdef RNA_RUNTIME
40
41 #include "DNA_object_types.h"
42 #include "DNA_scene_types.h"
43
44 #include "BKE_depsgraph.h"
45 #include "BKE_lattice.h"
46 #include "BKE_main.h"
47 #include "BKE_deform.h"
48
49 #include "WM_api.h"
50 #include "WM_types.h"
51
52 static void rna_LatticePoint_co_get(PointerRNA *ptr, float *values)
53 {
54         Lattice *lt = (Lattice*)ptr->id.data;
55         BPoint *bp = (BPoint*)ptr->data;
56         int a = bp - lt->def;
57         int x = a % lt->pntsu;
58         int y = (a/lt->pntsu) % lt->pntsv;
59         int z = (a/(lt->pntsu*lt->pntsv));
60
61         values[0] = lt->fu + x*lt->du;
62         values[1] = lt->fv + y*lt->dv;
63         values[2] = lt->fw + z*lt->dw;
64 }
65
66 static void rna_LatticePoint_groups_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
67 {
68         Lattice *lt = (Lattice*)ptr->id.data;
69
70         if (lt->dvert) {
71                 BPoint *bp = (BPoint*)ptr->data;
72                 MDeformVert *dvert = lt->dvert + (bp-lt->def);
73
74                 rna_iterator_array_begin(iter, (void*)dvert->dw, sizeof(MDeformWeight), dvert->totweight, 0, NULL);
75         }
76         else
77                 rna_iterator_array_begin(iter, NULL, 0, 0, 0, NULL);
78 }
79
80 static void rna_Lattice_points_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
81 {
82         Lattice *lt = (Lattice*)ptr->data;
83         int tot = lt->pntsu*lt->pntsv*lt->pntsw;
84
85         if (lt->editlatt && lt->editlatt->latt->def)
86                 rna_iterator_array_begin(iter, (void*)lt->editlatt->latt->def, sizeof(BPoint), tot, 0, NULL);
87         else if (lt->def)
88                 rna_iterator_array_begin(iter, (void*)lt->def, sizeof(BPoint), tot, 0, NULL);
89         else
90                 rna_iterator_array_begin(iter, NULL, 0, 0, 0, NULL);
91 }
92
93 static void rna_Lattice_update_data(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
94 {
95         ID *id = ptr->id.data;
96
97         DAG_id_tag_update(id, 0);
98         WM_main_add_notifier(NC_GEOM|ND_DATA, id);
99 }
100
101 static void rna_Lattice_update_size(Main *bmain, Scene *scene, PointerRNA *ptr)
102 {
103         Lattice *lt = ptr->id.data;
104         Object *ob;
105         int newu, newv, neww;
106
107         /* we don't modify the actual pnts, but go through opnts instead */
108         newu = (lt->opntsu > 0)? lt->opntsu: lt->pntsu;
109         newv = (lt->opntsv > 0)? lt->opntsv: lt->pntsv;
110         neww = (lt->opntsw > 0)? lt->opntsw: lt->pntsw;
111
112         /* resizelattice needs an object, any object will have the same result */
113         for (ob = bmain->object.first; ob; ob = ob->id.next) {
114                 if (ob->data == lt) {
115                         resizelattice(lt, newu, newv, neww, ob);
116                         if (lt->editlatt)
117                                 resizelattice(lt->editlatt->latt, newu, newv, neww, ob);
118                         break;
119                 }
120         }
121
122         /* otherwise without, means old points are not repositioned */
123         if (!ob) {
124                 resizelattice(lt, newu, newv, neww, NULL);
125                 if (lt->editlatt)
126                         resizelattice(lt->editlatt->latt, newu, newv, neww, NULL);
127         }
128
129         rna_Lattice_update_data(bmain, scene, ptr);
130 }
131
132 static void rna_Lattice_use_outside_set(PointerRNA *ptr, int value)
133 {
134         Lattice *lt = ptr->data;
135
136         if (value) lt->flag |= LT_OUTSIDE;
137         else lt->flag &= ~LT_OUTSIDE;
138
139         outside_lattice(lt);
140
141         if (lt->editlatt) {
142                 if (value) lt->editlatt->latt->flag |= LT_OUTSIDE;
143                 else lt->editlatt->latt->flag &= ~LT_OUTSIDE;
144
145                 outside_lattice(lt->editlatt->latt);
146         }
147 }
148
149 static int rna_Lattice_size_editable(PointerRNA *ptr)
150 {
151         Lattice *lt = (Lattice*)ptr->data;
152
153         return lt->key == NULL;
154 }
155
156 static void rna_Lattice_points_u_set(PointerRNA *ptr, int value)
157 {
158         Lattice *lt = (Lattice*)ptr->data;
159
160         lt->opntsu = CLAMPIS(value, 1, 64);
161 }
162
163 static void rna_Lattice_points_v_set(PointerRNA *ptr, int value)
164 {
165         Lattice *lt = (Lattice*)ptr->data;
166
167         lt->opntsv = CLAMPIS(value, 1, 64);
168 }
169
170 static void rna_Lattice_points_w_set(PointerRNA *ptr, int value)
171 {
172         Lattice *lt = (Lattice*)ptr->data;
173
174         lt->opntsw = CLAMPIS(value, 1, 64);
175 }
176
177 static void rna_Lattice_vg_name_set(PointerRNA *ptr, const char *value)
178 {
179         Lattice *lt = ptr->data;
180         BLI_strncpy(lt->vgroup, value, sizeof(lt->vgroup));
181
182         if (lt->editlatt) {
183                 BLI_strncpy(lt->editlatt->latt->vgroup, value, sizeof(lt->editlatt->latt->vgroup));
184         }
185 }
186
187 /* annoying, but is a consequence of RNA structures... */
188 static char *rna_LatticePoint_path(PointerRNA *ptr)
189 {
190         Lattice *lt = (Lattice*)ptr->id.data;
191         void *point = ptr->data;
192         BPoint *points = NULL;
193         
194         if (lt->editlatt && lt->editlatt->latt->def)
195                 points = lt->editlatt->latt->def;
196         else
197                 points = lt->def;
198         
199         if (points && point) {
200                 int tot = lt->pntsu*lt->pntsv*lt->pntsw;
201                 
202                 /* only return index if in range */
203                 if ((point >= (void *)points) && (point < (void *)(points + tot))) {
204                         int pt_index = (int)((BPoint *)point - points);
205                         
206                         return BLI_sprintfN("points[%d]", pt_index);
207                 }
208         }
209
210         return BLI_strdup("");
211 }
212
213
214 #else
215
216 static void rna_def_latticepoint(BlenderRNA *brna)
217 {
218         StructRNA *srna;
219         PropertyRNA *prop;
220
221         srna = RNA_def_struct(brna, "LatticePoint", NULL);
222         RNA_def_struct_sdna(srna, "BPoint");
223         RNA_def_struct_ui_text(srna, "LatticePoint", "Point in the lattice grid");
224         RNA_def_struct_path_func(srna, "rna_LatticePoint_path");
225
226         prop = RNA_def_property(srna, "co", PROP_FLOAT, PROP_TRANSLATION);
227         RNA_def_property_array(prop, 3);
228         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
229         RNA_def_property_float_funcs(prop, "rna_LatticePoint_co_get", NULL, NULL);
230         RNA_def_property_ui_text(prop, "Location", "");
231
232         prop = RNA_def_property(srna, "co_deform", PROP_FLOAT, PROP_TRANSLATION);
233         RNA_def_property_float_sdna(prop, NULL, "vec");
234         RNA_def_property_array(prop, 3);
235         RNA_def_property_ui_text(prop, "Deformed Location", "");
236         RNA_def_property_update(prop, 0, "rna_Lattice_update_data");
237
238         prop = RNA_def_property(srna, "groups", PROP_COLLECTION, PROP_NONE);
239         RNA_def_property_collection_funcs(prop, "rna_LatticePoint_groups_begin", "rna_iterator_array_next",
240                                           "rna_iterator_array_end", "rna_iterator_array_get",
241                                           NULL, NULL, NULL, NULL);
242         RNA_def_property_struct_type(prop, "VertexGroupElement");
243         RNA_def_property_ui_text(prop, "Groups", "Weights for the vertex groups this point is member of");
244 }
245
246 static void rna_def_lattice(BlenderRNA *brna)
247 {
248         StructRNA *srna;
249         PropertyRNA *prop;
250
251         static EnumPropertyItem prop_keyblock_type_items[] = {
252                 {KEY_LINEAR, "KEY_LINEAR", 0, "Linear", ""},
253                 {KEY_CARDINAL, "KEY_CARDINAL", 0, "Cardinal", ""},
254                 {KEY_BSPLINE, "KEY_BSPLINE", 0, "BSpline", ""},
255                 {0, NULL, 0, NULL, NULL}};
256
257         srna = RNA_def_struct(brna, "Lattice", "ID");
258         RNA_def_struct_ui_text(srna, "Lattice", "Lattice datablock defining a grid for deforming other objects");
259         RNA_def_struct_ui_icon(srna, ICON_LATTICE_DATA);
260
261         prop = RNA_def_property(srna, "points_u", PROP_INT, PROP_NONE);
262         RNA_def_property_int_sdna(prop, NULL, "pntsu");
263         RNA_def_property_int_funcs(prop, NULL, "rna_Lattice_points_u_set", NULL);
264         RNA_def_property_range(prop, 1, 64);
265         RNA_def_property_ui_text(prop, "U", "Point in U direction (can't be changed when there are shape keys)");
266         RNA_def_property_update(prop, 0, "rna_Lattice_update_size");
267         RNA_def_property_editable_func(prop, "rna_Lattice_size_editable");
268
269         prop = RNA_def_property(srna, "points_v", PROP_INT, PROP_NONE);
270         RNA_def_property_int_sdna(prop, NULL, "pntsv");
271         RNA_def_property_int_funcs(prop, NULL, "rna_Lattice_points_v_set", NULL);
272         RNA_def_property_range(prop, 1, 64);
273         RNA_def_property_ui_text(prop, "V", "Point in V direction (can't be changed when there are shape keys)");
274         RNA_def_property_update(prop, 0, "rna_Lattice_update_size");
275         RNA_def_property_editable_func(prop, "rna_Lattice_size_editable");
276
277         prop = RNA_def_property(srna, "points_w", PROP_INT, PROP_NONE);
278         RNA_def_property_int_sdna(prop, NULL, "pntsw");
279         RNA_def_property_int_funcs(prop, NULL, "rna_Lattice_points_w_set", NULL);
280         RNA_def_property_range(prop, 1, 64);
281         RNA_def_property_ui_text(prop, "W", "Point in W direction (can't be changed when there are shape keys)");
282         RNA_def_property_update(prop, 0, "rna_Lattice_update_size");
283         RNA_def_property_editable_func(prop, "rna_Lattice_size_editable");
284
285         prop = RNA_def_property(srna, "interpolation_type_u", PROP_ENUM, PROP_NONE);
286         RNA_def_property_enum_sdna(prop, NULL, "typeu");
287         RNA_def_property_enum_items(prop, prop_keyblock_type_items);
288         RNA_def_property_ui_text(prop, "Interpolation Type U", "");
289         RNA_def_property_update(prop, 0, "rna_Lattice_update_data");
290
291         prop = RNA_def_property(srna, "interpolation_type_v", PROP_ENUM, PROP_NONE);
292         RNA_def_property_enum_sdna(prop, NULL, "typev");
293         RNA_def_property_enum_items(prop, prop_keyblock_type_items);
294         RNA_def_property_ui_text(prop, "Interpolation Type V", "");
295         RNA_def_property_update(prop, 0, "rna_Lattice_update_data");
296
297         prop = RNA_def_property(srna, "interpolation_type_w", PROP_ENUM, PROP_NONE);
298         RNA_def_property_enum_sdna(prop, NULL, "typew");
299         RNA_def_property_enum_items(prop, prop_keyblock_type_items);
300         RNA_def_property_ui_text(prop, "Interpolation Type W", "");
301         RNA_def_property_update(prop, 0, "rna_Lattice_update_data");
302
303         prop = RNA_def_property(srna, "use_outside", PROP_BOOLEAN, PROP_NONE);
304         RNA_def_property_boolean_sdna(prop, NULL, "flag", LT_OUTSIDE);
305         RNA_def_property_boolean_funcs(prop, NULL, "rna_Lattice_use_outside_set");
306         RNA_def_property_ui_text(prop, "Outside", "Only draw, and take into account, the outer vertices");
307         RNA_def_property_update(prop, 0, "rna_Lattice_update_data");
308         
309         prop = RNA_def_property(srna, "vertex_group", PROP_STRING, PROP_NONE);
310         RNA_def_property_string_sdna(prop, NULL, "vgroup");
311         RNA_def_property_ui_text(prop, "Vertex Group", "Vertex group to apply the influence of the lattice");
312         RNA_def_property_string_funcs(prop, NULL, NULL, "rna_Lattice_vg_name_set");
313         RNA_def_property_update(prop, 0, "rna_Lattice_update_data");
314
315         prop = RNA_def_property(srna, "shape_keys", PROP_POINTER, PROP_NONE);
316         RNA_def_property_pointer_sdna(prop, NULL, "key");
317         RNA_def_property_ui_text(prop, "Shape Keys", "");
318
319         prop = RNA_def_property(srna, "points", PROP_COLLECTION, PROP_NONE);
320         RNA_def_property_struct_type(prop, "LatticePoint");
321         RNA_def_property_collection_funcs(prop, "rna_Lattice_points_begin", "rna_iterator_array_next",
322                                           "rna_iterator_array_end", "rna_iterator_array_get", NULL, NULL, NULL, NULL);
323         RNA_def_property_ui_text(prop, "Points", "Points of the lattice");
324         
325         /* pointers */
326         rna_def_animdata_common(srna);
327 }
328
329 void RNA_def_lattice(BlenderRNA *brna)
330 {
331         rna_def_lattice(brna);
332         rna_def_latticepoint(brna);
333 }
334
335 #endif