Merge branch 'master' into blender2.8
[blender.git] / source / blender / modifiers / intern / MOD_uvproject.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) 2005 by the Blender Foundation.
19  * All rights reserved.
20  *
21  * Contributor(s): Daniel Dunbar
22  *                 Ton Roosendaal,
23  *                 Ben Batt,
24  *                 Brecht Van Lommel,
25  *                 Campbell Barton
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  *
29  */
30
31 /** \file blender/modifiers/intern/MOD_uvproject.c
32  *  \ingroup modifiers
33  */
34
35
36 /* UV Project modifier: Generates UVs projected from an object */
37
38 #include "DNA_meshdata_types.h"
39 #include "DNA_camera_types.h"
40 #include "DNA_object_types.h"
41
42 #include "BLI_math.h"
43 #include "BLI_uvproject.h"
44 #include "BLI_utildefines.h"
45
46
47 #include "BKE_camera.h"
48 #include "BKE_library.h"
49 #include "BKE_library_query.h"
50 #include "BKE_material.h"
51 #include "BKE_mesh.h"
52 #include "BKE_DerivedMesh.h"
53
54 #include "MOD_modifiertypes.h"
55
56 #include "MEM_guardedalloc.h"
57
58 #include "DEG_depsgraph_build.h"
59
60 static void initData(ModifierData *md)
61 {
62         UVProjectModifierData *umd = (UVProjectModifierData *) md;
63
64
65         umd->num_projectors = 1;
66         umd->aspectx = umd->aspecty = 1.0f;
67         umd->scalex = umd->scaley = 1.0f;
68 }
69
70 static CustomDataMask requiredDataMask(Object *UNUSED(ob), ModifierData *UNUSED(md))
71 {
72         CustomDataMask dataMask = 0;
73
74         /* ask for UV coordinates */
75         dataMask |= CD_MLOOPUV;
76
77         return dataMask;
78 }
79
80 static void foreachObjectLink(ModifierData *md, Object *ob,
81                               ObjectWalkFunc walk, void *userData)
82 {
83         UVProjectModifierData *umd = (UVProjectModifierData *) md;
84         int i;
85
86         for (i = 0; i < MOD_UVPROJECT_MAXPROJECTORS; ++i)
87                 walk(userData, ob, &umd->projectors[i], IDWALK_CB_NOP);
88 }
89
90 static void foreachIDLink(ModifierData *md, Object *ob,
91                           IDWalkFunc walk, void *userData)
92 {
93 #if 0
94         UVProjectModifierData *umd = (UVProjectModifierData *) md;
95 #endif
96
97         foreachObjectLink(md, ob, (ObjectWalkFunc)walk, userData);
98 }
99
100 static void updateDepsgraph(ModifierData *md, const ModifierUpdateDepsgraphContext *ctx)
101 {
102         UVProjectModifierData *umd = (UVProjectModifierData *)md;
103         int i;
104         for (i = 0; i < umd->num_projectors; ++i) {
105                 if (umd->projectors[i] != NULL) {
106                         DEG_add_object_relation(ctx->node, umd->projectors[i], DEG_OB_COMP_TRANSFORM, "UV Project Modifier");
107                 }
108         }
109 }
110
111 typedef struct Projector {
112         Object *ob;             /* object this projector is derived from */
113         float projmat[4][4];    /* projection matrix */
114         float normal[3];        /* projector normal in world space */
115         void *uci;              /* optional uv-project info (panorama projection) */
116 } Projector;
117
118 static DerivedMesh *uvprojectModifier_do(UVProjectModifierData *umd,
119                                          Object *ob, DerivedMesh *dm)
120 {
121         float (*coords)[3], (*co)[3];
122         MLoopUV *mloop_uv;
123         int i, numVerts, numPolys, numLoops;
124         MPoly *mpoly, *mp;
125         MLoop *mloop;
126         Projector projectors[MOD_UVPROJECT_MAXPROJECTORS];
127         int num_projectors = 0;
128         char uvname[MAX_CUSTOMDATA_LAYER_NAME];
129         float aspx = umd->aspectx ? umd->aspectx : 1.0f;
130         float aspy = umd->aspecty ? umd->aspecty : 1.0f;
131         float scax = umd->scalex ? umd->scalex : 1.0f;
132         float scay = umd->scaley ? umd->scaley : 1.0f;
133         int free_uci = 0;
134
135         for (i = 0; i < umd->num_projectors; ++i)
136                 if (umd->projectors[i])
137                         projectors[num_projectors++].ob = umd->projectors[i];
138
139         if (num_projectors == 0) return dm;
140
141         /* make sure there are UV Maps available */
142
143         if (!CustomData_has_layer(&dm->loopData, CD_MLOOPUV)) return dm;
144
145         /* make sure we're using an existing layer */
146         CustomData_validate_layer_name(&dm->loopData, CD_MLOOPUV, umd->uvlayer_name, uvname);
147
148         /* calculate a projection matrix and normal for each projector */
149         for (i = 0; i < num_projectors; ++i) {
150                 float tmpmat[4][4];
151                 float offsetmat[4][4];
152                 Camera *cam = NULL;
153                 /* calculate projection matrix */
154                 invert_m4_m4(projectors[i].projmat, projectors[i].ob->obmat);
155
156                 projectors[i].uci = NULL;
157
158                 if (projectors[i].ob->type == OB_CAMERA) {
159                         
160                         cam = (Camera *)projectors[i].ob->data;
161                         if (cam->type == CAM_PANO) {
162                                 projectors[i].uci = BLI_uvproject_camera_info(projectors[i].ob, NULL, aspx, aspy);
163                                 BLI_uvproject_camera_info_scale(projectors[i].uci, scax, scay);
164                                 free_uci = 1;
165                         }
166                         else {
167                                 CameraParams params;
168
169                                 /* setup parameters */
170                                 BKE_camera_params_init(&params);
171                                 BKE_camera_params_from_object(&params, projectors[i].ob);
172
173                                 /* compute matrix, viewplane, .. */
174                                 BKE_camera_params_compute_viewplane(&params, 1, 1, aspx, aspy);
175
176                                 /* scale the view-plane */
177                                 params.viewplane.xmin *= scax;
178                                 params.viewplane.xmax *= scax;
179                                 params.viewplane.ymin *= scay;
180                                 params.viewplane.ymax *= scay;
181
182                                 BKE_camera_params_compute_matrix(&params);
183                                 mul_m4_m4m4(tmpmat, params.winmat, projectors[i].projmat);
184                         }
185                 }
186                 else {
187                         copy_m4_m4(tmpmat, projectors[i].projmat);
188                 }
189
190                 unit_m4(offsetmat);
191                 mul_mat3_m4_fl(offsetmat, 0.5);
192                 offsetmat[3][0] = offsetmat[3][1] = offsetmat[3][2] = 0.5;
193
194                 mul_m4_m4m4(projectors[i].projmat, offsetmat, tmpmat);
195
196                 /* calculate worldspace projector normal (for best projector test) */
197                 projectors[i].normal[0] = 0;
198                 projectors[i].normal[1] = 0;
199                 projectors[i].normal[2] = 1;
200                 mul_mat3_m4_v3(projectors[i].ob->obmat, projectors[i].normal);
201         }
202
203         numPolys = dm->getNumPolys(dm);
204         numLoops = dm->getNumLoops(dm);
205
206         /* make sure we are not modifying the original UV map */
207         mloop_uv = CustomData_duplicate_referenced_layer_named(&dm->loopData,
208                                                                CD_MLOOPUV, uvname, numLoops);
209
210         numVerts = dm->getNumVerts(dm);
211
212         coords = MEM_malloc_arrayN(numVerts, sizeof(*coords),
213                              "uvprojectModifier_do coords");
214         dm->getVertCos(dm, coords);
215
216         /* convert coords to world space */
217         for (i = 0, co = coords; i < numVerts; ++i, ++co)
218                 mul_m4_v3(ob->obmat, *co);
219         
220         /* if only one projector, project coords to UVs */
221         if (num_projectors == 1 && projectors[0].uci == NULL)
222                 for (i = 0, co = coords; i < numVerts; ++i, ++co)
223                         mul_project_m4_v3(projectors[0].projmat, *co);
224
225         mpoly = dm->getPolyArray(dm);
226         mloop = dm->getLoopArray(dm);
227
228         /* apply coords as UVs */
229         for (i = 0, mp = mpoly; i < numPolys; ++i, ++mp) {
230                 if (num_projectors == 1) {
231                         if (projectors[0].uci) {
232                                 unsigned int fidx = mp->totloop - 1;
233                                 do {
234                                         unsigned int lidx = mp->loopstart + fidx;
235                                         unsigned int vidx = mloop[lidx].v;
236                                         BLI_uvproject_from_camera(mloop_uv[lidx].uv, coords[vidx], projectors[0].uci);
237                                 } while (fidx--);
238                         }
239                         else {
240                                 /* apply transformed coords as UVs */
241                                 unsigned int fidx = mp->totloop - 1;
242                                 do {
243                                         unsigned int lidx = mp->loopstart + fidx;
244                                         unsigned int vidx = mloop[lidx].v;
245                                         copy_v2_v2(mloop_uv[lidx].uv, coords[vidx]);
246                                 } while (fidx--);
247                         }
248                 }
249                 else {
250                         /* multiple projectors, select the closest to face normal direction */
251                         float face_no[3];
252                         int j;
253                         Projector *best_projector;
254                         float best_dot;
255
256                         /* get the untransformed face normal */
257                         BKE_mesh_calc_poly_normal_coords(mp, mloop + mp->loopstart, (const float (*)[3])coords, face_no);
258
259                         /* find the projector which the face points at most directly
260                          * (projector normal with largest dot product is best)
261                          */
262                         best_dot = dot_v3v3(projectors[0].normal, face_no);
263                         best_projector = &projectors[0];
264
265                         for (j = 1; j < num_projectors; ++j) {
266                                 float tmp_dot = dot_v3v3(projectors[j].normal, face_no);
267                                 if (tmp_dot > best_dot) {
268                                         best_dot = tmp_dot;
269                                         best_projector = &projectors[j];
270                                 }
271                         }
272
273                         if (best_projector->uci) {
274                                 unsigned int fidx = mp->totloop - 1;
275                                 do {
276                                         unsigned int lidx = mp->loopstart + fidx;
277                                         unsigned int vidx = mloop[lidx].v;
278                                         BLI_uvproject_from_camera(mloop_uv[lidx].uv, coords[vidx], best_projector->uci);
279                                 } while (fidx--);
280                         }
281                         else {
282                                 unsigned int fidx = mp->totloop - 1;
283                                 do {
284                                         unsigned int lidx = mp->loopstart + fidx;
285                                         unsigned int vidx = mloop[lidx].v;
286                                         mul_v2_project_m4_v3(mloop_uv[lidx].uv, best_projector->projmat, coords[vidx]);
287                                 } while (fidx--);
288                         }
289                 }
290         }
291
292         MEM_freeN(coords);
293
294         if (free_uci) {
295                 int j;
296                 for (j = 0; j < num_projectors; ++j) {
297                         if (projectors[j].uci) {
298                                 MEM_freeN(projectors[j].uci);
299                         }
300                 }
301         }
302
303         /* Mark tessellated CD layers as dirty. */
304         dm->dirty |= DM_DIRTY_TESS_CDLAYERS;
305
306         return dm;
307 }
308
309 static DerivedMesh *applyModifier(ModifierData *md, const ModifierEvalContext *ctx,
310                                   DerivedMesh *derivedData)
311 {
312         DerivedMesh *result;
313         UVProjectModifierData *umd = (UVProjectModifierData *) md;
314
315         result = uvprojectModifier_do(umd, ctx->object, derivedData);
316
317         return result;
318 }
319
320
321 ModifierTypeInfo modifierType_UVProject = {
322         /* name */              "UVProject",
323         /* structName */        "UVProjectModifierData",
324         /* structSize */        sizeof(UVProjectModifierData),
325         /* type */              eModifierTypeType_NonGeometrical,
326         /* flags */             eModifierTypeFlag_AcceptsMesh |
327                                 eModifierTypeFlag_SupportsMapping |
328                                 eModifierTypeFlag_SupportsEditmode |
329                                 eModifierTypeFlag_EnableInEditmode,
330
331         /* copyData */          modifier_copyData_generic,
332
333         /* deformVerts_DM */    NULL,
334         /* deformMatrices_DM */ NULL,
335         /* deformVertsEM_DM */  NULL,
336         /* deformMatricesEM_DM*/NULL,
337         /* applyModifier_DM */  applyModifier,
338         /* applyModifierEM_DM */NULL,
339
340         /* deformVerts */       NULL,
341         /* deformMatrices */    NULL,
342         /* deformVertsEM */     NULL,
343         /* deformMatricesEM */  NULL,
344         /* applyModifier */     NULL,
345         /* applyModifierEM */   NULL,
346
347         /* initData */          initData,
348         /* requiredDataMask */  requiredDataMask,
349         /* freeData */          NULL,
350         /* isDisabled */        NULL,
351         /* updateDepsgraph */   updateDepsgraph,
352         /* dependsOnTime */     NULL,
353         /* dependsOnNormals */  NULL,
354         /* foreachObjectLink */ foreachObjectLink,
355         /* foreachIDLink */     foreachIDLink,
356         /* foreachTexLink */    NULL,
357 };