Merge branch 'master' into blender2.8
[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 #include <stdlib.h>
28
29 #include "DNA_curve_types.h"
30 #include "DNA_key_types.h"
31 #include "DNA_lattice_types.h"
32 #include "DNA_meshdata_types.h"
33
34 #include "BLI_utildefines.h"
35
36 #include "RNA_define.h"
37 #include "RNA_enum_types.h"
38 #include "rna_internal.h"
39
40 #ifdef RNA_RUNTIME
41
42 #include "DNA_object_types.h"
43 #include "DNA_scene_types.h"
44
45 #include "BLI_string.h"
46 #include "BKE_lattice.h"
47 #include "BKE_main.h"
48 #include "BKE_deform.h"
49
50 #include "DEG_depsgraph.h"
51
52 #include "WM_api.h"
53 #include "WM_types.h"
54 #include "ED_lattice.h"
55
56 static void rna_LatticePoint_co_get(PointerRNA *ptr, float *values)
57 {
58         Lattice *lt = (Lattice *)ptr->id.data;
59         BPoint *bp = (BPoint *)ptr->data;
60         int index = bp - lt->def;
61         int u, v, w;
62
63         BKE_lattice_index_to_uvw(lt, index, &u, &v, &w);
64
65         values[0] = lt->fu + u * lt->du;
66         values[1] = lt->fv + v * lt->dv;
67         values[2] = lt->fw + w * lt->dw;
68 }
69
70 static void rna_LatticePoint_groups_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
71 {
72         Lattice *lt = (Lattice *)ptr->id.data;
73
74         if (lt->dvert) {
75                 BPoint *bp = (BPoint *)ptr->data;
76                 MDeformVert *dvert = lt->dvert + (bp - lt->def);
77
78                 rna_iterator_array_begin(iter, (void *)dvert->dw, sizeof(MDeformWeight), dvert->totweight, 0, NULL);
79         }
80         else
81                 rna_iterator_array_begin(iter, NULL, 0, 0, 0, NULL);
82 }
83
84 static void rna_Lattice_points_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
85 {
86         Lattice *lt = (Lattice *)ptr->data;
87         int tot = lt->pntsu * lt->pntsv * lt->pntsw;
88
89         if (lt->editlatt && lt->editlatt->latt->def)
90                 rna_iterator_array_begin(iter, (void *)lt->editlatt->latt->def, sizeof(BPoint), tot, 0, NULL);
91         else if (lt->def)
92                 rna_iterator_array_begin(iter, (void *)lt->def, sizeof(BPoint), tot, 0, NULL);
93         else
94                 rna_iterator_array_begin(iter, NULL, 0, 0, 0, NULL);
95 }
96
97 static void rna_Lattice_update_data(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
98 {
99         ID *id = ptr->id.data;
100
101         DEG_id_tag_update(id, 0);
102         WM_main_add_notifier(NC_GEOM | ND_DATA, id);
103 }
104
105 /* copy settings to editlattice,
106  * we could split this up differently (one update call per property)
107  * but for now that's overkill
108  */
109 static void rna_Lattice_update_data_editlatt(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
110 {
111         ID *id = ptr->id.data;
112         Lattice *lt = (Lattice *)ptr->id.data;
113
114         if (lt->editlatt) {
115                 Lattice *lt_em = lt->editlatt->latt;
116                 lt_em->typeu = lt->typeu;
117                 lt_em->typev = lt->typev;
118                 lt_em->typew = lt->typew;
119                 lt_em->flag = lt->flag;
120                 BLI_strncpy(lt_em->vgroup, lt->vgroup, sizeof(lt_em->vgroup));
121         }
122
123         DEG_id_tag_update(id, 0);
124         WM_main_add_notifier(NC_GEOM | ND_DATA, id);
125 }
126
127 static void rna_Lattice_update_size(Main *bmain, Scene *scene, PointerRNA *ptr)
128 {
129         Lattice *lt = ptr->id.data;
130         Object *ob;
131         int newu, newv, neww;
132
133         /* we don't modify the actual pnts, but go through opnts instead */
134         newu = (lt->opntsu > 0) ? lt->opntsu : lt->pntsu;
135         newv = (lt->opntsv > 0) ? lt->opntsv : lt->pntsv;
136         neww = (lt->opntsw > 0) ? lt->opntsw : lt->pntsw;
137
138         /* BKE_lattice_resize needs an object, any object will have the same result */
139         for (ob = bmain->object.first; ob; ob = ob->id.next) {
140                 if (ob->data == lt) {
141                         BKE_lattice_resize(lt, newu, newv, neww, ob);
142                         if (lt->editlatt)
143                                 BKE_lattice_resize(lt->editlatt->latt, newu, newv, neww, ob);
144                         break;
145                 }
146         }
147
148         /* otherwise without, means old points are not repositioned */
149         if (!ob) {
150                 BKE_lattice_resize(lt, newu, newv, neww, NULL);
151                 if (lt->editlatt)
152                         BKE_lattice_resize(lt->editlatt->latt, newu, newv, neww, NULL);
153         }
154
155         rna_Lattice_update_data(bmain, scene, ptr);
156 }
157
158 static void rna_Lattice_use_outside_set(PointerRNA *ptr, bool value)
159 {
160         Lattice *lt = ptr->data;
161
162         if (value) lt->flag |= LT_OUTSIDE;
163         else lt->flag &= ~LT_OUTSIDE;
164
165         outside_lattice(lt);
166
167         if (lt->editlatt) {
168                 if (value) lt->editlatt->latt->flag |= LT_OUTSIDE;
169                 else lt->editlatt->latt->flag &= ~LT_OUTSIDE;
170
171                 outside_lattice(lt->editlatt->latt);
172         }
173 }
174
175 static int rna_Lattice_size_editable(PointerRNA *ptr, const char **UNUSED(r_info))
176 {
177         Lattice *lt = (Lattice *)ptr->data;
178
179         return (lt->key == NULL) ? PROP_EDITABLE : 0;
180 }
181
182 static void rna_Lattice_points_u_set(PointerRNA *ptr, int value)
183 {
184         Lattice *lt = (Lattice *)ptr->data;
185
186         lt->opntsu = CLAMPIS(value, 1, 64);
187 }
188
189 static void rna_Lattice_points_v_set(PointerRNA *ptr, int value)
190 {
191         Lattice *lt = (Lattice *)ptr->data;
192
193         lt->opntsv = CLAMPIS(value, 1, 64);
194 }
195
196 static void rna_Lattice_points_w_set(PointerRNA *ptr, int value)
197 {
198         Lattice *lt = (Lattice *)ptr->data;
199
200         lt->opntsw = CLAMPIS(value, 1, 64);
201 }
202
203 static void rna_Lattice_vg_name_set(PointerRNA *ptr, const char *value)
204 {
205         Lattice *lt = ptr->data;
206         BLI_strncpy(lt->vgroup, value, sizeof(lt->vgroup));
207
208         if (lt->editlatt) {
209                 BLI_strncpy(lt->editlatt->latt->vgroup, value, sizeof(lt->editlatt->latt->vgroup));
210         }
211 }
212
213 /* annoying, but is a consequence of RNA structures... */
214 static char *rna_LatticePoint_path(PointerRNA *ptr)
215 {
216         Lattice *lt = (Lattice *)ptr->id.data;
217         void *point = ptr->data;
218         BPoint *points = NULL;
219
220         if (lt->editlatt && lt->editlatt->latt->def)
221                 points = lt->editlatt->latt->def;
222         else
223                 points = lt->def;
224
225         if (points && point) {
226                 int tot = lt->pntsu * lt->pntsv * lt->pntsw;
227
228                 /* only return index if in range */
229                 if ((point >= (void *)points) && (point < (void *)(points + tot))) {
230                         int pt_index = (int)((BPoint *)point - points);
231
232                         return BLI_sprintfN("points[%d]", pt_index);
233                 }
234         }
235
236         return BLI_strdup("");
237 }
238
239 static bool rna_Lattice_is_editmode_get(PointerRNA *ptr)
240 {
241         Lattice *lt = (Lattice *)ptr->id.data;
242         return (lt->editlatt != NULL);
243 }
244
245 #else
246
247 static void rna_def_latticepoint(BlenderRNA *brna)
248 {
249         StructRNA *srna;
250         PropertyRNA *prop;
251
252         srna = RNA_def_struct(brna, "LatticePoint", NULL);
253         RNA_def_struct_sdna(srna, "BPoint");
254         RNA_def_struct_ui_text(srna, "LatticePoint", "Point in the lattice grid");
255         RNA_def_struct_path_func(srna, "rna_LatticePoint_path");
256
257         prop = RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
258         RNA_def_property_boolean_sdna(prop, NULL, "f1", 0);
259         RNA_def_property_ui_text(prop, "Point selected", "Selection status");
260
261         prop = RNA_def_property(srna, "co", PROP_FLOAT, PROP_TRANSLATION);
262         RNA_def_property_array(prop, 3);
263         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
264         RNA_def_property_float_funcs(prop, "rna_LatticePoint_co_get", NULL, NULL);
265         RNA_def_property_ui_text(prop, "Location",
266                                  "Original undeformed location used to calculate the strength of the deform effect "
267                                  "(edit/animate the Deformed Location instead)");
268
269         prop = RNA_def_property(srna, "co_deform", PROP_FLOAT, PROP_TRANSLATION);
270         RNA_def_property_float_sdna(prop, NULL, "vec");
271         RNA_def_property_array(prop, 3);
272         RNA_def_property_ui_text(prop, "Deformed Location", "");
273         RNA_def_property_update(prop, 0, "rna_Lattice_update_data");
274
275         prop = RNA_def_property(srna, "weight_softbody", PROP_FLOAT, PROP_NONE);
276         RNA_def_property_float_sdna(prop, NULL, "weight");
277         RNA_def_property_range(prop, 0.01f, 100.0f);
278         RNA_def_property_ui_text(prop, "Weight", "Softbody goal weight");
279         RNA_def_property_update(prop, 0, "rna_Lattice_update_data");
280
281         prop = RNA_def_property(srna, "groups", PROP_COLLECTION, PROP_NONE);
282         RNA_def_property_collection_funcs(prop, "rna_LatticePoint_groups_begin", "rna_iterator_array_next",
283                                           "rna_iterator_array_end", "rna_iterator_array_get",
284                                           NULL, NULL, NULL, NULL);
285         RNA_def_property_struct_type(prop, "VertexGroupElement");
286         RNA_def_property_ui_text(prop, "Groups", "Weights for the vertex groups this point is member of");
287 }
288
289 static void rna_def_lattice(BlenderRNA *brna)
290 {
291         StructRNA *srna;
292         PropertyRNA *prop;
293
294         srna = RNA_def_struct(brna, "Lattice", "ID");
295         RNA_def_struct_ui_text(srna, "Lattice", "Lattice data-block defining a grid for deforming other objects");
296         RNA_def_struct_ui_icon(srna, ICON_LATTICE_DATA);
297
298         prop = RNA_def_property(srna, "points_u", PROP_INT, PROP_NONE);
299         RNA_def_property_int_sdna(prop, NULL, "pntsu");
300         RNA_def_property_int_funcs(prop, NULL, "rna_Lattice_points_u_set", NULL);
301         RNA_def_property_range(prop, 1, 64);
302         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
303         RNA_def_property_ui_text(prop, "U", "Point in U direction (can't be changed when there are shape keys)");
304         RNA_def_property_update(prop, 0, "rna_Lattice_update_size");
305         RNA_def_property_editable_func(prop, "rna_Lattice_size_editable");
306
307         prop = RNA_def_property(srna, "points_v", PROP_INT, PROP_NONE);
308         RNA_def_property_int_sdna(prop, NULL, "pntsv");
309         RNA_def_property_int_funcs(prop, NULL, "rna_Lattice_points_v_set", NULL);
310         RNA_def_property_range(prop, 1, 64);
311         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
312         RNA_def_property_ui_text(prop, "V", "Point in V direction (can't be changed when there are shape keys)");
313         RNA_def_property_update(prop, 0, "rna_Lattice_update_size");
314         RNA_def_property_editable_func(prop, "rna_Lattice_size_editable");
315
316         prop = RNA_def_property(srna, "points_w", PROP_INT, PROP_NONE);
317         RNA_def_property_int_sdna(prop, NULL, "pntsw");
318         RNA_def_property_int_funcs(prop, NULL, "rna_Lattice_points_w_set", NULL);
319         RNA_def_property_range(prop, 1, 64);
320         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
321         RNA_def_property_ui_text(prop, "W", "Point in W direction (can't be changed when there are shape keys)");
322         RNA_def_property_update(prop, 0, "rna_Lattice_update_size");
323         RNA_def_property_editable_func(prop, "rna_Lattice_size_editable");
324
325         prop = RNA_def_property(srna, "interpolation_type_u", PROP_ENUM, PROP_NONE);
326         RNA_def_property_enum_sdna(prop, NULL, "typeu");
327         RNA_def_property_enum_items(prop, rna_enum_keyblock_type_items);
328         RNA_def_property_ui_text(prop, "Interpolation Type U", "");
329         RNA_def_property_update(prop, 0, "rna_Lattice_update_data_editlatt");
330
331         prop = RNA_def_property(srna, "interpolation_type_v", PROP_ENUM, PROP_NONE);
332         RNA_def_property_enum_sdna(prop, NULL, "typev");
333         RNA_def_property_enum_items(prop, rna_enum_keyblock_type_items);
334         RNA_def_property_ui_text(prop, "Interpolation Type V", "");
335         RNA_def_property_update(prop, 0, "rna_Lattice_update_data_editlatt");
336
337         prop = RNA_def_property(srna, "interpolation_type_w", PROP_ENUM, PROP_NONE);
338         RNA_def_property_enum_sdna(prop, NULL, "typew");
339         RNA_def_property_enum_items(prop, rna_enum_keyblock_type_items);
340         RNA_def_property_ui_text(prop, "Interpolation Type W", "");
341         RNA_def_property_update(prop, 0, "rna_Lattice_update_data_editlatt");
342
343         prop = RNA_def_property(srna, "use_outside", PROP_BOOLEAN, PROP_NONE);
344         RNA_def_property_boolean_sdna(prop, NULL, "flag", LT_OUTSIDE);
345         RNA_def_property_boolean_funcs(prop, NULL, "rna_Lattice_use_outside_set");
346         RNA_def_property_ui_text(prop, "Outside", "Only draw, and take into account, the outer vertices");
347         RNA_def_property_update(prop, 0, "rna_Lattice_update_data_editlatt");
348
349         prop = RNA_def_property(srna, "vertex_group", PROP_STRING, PROP_NONE);
350         RNA_def_property_string_sdna(prop, NULL, "vgroup");
351         RNA_def_property_ui_text(prop, "Vertex Group", "Vertex group to apply the influence of the lattice");
352         RNA_def_property_string_funcs(prop, NULL, NULL, "rna_Lattice_vg_name_set");
353         RNA_def_property_update(prop, 0, "rna_Lattice_update_data_editlatt");
354
355         prop = RNA_def_property(srna, "shape_keys", PROP_POINTER, PROP_NONE);
356         RNA_def_property_pointer_sdna(prop, NULL, "key");
357         RNA_def_property_ui_text(prop, "Shape Keys", "");
358
359         prop = RNA_def_property(srna, "points", PROP_COLLECTION, PROP_NONE);
360         RNA_def_property_struct_type(prop, "LatticePoint");
361         RNA_def_property_collection_funcs(prop, "rna_Lattice_points_begin", "rna_iterator_array_next",
362                                           "rna_iterator_array_end", "rna_iterator_array_get", NULL, NULL, NULL, NULL);
363         RNA_def_property_ui_text(prop, "Points", "Points of the lattice");
364
365         prop = RNA_def_property(srna, "is_editmode", PROP_BOOLEAN, PROP_NONE);
366         RNA_def_property_boolean_funcs(prop, "rna_Lattice_is_editmode_get", NULL);
367         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
368         RNA_def_property_ui_text(prop, "Is Editmode", "True when used in editmode");
369
370         /* pointers */
371         rna_def_animdata_common(srna);
372
373         RNA_api_lattice(srna);
374 }
375
376 void RNA_def_lattice(BlenderRNA *brna)
377 {
378         rna_def_lattice(brna);
379         rna_def_latticepoint(brna);
380 }
381
382 #endif