Merge branch 'master' into blender2.8
[blender.git] / source / blender / modifiers / intern / MOD_uvwarp.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): Pawel Kowal, Campbell Barton
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  *
22  */
23
24 /** \file blender/modifiers/intern/MOD_uvwarp.c
25  *  \ingroup modifiers
26  */
27
28 #include <string.h>
29
30 #include "DNA_meshdata_types.h"
31 #include "DNA_object_types.h"
32
33 #include "BLI_math.h"
34 #include "BLI_task.h"
35 #include "BLI_utildefines.h"
36
37 #include "BKE_action.h"  /* BKE_pose_channel_find_name */
38 #include "BKE_cdderivedmesh.h"
39 #include "BKE_deform.h"
40 #include "BKE_library_query.h"
41 #include "BKE_modifier.h"
42
43 #include "MOD_util.h"
44
45
46 static void uv_warp_from_mat4_pair(float uv_dst[2], const float uv_src[2], float warp_mat[4][4],
47                                    int axis_u, int axis_v)
48 {
49         float tuv[3] = {0.0f};
50
51         tuv[axis_u] = uv_src[0];
52         tuv[axis_v] = uv_src[1];
53
54         mul_m4_v3(warp_mat, tuv);
55
56         uv_dst[0] = tuv[axis_u];
57         uv_dst[1] = tuv[axis_v];
58 }
59
60 static void initData(ModifierData *md)
61 {
62         UVWarpModifierData *umd = (UVWarpModifierData *) md;
63         umd->axis_u = 0;
64         umd->axis_v = 1;
65         copy_v2_fl(umd->center, 0.5f);
66 }
67
68 static CustomDataMask requiredDataMask(Object *UNUSED(ob), ModifierData *md)
69 {
70         UVWarpModifierData *umd = (UVWarpModifierData *)md;
71         CustomDataMask dataMask = 0;
72
73         /* ask for vertexgroups if we need them */
74         if (umd->vgroup_name[0])
75                 dataMask |= CD_MASK_MDEFORMVERT;
76
77         return dataMask;
78 }
79
80 static void matrix_from_obj_pchan(float mat[4][4], Object *ob, const char *bonename)
81 {
82         bPoseChannel *pchan = BKE_pose_channel_find_name(ob->pose, bonename);
83         if (pchan) {
84                 mul_m4_m4m4(mat, ob->obmat, pchan->pose_mat);
85         }
86         else {
87                 copy_m4_m4(mat, ob->obmat);
88         }
89 }
90
91 typedef struct UVWarpData {
92         MPoly *mpoly;
93         MLoop *mloop;
94         MLoopUV *mloopuv;
95
96         MDeformVert *dvert;
97         int defgrp_index;
98
99         float (*warp_mat)[4];
100         int axis_u;
101         int axis_v;
102 } UVWarpData;
103
104 static void uv_warp_compute(
105         void *__restrict userdata,
106         const int i,
107         const ParallelRangeTLS *__restrict UNUSED(tls))
108 {
109         const UVWarpData *data = userdata;
110
111         const MPoly *mp = &data->mpoly[i];
112         const MLoop *ml = &data->mloop[mp->loopstart];
113         MLoopUV *mluv = &data->mloopuv[mp->loopstart];
114
115         const MDeformVert *dvert = data->dvert;
116         const int defgrp_index = data->defgrp_index;
117
118         float (*warp_mat)[4] = data->warp_mat;
119         const int axis_u = data->axis_u;
120         const int axis_v = data->axis_v;
121
122         int l;
123
124         if (dvert) {
125                 for (l = 0; l < mp->totloop; l++, ml++, mluv++) {
126                         float uv[2];
127                         const float weight = defvert_find_weight(&dvert[ml->v], defgrp_index);
128
129                         uv_warp_from_mat4_pair(uv, mluv->uv, warp_mat, axis_u, axis_v);
130                         interp_v2_v2v2(mluv->uv, mluv->uv, uv, weight);
131                 }
132         }
133         else {
134                 for (l = 0; l < mp->totloop; l++, ml++, mluv++) {
135                         uv_warp_from_mat4_pair(mluv->uv, mluv->uv, warp_mat, axis_u, axis_v);
136                 }
137         }
138 }
139
140 static DerivedMesh *applyModifier(ModifierData *md, const ModifierEvalContext *ctx,
141                                   DerivedMesh *dm)
142 {
143         UVWarpModifierData *umd = (UVWarpModifierData *) md;
144         int numPolys, numLoops;
145         MPoly *mpoly;
146         MLoop *mloop;
147         MLoopUV *mloopuv;
148         MDeformVert *dvert;
149         int defgrp_index;
150         char uvname[MAX_CUSTOMDATA_LAYER_NAME];
151         float mat_src[4][4];
152         float mat_dst[4][4];
153         float imat_dst[4][4];
154         float warp_mat[4][4];
155         const int axis_u = umd->axis_u;
156         const int axis_v = umd->axis_v;
157
158         /* make sure there are UV Maps available */
159         if (!CustomData_has_layer(&dm->loopData, CD_MLOOPUV)) {
160                 return dm;
161         }
162         else if (ELEM(NULL, umd->object_src, umd->object_dst)) {
163                 modifier_setError(md, "From/To objects must be set");
164                 return dm;
165         }
166
167         /* make sure anything moving UVs is available */
168         matrix_from_obj_pchan(mat_src, umd->object_src, umd->bone_src);
169         matrix_from_obj_pchan(mat_dst, umd->object_dst, umd->bone_dst);
170
171         invert_m4_m4(imat_dst, mat_dst);
172         mul_m4_m4m4(warp_mat, imat_dst, mat_src);
173
174         /* apply warp */
175         if (!is_zero_v2(umd->center)) {
176                 float mat_cent[4][4];
177                 float imat_cent[4][4];
178
179                 unit_m4(mat_cent);
180                 mat_cent[3][axis_u] = umd->center[0];
181                 mat_cent[3][axis_v] = umd->center[1];
182
183                 invert_m4_m4(imat_cent, mat_cent);
184
185                 mul_m4_m4m4(warp_mat, warp_mat, imat_cent);
186                 mul_m4_m4m4(warp_mat, mat_cent, warp_mat);
187         }
188
189         /* make sure we're using an existing layer */
190         CustomData_validate_layer_name(&dm->loopData, CD_MLOOPUV, umd->uvlayer_name, uvname);
191
192         numPolys = dm->getNumPolys(dm);
193         numLoops = dm->getNumLoops(dm);
194
195         mpoly = dm->getPolyArray(dm);
196         mloop = dm->getLoopArray(dm);
197         /* make sure we are not modifying the original UV map */
198         mloopuv = CustomData_duplicate_referenced_layer_named(&dm->loopData, CD_MLOOPUV, uvname, numLoops);
199         modifier_get_vgroup(ctx->object, dm, umd->vgroup_name, &dvert, &defgrp_index);
200
201         UVWarpData data = {.mpoly = mpoly, .mloop = mloop, .mloopuv = mloopuv,
202                            .dvert = dvert, .defgrp_index = defgrp_index,
203                            .warp_mat = warp_mat, .axis_u = axis_u, .axis_v = axis_v};
204         ParallelRangeSettings settings;
205         BLI_parallel_range_settings_defaults(&settings);
206         settings.use_threading = (numPolys > 1000);
207         BLI_task_parallel_range(0, numPolys,
208                                 &data,
209                                 uv_warp_compute,
210                                 &settings);
211
212         dm->dirty |= DM_DIRTY_TESS_CDLAYERS;
213
214         return dm;
215 }
216
217 static void foreachObjectLink(ModifierData *md, Object *ob, ObjectWalkFunc walk, void *userData)
218 {
219         UVWarpModifierData *umd = (UVWarpModifierData *) md;
220
221         walk(userData, ob, &umd->object_dst, IDWALK_CB_NOP);
222         walk(userData, ob, &umd->object_src, IDWALK_CB_NOP);
223 }
224
225 static void uv_warp_deps_object_bone_new(struct DepsNodeHandle *node,
226                                          Object *object,
227                                          const char *bonename)
228 {
229         if (object != NULL) {
230                 if (bonename[0])
231                         DEG_add_object_relation(node, object, DEG_OB_COMP_EVAL_POSE, "UVWarp Modifier");
232                 else
233                         DEG_add_object_relation(node, object, DEG_OB_COMP_TRANSFORM, "UVWarp Modifier");
234         }
235 }
236
237 static void updateDepsgraph(ModifierData *md, const ModifierUpdateDepsgraphContext *ctx)
238 {
239         UVWarpModifierData *umd = (UVWarpModifierData *) md;
240
241         uv_warp_deps_object_bone_new(ctx->node, umd->object_src, umd->bone_src);
242         uv_warp_deps_object_bone_new(ctx->node, umd->object_dst, umd->bone_dst);
243 }
244
245 ModifierTypeInfo modifierType_UVWarp = {
246         /* name */              "UVWarp",
247         /* structName */        "UVWarpModifierData",
248         /* structSize */        sizeof(UVWarpModifierData),
249         /* type */              eModifierTypeType_NonGeometrical,
250         /* flags */             eModifierTypeFlag_AcceptsMesh |
251                                 eModifierTypeFlag_SupportsEditmode |
252                                 eModifierTypeFlag_EnableInEditmode,
253
254         /* copyData */          modifier_copyData_generic,
255
256         /* deformVerts_DM */    NULL,
257         /* deformMatrices_DM */ NULL,
258         /* deformVertsEM_DM */  NULL,
259         /* deformMatricesEM_DM*/NULL,
260         /* applyModifier_DM */  applyModifier,
261         /* applyModifierEM_DM */NULL,
262
263         /* deformVerts */       NULL,
264         /* deformMatrices */    NULL,
265         /* deformVertsEM */     NULL,
266         /* deformMatricesEM */  NULL,
267         /* applyModifier */     NULL,
268         /* applyModifierEM */   NULL,
269
270         /* initData */          initData,
271         /* requiredDataMask */  requiredDataMask,
272         /* freeData */          NULL,
273         /* isDisabled */        NULL,
274         /* updateDepsgraph */   updateDepsgraph,
275         /* dependsOnTime */     NULL,
276         /* dependsOnNormals */  NULL,
277         /* foreachObjectLink */ foreachObjectLink,
278         /* foreachIDLink */     NULL,
279         /* foreachTexLink */    NULL,
280 };