RNA: Add Mesh.count_selected_items()
[blender.git] / source / blender / makesrna / intern / rna_mesh_api.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  * The Original Code is Copyright (C) 2009 Blender Foundation.
19  * All rights reserved.
20  *
21  *
22  * Contributor(s): Blender Foundation
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/makesrna/intern/rna_mesh_api.c
28  *  \ingroup RNA
29  */
30
31
32 #include <stdlib.h>
33 #include <stdio.h>
34
35 #include "RNA_define.h"
36
37 #include "DNA_customdata_types.h"
38
39 #include "BLI_sys_types.h"
40
41 #include "BLI_utildefines.h"
42 #include "BLI_math.h"
43
44 #include "rna_internal.h"  /* own include */
45
46 #ifdef RNA_RUNTIME
47
48 #include "DNA_mesh_types.h"
49
50 #include "BKE_mesh.h"
51 #include "BKE_mesh_tangent.h"
52 #include "BKE_mesh_mapping.h"
53 #include "BKE_mesh_runtime.h"
54 #include "ED_mesh.h"
55
56 static const char *rna_Mesh_unit_test_compare(struct Mesh *mesh, struct Mesh *mesh2)
57 {
58         const char *ret = BKE_mesh_cmp(mesh, mesh2, FLT_EPSILON * 60);
59
60         if (!ret)
61                 ret = "Same";
62
63         return ret;
64 }
65
66 static void rna_Mesh_create_normals_split(Mesh *mesh)
67 {
68         if (!CustomData_has_layer(&mesh->ldata, CD_NORMAL)) {
69                 CustomData_add_layer(&mesh->ldata, CD_NORMAL, CD_CALLOC, NULL, mesh->totloop);
70                 CustomData_set_layer_flag(&mesh->ldata, CD_NORMAL, CD_FLAG_TEMPORARY);
71         }
72 }
73
74 static void rna_Mesh_free_normals_split(Mesh *mesh)
75 {
76         CustomData_free_layers(&mesh->ldata, CD_NORMAL, mesh->totloop);
77 }
78
79 static void rna_Mesh_calc_tangents(Mesh *mesh, ReportList *reports, const char *uvmap)
80 {
81         float (*r_looptangents)[4];
82
83         if (CustomData_has_layer(&mesh->ldata, CD_MLOOPTANGENT)) {
84                 r_looptangents = CustomData_get_layer(&mesh->ldata, CD_MLOOPTANGENT);
85                 memset(r_looptangents, 0, sizeof(float[4]) * mesh->totloop);
86         }
87         else {
88                 r_looptangents = CustomData_add_layer(&mesh->ldata, CD_MLOOPTANGENT, CD_CALLOC, NULL, mesh->totloop);
89                 CustomData_set_layer_flag(&mesh->ldata, CD_MLOOPTANGENT, CD_FLAG_TEMPORARY);
90         }
91
92         /* Compute loop normals if needed. */
93         if (!CustomData_has_layer(&mesh->ldata, CD_NORMAL)) {
94                 BKE_mesh_calc_normals_split(mesh);
95         }
96
97         BKE_mesh_calc_loop_tangent_single(mesh, uvmap, r_looptangents, reports);
98 }
99
100 static void rna_Mesh_free_tangents(Mesh *mesh)
101 {
102         CustomData_free_layers(&mesh->ldata, CD_MLOOPTANGENT, mesh->totloop);
103 }
104
105 static void rna_Mesh_calc_looptri(Mesh *mesh)
106 {
107         BKE_mesh_runtime_looptri_ensure(mesh);
108 }
109
110 static void rna_Mesh_calc_smooth_groups(Mesh *mesh, bool use_bitflags, int *r_poly_group_len,
111                                         int **r_poly_group, int *r_group_total)
112 {
113         *r_poly_group_len = mesh->totpoly;
114         *r_poly_group = BKE_mesh_calc_smoothgroups(
115                             mesh->medge, mesh->totedge,
116                             mesh->mpoly, mesh->totpoly,
117                             mesh->mloop, mesh->totloop,
118                             r_group_total, use_bitflags);
119 }
120
121 static void rna_Mesh_normals_split_custom_do(Mesh *mesh, float (*custom_loopnors)[3], const bool use_vertices)
122 {
123         float (*polynors)[3];
124         short (*clnors)[2];
125         const int numloops = mesh->totloop;
126         bool free_polynors = false;
127
128         clnors = CustomData_get_layer(&mesh->ldata, CD_CUSTOMLOOPNORMAL);
129         if (clnors) {
130                 memset(clnors, 0, sizeof(*clnors) * numloops);
131         }
132         else {
133                 clnors = CustomData_add_layer(&mesh->ldata, CD_CUSTOMLOOPNORMAL, CD_DEFAULT, NULL, numloops);
134         }
135
136         if (CustomData_has_layer(&mesh->pdata, CD_NORMAL)) {
137                 polynors = CustomData_get_layer(&mesh->pdata, CD_NORMAL);
138         }
139         else {
140                 polynors = MEM_mallocN(sizeof(float[3]) * mesh->totpoly, __func__);
141                 BKE_mesh_calc_normals_poly(
142                             mesh->mvert, NULL, mesh->totvert,
143                             mesh->mloop, mesh->mpoly, mesh->totloop, mesh->totpoly, polynors, false);
144                 free_polynors = true;
145         }
146
147         if (use_vertices) {
148                 BKE_mesh_normals_loop_custom_from_vertices_set(
149                         mesh->mvert, custom_loopnors, mesh->totvert, mesh->medge, mesh->totedge, mesh->mloop, mesh->totloop,
150                         mesh->mpoly, (const float (*)[3])polynors, mesh->totpoly, clnors);
151         }
152         else {
153                 BKE_mesh_normals_loop_custom_set(
154                         mesh->mvert, mesh->totvert, mesh->medge, mesh->totedge, mesh->mloop, custom_loopnors, mesh->totloop,
155                         mesh->mpoly, (const float (*)[3])polynors, mesh->totpoly, clnors);
156         }
157
158         if (free_polynors) {
159                 MEM_freeN(polynors);
160         }
161 }
162
163 static void rna_Mesh_normals_split_custom_set(Mesh *mesh, ReportList *reports, int normals_len, float *normals)
164 {
165         float (*loopnors)[3] = (float (*)[3])normals;
166         const int numloops = mesh->totloop;
167
168         if (normals_len != numloops * 3) {
169                 BKE_reportf(reports, RPT_ERROR,
170                             "Number of custom normals is not number of loops (%f / %d)",
171                             (float)normals_len / 3.0f, numloops);
172                 return;
173         }
174
175         rna_Mesh_normals_split_custom_do(mesh, loopnors, false);
176
177         DEG_id_tag_update(&mesh->id, 0);
178 }
179
180 static void rna_Mesh_normals_split_custom_set_from_vertices(
181         Mesh *mesh, ReportList *reports, int normals_len, float *normals)
182 {
183         float (*vertnors)[3] = (float (*)[3])normals;
184         const int numverts = mesh->totvert;
185
186         if (normals_len != numverts * 3) {
187                 BKE_reportf(reports, RPT_ERROR,
188                             "Number of custom normals is not number of vertices (%f / %d)",
189                             (float)normals_len / 3.0f, numverts);
190                 return;
191         }
192
193         rna_Mesh_normals_split_custom_do(mesh, vertnors, true);
194
195         DEG_id_tag_update(&mesh->id, 0);
196 }
197
198 static void rna_Mesh_transform(Mesh *mesh, float *mat, bool shape_keys)
199 {
200         BKE_mesh_transform(mesh, (float (*)[4])mat, shape_keys);
201
202         DEG_id_tag_update(&mesh->id, 0);
203 }
204
205 static void rna_Mesh_flip_normals(Mesh *mesh)
206 {
207         BKE_mesh_polygons_flip(mesh->mpoly, mesh->mloop, &mesh->ldata, mesh->totpoly);
208         BKE_mesh_tessface_clear(mesh);
209         BKE_mesh_calc_normals(mesh);
210         BKE_mesh_runtime_clear_geometry(mesh);
211
212         DEG_id_tag_update(&mesh->id, 0);
213 }
214
215 static void rna_Mesh_split_faces(Mesh *mesh, bool free_loop_normals)
216 {
217         BKE_mesh_split_faces(mesh, free_loop_normals != 0);
218 }
219
220 static void rna_Mesh_update_gpu_tag(Mesh *mesh)
221 {
222         BKE_mesh_batch_cache_dirty_tag(mesh, BKE_MESH_BATCH_DIRTY_ALL);
223 }
224
225 static void rna_Mesh_count_selected_items(Mesh *mesh, int r_count[3])
226 {
227         BKE_mesh_count_selected_items(mesh, r_count);
228 }
229
230
231 #else
232
233 void RNA_api_mesh(StructRNA *srna)
234 {
235         FunctionRNA *func;
236         PropertyRNA *parm;
237         const int normals_array_dim[] = {1, 3};
238
239         func = RNA_def_function(srna, "transform", "rna_Mesh_transform");
240         RNA_def_function_ui_description(func, "Transform mesh vertices by a matrix "
241                                               "(Warning: inverts normals if matrix is negative)");
242         parm = RNA_def_float_matrix(func, "matrix", 4, 4, NULL, 0.0f, 0.0f, "", "Matrix", 0.0f, 0.0f);
243         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
244         RNA_def_boolean(func, "shape_keys", 0, "", "Transform Shape Keys");
245
246         func = RNA_def_function(srna, "flip_normals", "rna_Mesh_flip_normals");
247         RNA_def_function_ui_description(func, "Invert winding of all polygons "
248                                               "(clears tessellation, does not handle custom normals)");
249
250         func = RNA_def_function(srna, "calc_normals", "BKE_mesh_calc_normals");
251         RNA_def_function_ui_description(func, "Calculate vertex normals");
252
253         func = RNA_def_function(srna, "create_normals_split", "rna_Mesh_create_normals_split");
254         RNA_def_function_ui_description(func, "Empty split vertex normals");
255
256         func = RNA_def_function(srna, "calc_normals_split", "BKE_mesh_calc_normals_split");
257         RNA_def_function_ui_description(func, "Calculate split vertex normals, which preserve sharp edges");
258
259         func = RNA_def_function(srna, "free_normals_split", "rna_Mesh_free_normals_split");
260         RNA_def_function_ui_description(func, "Free split vertex normals");
261
262         func = RNA_def_function(srna, "split_faces", "rna_Mesh_split_faces");
263         RNA_def_function_ui_description(func, "Split faces based on the edge angle");
264         RNA_def_boolean(func, "free_loop_normals", 1, "Free Loop Notmals",
265                         "Free loop normals custom data layer");
266
267         func = RNA_def_function(srna, "calc_tangents", "rna_Mesh_calc_tangents");
268         RNA_def_function_flag(func, FUNC_USE_REPORTS);
269         RNA_def_function_ui_description(func,
270                                         "Compute tangents and bitangent signs, to be used together with the split normals "
271                                         "to get a complete tangent space for normal mapping "
272                                         "(split normals are also computed if not yet present)");
273         parm = RNA_def_string(func, "uvmap", NULL, MAX_CUSTOMDATA_LAYER_NAME, "",
274                               "Name of the UV map to use for tangent space computation");
275
276         func = RNA_def_function(srna, "free_tangents", "rna_Mesh_free_tangents");
277         RNA_def_function_ui_description(func, "Free tangents");
278
279         func = RNA_def_function(srna, "calc_loop_triangles", "rna_Mesh_calc_looptri");
280         RNA_def_function_ui_description(func, "Calculate loop triangle tessellation (supports editmode too)");
281
282         func = RNA_def_function(srna, "calc_smooth_groups", "rna_Mesh_calc_smooth_groups");
283         RNA_def_function_ui_description(func, "Calculate smooth groups from sharp edges");
284         RNA_def_boolean(func, "use_bitflags", false, "", "Produce bitflags groups instead of simple numeric values");
285         /* return values */
286         parm = RNA_def_int_array(func, "poly_groups", 1, NULL, 0, 0, "", "Smooth Groups", 0, 0);
287         RNA_def_parameter_flags(parm, PROP_DYNAMIC, PARM_OUTPUT);
288         parm = RNA_def_int(func, "groups", 0, 0, INT_MAX, "groups", "Total number of groups", 0, INT_MAX);
289         RNA_def_parameter_flags(parm, 0, PARM_OUTPUT);
290
291         func = RNA_def_function(srna, "normals_split_custom_set", "rna_Mesh_normals_split_custom_set");
292         RNA_def_function_ui_description(func,
293                                         "Define custom split normals of this mesh "
294                                         "(use zero-vectors to keep auto ones)");
295         RNA_def_function_flag(func, FUNC_USE_REPORTS);
296         /* TODO, see how array size of 0 works, this shouldnt be used */
297         parm = RNA_def_float_array(func, "normals", 1, NULL, -1.0f, 1.0f, "", "Normals", 0.0f, 0.0f);
298         RNA_def_property_multi_array(parm, 2, normals_array_dim);
299         RNA_def_parameter_flags(parm, PROP_DYNAMIC, PARM_REQUIRED);
300
301         func = RNA_def_function(srna, "normals_split_custom_set_from_vertices",
302                                 "rna_Mesh_normals_split_custom_set_from_vertices");
303         RNA_def_function_ui_description(func,
304                                         "Define custom split normals of this mesh, from vertices' normals "
305                                         "(use zero-vectors to keep auto ones)");
306         RNA_def_function_flag(func, FUNC_USE_REPORTS);
307         /* TODO, see how array size of 0 works, this shouldnt be used */
308         parm = RNA_def_float_array(func, "normals", 1, NULL, -1.0f, 1.0f, "", "Normals", 0.0f, 0.0f);
309         RNA_def_property_multi_array(parm, 2, normals_array_dim);
310         RNA_def_parameter_flags(parm, PROP_DYNAMIC, PARM_REQUIRED);
311
312         func = RNA_def_function(srna, "update", "ED_mesh_update");
313         RNA_def_boolean(func, "calc_edges", 0, "Calculate Edges", "Force recalculation of edges");
314         RNA_def_boolean(func, "calc_edges_loose", 0, "Calculate Loose Edges", "Calculate the loose state of each edge");
315         RNA_def_boolean(func, "calc_loop_triangles", 0, "Calculate Triangules", "Force recalculation of triangle tessellation");
316         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
317
318         RNA_def_function(srna, "update_gpu_tag", "rna_Mesh_update_gpu_tag");
319
320         func = RNA_def_function(srna, "unit_test_compare", "rna_Mesh_unit_test_compare");
321         RNA_def_pointer(func, "mesh", "Mesh", "", "Mesh to compare to");
322         /* return value */
323         parm = RNA_def_string(func, "result", "nothing", 64, "Return value", "String description of result of comparison");
324         RNA_def_function_return(func, parm);
325
326         func = RNA_def_function(srna, "validate", "BKE_mesh_validate");
327         RNA_def_function_ui_description(func, "Validate geometry, return True when the mesh has had "
328                                         "invalid geometry corrected/removed");
329         RNA_def_boolean(func, "verbose", false, "Verbose", "Output information about the errors found");
330         RNA_def_boolean(func, "clean_customdata", true, "Clean Custom Data",
331                         "Remove temp/cached custom-data layers, like e.g. normals...");
332         parm = RNA_def_boolean(func, "result", 0, "Result", "");
333         RNA_def_function_return(func, parm);
334
335         func = RNA_def_function(srna, "validate_material_indices", "BKE_mesh_validate_material_indices");
336         RNA_def_function_ui_description(func, "Validate material indices of polygons, return True when the mesh has had "
337                                         "invalid indices corrected (to default 0)");
338         parm = RNA_def_boolean(func, "result", 0, "Result", "");
339         RNA_def_function_return(func, parm);
340
341         func = RNA_def_function(srna, "count_selected_items", "rna_Mesh_count_selected_items ");
342         RNA_def_function_ui_description(func, "Return the number of selected items (vert, edge, face)");
343         parm = RNA_def_int_vector(func, "result", 3, NULL, 0, INT_MAX, "Result", NULL, 0, INT_MAX);
344         RNA_def_function_output(func, parm);
345 }
346
347 #endif