Made armatures evaluation safe(r) for threading
[blender-staging.git] / source / blender / modifiers / intern / MOD_weightvg_util.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) 2011 by Bastien Montagne.
19  * All rights reserved.
20  *
21  * Contributor(s): None yet.
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  *
25  */
26
27 /** \file blender/modifiers/intern/MOD_weightvg_util.c
28  *  \ingroup modifiers
29  */
30
31 #include "BLI_math.h"
32 #include "BLI_rand.h"
33 #include "BLI_string.h"
34 #include "BLI_utildefines.h"
35
36 #include "DNA_color_types.h"      /* CurveMapping. */
37 #include "DNA_mesh_types.h"
38 #include "DNA_meshdata_types.h"
39 #include "DNA_modifier_types.h"
40 #include "DNA_object_types.h"
41 #include "DNA_scene_types.h"
42
43 #include "BKE_cdderivedmesh.h"
44 #include "BKE_colortools.h"       /* CurveMapping. */
45 #include "BKE_deform.h"
46 #include "BKE_mesh.h"
47 #include "BKE_modifier.h"
48 #include "BKE_texture.h"          /* Texture masking. */
49
50 #include "depsgraph_private.h"
51 #include "MEM_guardedalloc.h"
52 #include "MOD_util.h"
53 #include "MOD_weightvg_util.h"
54 #include "RE_shader_ext.h"        /* Texture masking. */
55
56 /* Maps new_w weights in place, using either one of the predefined functions, or a custom curve.
57  * Return values are in new_w.
58  * If indices is not NULL, it must be a table of same length as org_w and new_w, mapping to the real
59  * vertex index (in case the weight tables do not cover the whole vertices...).
60  * cmap might be NULL, in which case curve mapping mode will return unmodified data.
61  */
62 void weightvg_do_map(int num, float *new_w, short falloff_type, CurveMapping *cmap, RNG *rng)
63 {
64         int i;
65
66         /* Return immediately, if we have nothing to do! */
67         /* Also security checks... */
68         if (((falloff_type == MOD_WVG_MAPPING_CURVE) && (cmap == NULL)) ||
69             !ELEM7(falloff_type, MOD_WVG_MAPPING_CURVE, MOD_WVG_MAPPING_SHARP, MOD_WVG_MAPPING_SMOOTH,
70                    MOD_WVG_MAPPING_ROOT, MOD_WVG_MAPPING_SPHERE, MOD_WVG_MAPPING_RANDOM,
71                    MOD_WVG_MAPPING_STEP))
72         {
73                 return;
74         }
75
76         if (cmap && falloff_type == MOD_WVG_MAPPING_CURVE) {
77                 curvemapping_initialize(cmap);
78         }
79
80         /* Map each weight (vertex) to its new value, accordingly to the chosen mode. */
81         for (i = 0; i < num; ++i) {
82                 float fac = new_w[i];
83
84                 /* Code borrowed from the warp modifier. */
85                 /* Closely matches PROP_SMOOTH and similar. */
86                 switch (falloff_type) {
87                         case MOD_WVG_MAPPING_CURVE:
88                                 fac = curvemapping_evaluateF(cmap, 0, fac);
89                                 break;
90                         case MOD_WVG_MAPPING_SHARP:
91                                 fac = fac * fac;
92                                 break;
93                         case MOD_WVG_MAPPING_SMOOTH:
94                                 fac = 3.0f * fac * fac - 2.0f * fac * fac * fac;
95                                 break;
96                         case MOD_WVG_MAPPING_ROOT:
97                                 fac = (float)sqrt(fac);
98                                 break;
99                         case MOD_WVG_MAPPING_SPHERE:
100                                 fac = (float)sqrt(2 * fac - fac * fac);
101                                 break;
102                         case MOD_WVG_MAPPING_RANDOM:
103                                 fac = BLI_rng_get_float(rng) * fac;
104                                 break;
105                         case MOD_WVG_MAPPING_STEP:
106                                 fac = (fac >= 0.5f) ? 1.0f : 0.0f;
107                                 break;
108                 }
109
110                 new_w[i] = fac;
111         }
112 }
113
114 /* Applies new_w weights to org_w ones, using either a texture, vgroup or constant value as factor.
115  * Return values are in org_w.
116  * If indices is not NULL, it must be a table of same length as org_w and new_w, mapping to the real
117  * vertex index (in case the weight tables do not cover the whole vertices...).
118  * XXX The standard "factor" value is assumed in [0.0, 1.0] range. Else, weird results might appear.
119  */
120 void weightvg_do_mask(int num, const int *indices, float *org_w, const float *new_w,
121                       Object *ob, DerivedMesh *dm, float fact, const char defgrp_name[MAX_VGROUP_NAME],
122                       Scene *scene, Tex *texture, int tex_use_channel, int tex_mapping,
123                       Object *tex_map_object, const char *tex_uvlayer_name)
124 {
125         int ref_didx;
126         int i;
127
128         /* If influence factor is null, nothing to do! */
129         if (fact == 0.0f) return;
130
131         /* If we want to mask vgroup weights from a texture. */
132         if (texture) {
133                 /* The texture coordinates. */
134                 float (*tex_co)[3];
135                 /* See mapping note below... */
136                 MappingInfoModifierData t_map;
137                 float (*v_co)[3];
138
139                 /* Use new generic get_texture_coords, but do not modify our DNA struct for it...
140                  * XXX Why use a ModifierData stuff here ? Why not a simple, generic struct for parameters ?
141                  *     What e.g. if a modifier wants to use several textures ?
142                  *     Why use only v_co, and not MVert (or both) ?
143                  */
144                 t_map.texture = texture;
145                 t_map.map_object = tex_map_object;
146                 BLI_strncpy(t_map.uvlayer_name, tex_uvlayer_name, sizeof(t_map.uvlayer_name));
147                 t_map.texmapping = tex_mapping;
148                 v_co = MEM_mallocN(sizeof(*v_co) * num, "WeightVG Modifier, TEX mode, v_co");
149                 dm->getVertCos(dm, v_co);
150                 tex_co = MEM_callocN(sizeof(*tex_co) * num, "WeightVG Modifier, TEX mode, tex_co");
151                 get_texture_coords(&t_map, ob, dm, v_co, tex_co, num);
152                 MEM_freeN(v_co);
153
154                 modifier_init_texture(scene, texture);
155
156                 /* For each weight (vertex), make the mix between org and new weights. */
157                 for (i = 0; i < num; ++i) {
158                         int idx = indices ? indices[i] : i;
159                         TexResult texres;
160                         float hsv[3]; /* For HSV color space. */
161
162                         texres.nor = NULL;
163                         get_texture_value(texture, tex_co[idx], &texres);
164                         /* Get the good channel value... */
165                         switch (tex_use_channel) {
166                                 case MOD_WVG_MASK_TEX_USE_INT:
167                                         org_w[i] = (new_w[i] * texres.tin * fact) + (org_w[i] * (1.0f - (texres.tin * fact)));
168                                         break;
169                                 case MOD_WVG_MASK_TEX_USE_RED:
170                                         org_w[i] = (new_w[i] * texres.tr * fact) + (org_w[i] * (1.0f - (texres.tr * fact)));
171                                         break;
172                                 case MOD_WVG_MASK_TEX_USE_GREEN:
173                                         org_w[i] = (new_w[i] * texres.tg * fact) + (org_w[i] * (1.0f - (texres.tg * fact)));
174                                         break;
175                                 case MOD_WVG_MASK_TEX_USE_BLUE:
176                                         org_w[i] = (new_w[i] * texres.tb * fact) + (org_w[i] * (1.0f - (texres.tb * fact)));
177                                         break;
178                                 case MOD_WVG_MASK_TEX_USE_HUE:
179                                         rgb_to_hsv_v(&texres.tr, hsv);
180                                         org_w[i] = (new_w[i] * hsv[0] * fact) + (org_w[i] * (1.0f - (hsv[0] * fact)));
181                                         break;
182                                 case MOD_WVG_MASK_TEX_USE_SAT:
183                                         rgb_to_hsv_v(&texres.tr, hsv);
184                                         org_w[i] = (new_w[i] * hsv[1] * fact) + (org_w[i] * (1.0f - (hsv[1] * fact)));
185                                         break;
186                                 case MOD_WVG_MASK_TEX_USE_VAL:
187                                         rgb_to_hsv_v(&texres.tr, hsv);
188                                         org_w[i] = (new_w[i] * hsv[2] * fact) + (org_w[i] * (1.0f - (hsv[2] * fact)));
189                                         break;
190                                 case MOD_WVG_MASK_TEX_USE_ALPHA:
191                                         org_w[i] = (new_w[i] * texres.ta * fact) + (org_w[i] * (1.0f - (texres.ta * fact)));
192                                         break;
193                                 default:
194                                         org_w[i] = (new_w[i] * texres.tin * fact) + (org_w[i] * (1.0f - (texres.tin * fact)));
195                                         break;
196                         }
197                 }
198
199                 MEM_freeN(tex_co);
200         }
201         else if ((ref_didx = defgroup_name_index(ob, defgrp_name)) != -1) {
202                 MDeformVert *dvert = NULL;
203
204                 /* Check whether we want to set vgroup weights from a constant weight factor or a vertex
205                  * group.
206                  */
207                 /* Get vgroup idx from its name. */
208
209                 /* Proceed only if vgroup is valid, else use constant factor. */
210                 /* Get actual dverts (ie vertex group data). */
211                 dvert = dm->getVertDataArray(dm, CD_MDEFORMVERT);
212                 /* Proceed only if vgroup is valid, else assume factor = O. */
213                 if (dvert == NULL) return;
214
215                 /* For each weight (vertex), make the mix between org and new weights. */
216                 for (i = 0; i < num; i++) {
217                         int idx = indices ? indices[i] : i;
218                         const float f = defvert_find_weight(&dvert[idx], ref_didx) * fact;
219                         org_w[i] = (new_w[i] * f) + (org_w[i] * (1.0f - f));
220                         /* If that vertex is not in ref vgroup, assume null factor, and hence do nothing! */
221                 }
222         }
223         else {
224                 /* Default "influence" behavior. */
225                 /* For each weight (vertex), make the mix between org and new weights. */
226                 const float ifact = 1.0f - fact;
227                 for (i = 0; i < num; i++) {
228                         org_w[i] = (new_w[i] * fact) + (org_w[i] * ifact);
229                 }
230         }
231 }
232
233
234
235
236 /* Applies weights to given vgroup (defgroup), and optionally add/remove vertices from the group.
237  * If dws is not NULL, it must be an array of MDeformWeight pointers of same length as weights (and
238  * defgrp_idx can then have any value).
239  * If indices is not NULL, it must be an array of same length as weights, mapping to the real
240  * vertex index (in case the weight array does not cover the whole vertices...).
241  */
242 void weightvg_update_vg(MDeformVert *dvert, int defgrp_idx, MDeformWeight **dws, int num,
243                         const int *indices, const float *weights, int do_add,
244                         float add_thresh, int do_rem, float rem_thresh)
245 {
246         int i;
247
248         for (i = 0; i < num; i++) {
249                 float w = weights[i];
250                 MDeformVert *dv = &dvert[indices ? indices[i] : i];
251                 MDeformWeight *dw = dws ? dws[i] : defvert_find_index(dv, defgrp_idx);
252
253                 /* Never allow weights out of [0.0, 1.0] range. */
254                 CLAMP(w, 0.0f, 1.0f);
255
256                 /* If the vertex is in this vgroup, remove it if needed, or just update it. */
257                 if (dw != NULL) {
258                         if (do_rem && w < rem_thresh) {
259                                 defvert_remove_group(dv, dw);
260                         }
261                         else {
262                                 dw->weight = w;
263                         }
264                 }
265                 /* Else, add it if needed! */
266                 else if (do_add && w > add_thresh) {
267                         defvert_add_index_notest(dv, defgrp_idx, w);
268                 }
269         }
270 }