d3c0dd783cccd928f4f0968cf5050883d14f5da0
[blender.git] / source / blender / modifiers / intern / MOD_datatransfer.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) 2014 Blender Foundation.
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_datatransfer.c
28  *  \ingroup modifiers
29  */
30
31 #include "BLI_utildefines.h"
32 #include "BLI_math.h"
33
34 #include "DNA_mesh_types.h"
35 #include "DNA_meshdata_types.h"
36 #include "DNA_modifier_types.h"
37 #include "DNA_object_types.h"
38
39 #include "BKE_customdata.h"
40 #include "BKE_data_transfer.h"
41 #include "BKE_library.h"
42 #include "BKE_library_query.h"
43 #include "BKE_mesh_mapping.h"
44 #include "BKE_mesh_remap.h"
45 #include "BKE_modifier.h"
46 #include "BKE_report.h"
47
48 #include "DEG_depsgraph_query.h"
49
50 #include "MEM_guardedalloc.h"
51 #include "MOD_util.h"
52
53 /**************************************
54  * Modifiers functions.               *
55  **************************************/
56 static void initData(ModifierData *md)
57 {
58         DataTransferModifierData *dtmd = (DataTransferModifierData *) md;
59         int i;
60
61         dtmd->ob_source          = NULL;
62         dtmd->data_types         = 0;
63
64         dtmd->vmap_mode          = MREMAP_MODE_VERT_NEAREST;
65         dtmd->emap_mode          = MREMAP_MODE_EDGE_NEAREST;
66         dtmd->lmap_mode          = MREMAP_MODE_LOOP_NEAREST_POLYNOR;
67         dtmd->pmap_mode          = MREMAP_MODE_POLY_NEAREST;
68
69         dtmd->map_max_distance   = 1.0f;
70         dtmd->map_ray_radius     = 0.0f;
71
72         for (i = 0; i < DT_MULTILAYER_INDEX_MAX; i++) {
73                 dtmd->layers_select_src[i] = DT_LAYERS_ALL_SRC;
74                 dtmd->layers_select_dst[i]   = DT_LAYERS_NAME_DST;
75         }
76
77         dtmd->mix_mode           = CDT_MIX_TRANSFER;
78         dtmd->mix_factor         = 1.0f;
79         dtmd->defgrp_name[0]     = '\0';
80
81         dtmd->flags              = MOD_DATATRANSFER_OBSRC_TRANSFORM;
82 }
83
84 static CustomDataMask requiredDataMask(Object *UNUSED(ob), ModifierData *md)
85 {
86         DataTransferModifierData *dtmd = (DataTransferModifierData *) md;
87         CustomDataMask dataMask = 0;
88
89         if (dtmd->defgrp_name[0]) {
90                 /* We need vertex groups! */
91                 dataMask |= CD_MASK_MDEFORMVERT;
92         }
93
94         dataMask |= BKE_object_data_transfer_dttypes_to_cdmask(dtmd->data_types);
95
96         return dataMask;
97 }
98
99 static bool dependsOnNormals(ModifierData *md)
100 {
101         DataTransferModifierData *dtmd = (DataTransferModifierData *) md;
102         int item_types = BKE_object_data_transfer_get_dttypes_item_types(dtmd->data_types);
103
104         if ((item_types & ME_VERT) && (dtmd->vmap_mode & (MREMAP_USE_NORPROJ | MREMAP_USE_NORMAL))) {
105                 return true;
106         }
107         if ((item_types & ME_EDGE) && (dtmd->emap_mode & (MREMAP_USE_NORPROJ | MREMAP_USE_NORMAL))) {
108                 return true;
109         }
110         if ((item_types & ME_LOOP) && (dtmd->lmap_mode & (MREMAP_USE_NORPROJ | MREMAP_USE_NORMAL))) {
111                 return true;
112         }
113         if ((item_types & ME_POLY) && (dtmd->pmap_mode & (MREMAP_USE_NORPROJ | MREMAP_USE_NORMAL))) {
114                 return true;
115         }
116
117         return false;
118 }
119
120 static void foreachObjectLink(
121         ModifierData *md, Object *ob,
122         ObjectWalkFunc walk, void *userData)
123 {
124         DataTransferModifierData *dtmd = (DataTransferModifierData *) md;
125         walk(userData, ob, &dtmd->ob_source, IDWALK_CB_NOP);
126 }
127
128 static void updateDepsgraph(ModifierData *md, const ModifierUpdateDepsgraphContext *ctx)
129 {
130         DataTransferModifierData *dtmd = (DataTransferModifierData *) md;
131         if (dtmd->ob_source != NULL) {
132                 CustomDataMask mask = BKE_object_data_transfer_dttypes_to_cdmask(dtmd->data_types);
133
134                 DEG_add_object_relation_with_customdata(ctx->node, dtmd->ob_source, DEG_OB_COMP_GEOMETRY, mask, "DataTransfer Modifier");
135
136                 if (dtmd->flags & MOD_DATATRANSFER_OBSRC_TRANSFORM) {
137                         DEG_add_object_relation(ctx->node, dtmd->ob_source, DEG_OB_COMP_TRANSFORM, "DataTransfer Modifier");
138                         DEG_add_object_relation(ctx->node, ctx->object, DEG_OB_COMP_TRANSFORM, "DataTransfer Modifier");
139                 }
140         }
141 }
142
143 static bool isDisabled(const struct Scene *UNUSED(scene), ModifierData *md, bool UNUSED(useRenderParams))
144 {
145         DataTransferModifierData *dtmd = (DataTransferModifierData *) md;
146         /* If no source object, bypass. */
147         return (dtmd->ob_source == NULL);
148 }
149
150 #define HIGH_POLY_WARNING 10000
151 #define DT_TYPES_AFFECT_MESH ( \
152         DT_TYPE_BWEIGHT_VERT | \
153         DT_TYPE_BWEIGHT_EDGE | DT_TYPE_CREASE | DT_TYPE_SHARP_EDGE | \
154         DT_TYPE_LNOR | \
155         DT_TYPE_SHARP_FACE \
156 )
157
158 static Mesh *applyModifier(ModifierData *md, const ModifierEvalContext *ctx, Mesh *me_mod)
159 {
160         DataTransferModifierData *dtmd = (DataTransferModifierData *) md;
161         struct Scene *scene = DEG_get_evaluated_scene(ctx->depsgraph);
162         Mesh *result = me_mod;
163         ReportList reports;
164
165         /* Only used to check wehther we are operating on org data or not... */
166         Mesh *me = ctx->object->data;
167
168         const bool invert_vgroup = (dtmd->flags & MOD_DATATRANSFER_INVERT_VGROUP) != 0;
169
170         const float max_dist = (dtmd->flags & MOD_DATATRANSFER_MAP_MAXDIST) ? dtmd->map_max_distance : FLT_MAX;
171
172         SpaceTransform space_transform_data;
173         SpaceTransform *space_transform = (dtmd->flags & MOD_DATATRANSFER_OBSRC_TRANSFORM) ? &space_transform_data : NULL;
174
175         if (space_transform) {
176                 BLI_SPACE_TRANSFORM_SETUP(space_transform, ctx->object, dtmd->ob_source);
177         }
178
179         if ((result == me_mod || (me->mvert == result->mvert) || (me->medge == result->medge)) &&
180             (dtmd->data_types & DT_TYPES_AFFECT_MESH))
181         {
182                 /* We need to duplicate data here, otherwise setting custom normals, edges' shaprness, etc., could
183                  * modify org mesh, see T43671. */
184                 BKE_id_copy_ex(
185                         NULL, &me_mod->id, (ID **)&result,
186                         LIB_ID_CREATE_NO_MAIN |
187                         LIB_ID_CREATE_NO_USER_REFCOUNT |
188                         LIB_ID_CREATE_NO_DEG_TAG |
189                         LIB_ID_COPY_NO_PREVIEW,
190                         false);
191         }
192
193         BKE_reports_init(&reports, RPT_STORE);
194
195         /* Note: no islands precision for now here. */
196         BKE_object_data_transfer_ex(ctx->depsgraph, scene, dtmd->ob_source, ctx->object, result, dtmd->data_types, false,
197                              dtmd->vmap_mode, dtmd->emap_mode, dtmd->lmap_mode, dtmd->pmap_mode,
198                              space_transform, false, max_dist, dtmd->map_ray_radius, 0.0f,
199                              dtmd->layers_select_src, dtmd->layers_select_dst,
200                              dtmd->mix_mode, dtmd->mix_factor, dtmd->defgrp_name, invert_vgroup, &reports);
201
202         if (BKE_reports_contain(&reports, RPT_ERROR)) {
203                 modifier_setError(md, "%s", BKE_reports_string(&reports, RPT_ERROR));
204         }
205         else if ((dtmd->data_types & DT_TYPE_LNOR) && !(me->flag & ME_AUTOSMOOTH)) {
206                 modifier_setError((ModifierData *)dtmd, "Enable 'Auto Smooth' option in mesh settings");
207         }
208         else if (result->totvert > HIGH_POLY_WARNING || ((Mesh *)(dtmd->ob_source->data))->totvert > HIGH_POLY_WARNING) {
209                 modifier_setError(md, "You are using a rather high poly as source or destination, computation might be slow");
210         }
211
212         return result;
213 }
214
215 #undef HIGH_POLY_WARNING
216 #undef DT_TYPES_AFFECT_MESH
217
218 ModifierTypeInfo modifierType_DataTransfer = {
219         /* name */              "DataTransfer",
220         /* structName */        "DataTransferModifierData",
221         /* structSize */        sizeof(DataTransferModifierData),
222         /* type */              eModifierTypeType_NonGeometrical,
223         /* flags */             eModifierTypeFlag_AcceptsMesh |
224                                 eModifierTypeFlag_SupportsMapping |
225                                 eModifierTypeFlag_SupportsEditmode |
226                                 eModifierTypeFlag_UsesPreview,
227
228         /* copyData */          modifier_copyData_generic,
229
230         /* deformVerts_DM */    NULL,
231         /* deformMatrices_DM */ NULL,
232         /* deformVertsEM_DM */  NULL,
233         /* deformMatricesEM_DM*/NULL,
234         /* applyModifier_DM */  NULL,
235
236         /* deformVerts */       NULL,
237         /* deformMatrices */    NULL,
238         /* deformVertsEM */     NULL,
239         /* deformMatricesEM */  NULL,
240         /* applyModifier */     applyModifier,
241
242         /* initData */          initData,
243         /* requiredDataMask */  requiredDataMask,
244         /* freeData */          NULL,
245         /* isDisabled */        isDisabled,
246         /* updateDepsgraph */   updateDepsgraph,
247         /* dependsOnTime */     NULL,
248         /* dependsOnNormals */  dependsOnNormals,
249         /* foreachObjectLink */ foreachObjectLink,
250         /* foreachIDLink */     NULL,
251         /* foreachTexLink */    NULL,
252 };