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