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