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