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