Cleanup: Redundant variable assignment to self
[blender.git] / source / blender / modifiers / intern / MOD_uvwarp.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software  Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 /** \file
18  * \ingroup modifiers
19  */
20
21 #include <string.h>
22
23 #include "BLI_utildefines.h"
24
25 #include "BLI_math.h"
26 #include "BLI_task.h"
27
28 #include "DNA_mesh_types.h"
29 #include "DNA_meshdata_types.h"
30 #include "DNA_object_types.h"
31
32 #include "BKE_action.h" /* BKE_pose_channel_find_name */
33 #include "BKE_deform.h"
34 #include "BKE_library_query.h"
35 #include "BKE_modifier.h"
36
37 #include "DEG_depsgraph_query.h"
38
39 #include "MOD_util.h"
40
41 static void uv_warp_from_mat4_pair(
42     float uv_dst[2], const float uv_src[2], float warp_mat[4][4], int axis_u, int axis_v)
43 {
44   float tuv[3] = {0.0f};
45
46   tuv[axis_u] = uv_src[0];
47   tuv[axis_v] = uv_src[1];
48
49   mul_m4_v3(warp_mat, tuv);
50
51   uv_dst[0] = tuv[axis_u];
52   uv_dst[1] = tuv[axis_v];
53 }
54
55 static void initData(ModifierData *md)
56 {
57   UVWarpModifierData *umd = (UVWarpModifierData *)md;
58   umd->axis_u = 0;
59   umd->axis_v = 1;
60   copy_v2_fl(umd->center, 0.5f);
61 }
62
63 static void requiredDataMask(Object *UNUSED(ob),
64                              ModifierData *md,
65                              CustomData_MeshMasks *r_cddata_masks)
66 {
67   UVWarpModifierData *umd = (UVWarpModifierData *)md;
68
69   /* ask for vertexgroups if we need them */
70   if (umd->vgroup_name[0] != '\0') {
71     r_cddata_masks->vmask |= CD_MASK_MDEFORMVERT;
72   }
73 }
74
75 static void matrix_from_obj_pchan(float mat[4][4], Object *ob, const char *bonename)
76 {
77   bPoseChannel *pchan = BKE_pose_channel_find_name(ob->pose, bonename);
78   if (pchan) {
79     mul_m4_m4m4(mat, ob->obmat, pchan->pose_mat);
80   }
81   else {
82     copy_m4_m4(mat, ob->obmat);
83   }
84 }
85
86 typedef struct UVWarpData {
87   MPoly *mpoly;
88   MLoop *mloop;
89   MLoopUV *mloopuv;
90
91   MDeformVert *dvert;
92   int defgrp_index;
93
94   float (*warp_mat)[4];
95   int axis_u;
96   int axis_v;
97 } UVWarpData;
98
99 static void uv_warp_compute(void *__restrict userdata,
100                             const int i,
101                             const TaskParallelTLS *__restrict UNUSED(tls))
102 {
103   const UVWarpData *data = userdata;
104
105   const MPoly *mp = &data->mpoly[i];
106   const MLoop *ml = &data->mloop[mp->loopstart];
107   MLoopUV *mluv = &data->mloopuv[mp->loopstart];
108
109   const MDeformVert *dvert = data->dvert;
110   const int defgrp_index = data->defgrp_index;
111
112   float(*warp_mat)[4] = data->warp_mat;
113   const int axis_u = data->axis_u;
114   const int axis_v = data->axis_v;
115
116   int l;
117
118   if (dvert) {
119     for (l = 0; l < mp->totloop; l++, ml++, mluv++) {
120       float uv[2];
121       const float weight = defvert_find_weight(&dvert[ml->v], defgrp_index);
122
123       uv_warp_from_mat4_pair(uv, mluv->uv, warp_mat, axis_u, axis_v);
124       interp_v2_v2v2(mluv->uv, mluv->uv, uv, weight);
125     }
126   }
127   else {
128     for (l = 0; l < mp->totloop; l++, ml++, mluv++) {
129       uv_warp_from_mat4_pair(mluv->uv, mluv->uv, warp_mat, axis_u, axis_v);
130     }
131   }
132 }
133
134 static Mesh *applyModifier(ModifierData *md, const ModifierEvalContext *ctx, Mesh *mesh)
135 {
136   UVWarpModifierData *umd = (UVWarpModifierData *)md;
137   int numPolys, numLoops;
138   MPoly *mpoly;
139   MLoop *mloop;
140   MLoopUV *mloopuv;
141   MDeformVert *dvert;
142   int defgrp_index;
143   char uvname[MAX_CUSTOMDATA_LAYER_NAME];
144   float mat_src[4][4];
145   float mat_dst[4][4];
146   float imat_dst[4][4];
147   float warp_mat[4][4];
148   const int axis_u = umd->axis_u;
149   const int axis_v = umd->axis_v;
150
151   /* make sure there are UV Maps available */
152   if (!CustomData_has_layer(&mesh->ldata, CD_MLOOPUV)) {
153     return mesh;
154   }
155   else if (ELEM(NULL, umd->object_src, umd->object_dst)) {
156     modifier_setError(md, "From/To objects must be set");
157     return mesh;
158   }
159
160   /* make sure anything moving UVs is available */
161   matrix_from_obj_pchan(mat_src, umd->object_src, umd->bone_src);
162   matrix_from_obj_pchan(mat_dst, umd->object_dst, umd->bone_dst);
163
164   invert_m4_m4(imat_dst, mat_dst);
165   mul_m4_m4m4(warp_mat, imat_dst, mat_src);
166
167   /* apply warp */
168   if (!is_zero_v2(umd->center)) {
169     float mat_cent[4][4];
170     float imat_cent[4][4];
171
172     unit_m4(mat_cent);
173     mat_cent[3][axis_u] = umd->center[0];
174     mat_cent[3][axis_v] = umd->center[1];
175
176     invert_m4_m4(imat_cent, mat_cent);
177
178     mul_m4_m4m4(warp_mat, warp_mat, imat_cent);
179     mul_m4_m4m4(warp_mat, mat_cent, warp_mat);
180   }
181
182   /* make sure we're using an existing layer */
183   CustomData_validate_layer_name(&mesh->ldata, CD_MLOOPUV, umd->uvlayer_name, uvname);
184
185   numPolys = mesh->totpoly;
186   numLoops = mesh->totloop;
187
188   mpoly = mesh->mpoly;
189   mloop = mesh->mloop;
190   /* make sure we are not modifying the original UV map */
191   mloopuv = CustomData_duplicate_referenced_layer_named(
192       &mesh->ldata, CD_MLOOPUV, uvname, numLoops);
193   MOD_get_vgroup(ctx->object, mesh, umd->vgroup_name, &dvert, &defgrp_index);
194
195   UVWarpData data = {
196       .mpoly = mpoly,
197       .mloop = mloop,
198       .mloopuv = mloopuv,
199       .dvert = dvert,
200       .defgrp_index = defgrp_index,
201       .warp_mat = warp_mat,
202       .axis_u = axis_u,
203       .axis_v = axis_v,
204   };
205   TaskParallelSettings settings;
206   BLI_parallel_range_settings_defaults(&settings);
207   settings.use_threading = (numPolys > 1000);
208   BLI_task_parallel_range(0, numPolys, &data, uv_warp_compute, &settings);
209
210   /* XXX TODO is this still needed? */
211   //  me_eval->dirty |= DM_DIRTY_TESS_CDLAYERS;
212
213   return mesh;
214 }
215
216 static void foreachObjectLink(ModifierData *md, Object *ob, ObjectWalkFunc walk, void *userData)
217 {
218   UVWarpModifierData *umd = (UVWarpModifierData *)md;
219
220   walk(userData, ob, &umd->object_dst, IDWALK_CB_NOP);
221   walk(userData, ob, &umd->object_src, IDWALK_CB_NOP);
222 }
223
224 static void uv_warp_deps_object_bone_new(struct DepsNodeHandle *node,
225                                          Object *object,
226                                          const char *bonename)
227 {
228   if (object != NULL) {
229     if (bonename[0]) {
230       DEG_add_object_relation(node, object, DEG_OB_COMP_EVAL_POSE, "UVWarp Modifier");
231     }
232     else {
233       DEG_add_object_relation(node, object, DEG_OB_COMP_TRANSFORM, "UVWarp Modifier");
234     }
235   }
236 }
237
238 static void updateDepsgraph(ModifierData *md, const ModifierUpdateDepsgraphContext *ctx)
239 {
240   UVWarpModifierData *umd = (UVWarpModifierData *)md;
241
242   uv_warp_deps_object_bone_new(ctx->node, umd->object_src, umd->bone_src);
243   uv_warp_deps_object_bone_new(ctx->node, umd->object_dst, umd->bone_dst);
244
245   DEG_add_modifier_to_transform_relation(ctx->node, "UVWarp Modifier");
246 }
247
248 ModifierTypeInfo modifierType_UVWarp = {
249     /* name */ "UVWarp",
250     /* structName */ "UVWarpModifierData",
251     /* structSize */ sizeof(UVWarpModifierData),
252     /* type */ eModifierTypeType_NonGeometrical,
253     /* flags */ eModifierTypeFlag_AcceptsMesh | eModifierTypeFlag_SupportsEditmode |
254         eModifierTypeFlag_EnableInEditmode,
255
256     /* copyData */ modifier_copyData_generic,
257
258     /* deformVerts */ NULL,
259     /* deformMatrices */ NULL,
260     /* deformVertsEM */ NULL,
261     /* deformMatricesEM */ NULL,
262     /* applyModifier */ applyModifier,
263
264     /* initData */ initData,
265     /* requiredDataMask */ requiredDataMask,
266     /* freeData */ NULL,
267     /* isDisabled */ NULL,
268     /* updateDepsgraph */ updateDepsgraph,
269     /* dependsOnTime */ NULL,
270     /* dependsOnNormals */ NULL,
271     /* foreachObjectLink */ foreachObjectLink,
272     /* foreachIDLink */ NULL,
273     /* foreachTexLink */ NULL,
274     /* freeRuntimeData */ NULL,
275 };