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