Merge branch 'blender2.7'
[blender.git] / source / blender / modifiers / intern / MOD_multires.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) 2005 by the Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup modifiers
22  */
23
24
25 #include <stddef.h>
26
27 #include "BLI_utildefines.h"
28
29 #include "DNA_mesh_types.h"
30 #include "DNA_object_types.h"
31 #include "DNA_scene_types.h"
32
33 #include "BKE_cdderivedmesh.h"
34 #include "BKE_mesh.h"
35 #include "BKE_multires.h"
36 #include "BKE_modifier.h"
37 #include "BKE_subdiv.h"
38 #include "BKE_subdiv_ccg.h"
39 #include "BKE_subdiv_mesh.h"
40 #include "BKE_subsurf.h"
41
42 #include "DEG_depsgraph_query.h"
43
44 #include "MOD_modifiertypes.h"
45
46 static void initData(ModifierData *md)
47 {
48         MultiresModifierData *mmd = (MultiresModifierData *)md;
49
50         mmd->lvl = 0;
51         mmd->sculptlvl = 0;
52         mmd->renderlvl = 0;
53         mmd->totlvl = 0;
54         mmd->uv_smooth = SUBSURF_UV_SMOOTH_PRESERVE_CORNERS;
55         mmd->quality = 3;
56 }
57
58 static void copyData(const ModifierData *md_src, ModifierData *md_dst, const int flag)
59 {
60         MultiresModifierData *mmd_dst = (MultiresModifierData *)md_dst;
61
62         modifier_copyData_generic(md_src, md_dst, flag);
63
64         mmd_dst->subdiv = NULL;
65 }
66
67 static void freeData(ModifierData *md)
68 {
69         MultiresModifierData *mmd = (MultiresModifierData *) md;
70         if (mmd->subdiv != NULL) {
71                 BKE_subdiv_free(mmd->subdiv);
72         }
73 }
74
75 /* Main goal of this function is to give usable subdivision surface descriptor
76  * which matches settings and topology. */
77 static Subdiv *subdiv_descriptor_ensure(MultiresModifierData *mmd,
78                                         const SubdivSettings *subdiv_settings,
79                                         const Mesh *mesh)
80 {
81         Subdiv *subdiv = BKE_subdiv_update_from_mesh(
82                 mmd->subdiv, subdiv_settings, mesh);
83         mmd->subdiv = subdiv;
84         return subdiv;
85 }
86
87 /* Subdivide into fully qualified mesh. */
88
89 static Mesh *multires_as_mesh(MultiresModifierData *mmd,
90                               const ModifierEvalContext *ctx,
91                               Mesh *mesh,
92                               Subdiv *subdiv)
93 {
94         Mesh *result = mesh;
95         const bool use_render_params = (ctx->flag & MOD_APPLY_RENDER);
96         const bool ignore_simplify = (ctx->flag & MOD_APPLY_IGNORE_SIMPLIFY);
97         const Scene *scene = DEG_get_evaluated_scene(ctx->depsgraph);
98         Object *object = ctx->object;
99         SubdivToMeshSettings mesh_settings;
100         BKE_multires_subdiv_mesh_settings_init(
101         &mesh_settings, scene, object, mmd, use_render_params, ignore_simplify);
102         if (mesh_settings.resolution < 3) {
103                 return result;
104         }
105         BKE_subdiv_displacement_attach_from_multires(subdiv, mesh, mmd);
106         result = BKE_subdiv_to_mesh(subdiv, &mesh_settings, mesh);
107         return result;
108 }
109
110 /* Subdivide into CCG. */
111
112 static void multires_ccg_settings_init(SubdivToCCGSettings *settings,
113                                        const MultiresModifierData *mmd,
114                                        const ModifierEvalContext *ctx,
115                                        Mesh *mesh)
116 {
117         const bool has_mask =
118                 CustomData_has_layer(&mesh->ldata, CD_GRID_PAINT_MASK);
119         const bool use_render_params = (ctx->flag & MOD_APPLY_RENDER);
120         const bool ignore_simplify = (ctx->flag & MOD_APPLY_IGNORE_SIMPLIFY);
121         const Scene *scene = DEG_get_evaluated_scene(ctx->depsgraph);
122         Object *object = ctx->object;
123         const int level = multires_get_level(
124                 scene, object, mmd, use_render_params, ignore_simplify);
125         settings->resolution = (1 << level) + 1;
126         settings->need_normal = true;
127         settings->need_mask = has_mask;
128 }
129
130 static Mesh *multires_as_ccg(MultiresModifierData *mmd,
131                              const ModifierEvalContext *ctx,
132                              Mesh *mesh,
133                              Subdiv *subdiv)
134 {
135         Mesh *result = mesh;
136         SubdivToCCGSettings ccg_settings;
137         multires_ccg_settings_init(&ccg_settings, mmd, ctx, mesh);
138         if (ccg_settings.resolution < 3) {
139                 return result;
140         }
141         BKE_subdiv_displacement_attach_from_multires(subdiv, mesh, mmd);
142         result = BKE_subdiv_to_ccg_mesh(subdiv, &ccg_settings, mesh);
143         return result;
144 }
145
146 static Mesh *applyModifier(ModifierData *md,
147                            const ModifierEvalContext *ctx,
148                            Mesh *mesh)
149 {
150         Mesh *result = mesh;
151         MultiresModifierData *mmd = (MultiresModifierData *)md;
152         SubdivSettings subdiv_settings;
153         BKE_multires_subdiv_settings_init(&subdiv_settings, mmd);
154         if (subdiv_settings.level == 0) {
155                 return result;
156         }
157         BKE_subdiv_settings_validate_for_mesh(&subdiv_settings, mesh);
158         Subdiv *subdiv = subdiv_descriptor_ensure(mmd, &subdiv_settings, mesh);
159         if (subdiv == NULL) {
160                 /* Happens on bad topology, ut also on empty input mesh. */
161                 return result;
162         }
163         /* NOTE: Orco needs final coordinates on CPU side, which are expected to be
164          * accessible via MVert. For this reason we do not evaluate multires to
165          * grids when orco is requested. */
166         const bool for_orco = (ctx->flag & MOD_APPLY_ORCO) != 0;
167         if ((ctx->object->mode & OB_MODE_SCULPT) && !for_orco) {
168                 /* NOTE: CCG takes ownership over Subdiv. */
169                 result = multires_as_ccg(mmd, ctx, mesh, subdiv);
170                 result->runtime.subdiv_ccg_tot_level = mmd->totlvl;
171                 /* NOTE: CCG becomes an owner of Subdiv descriptor, so can not share
172                  * this pointer. Not sure if it's needed, but might have a second look
173                  * on the ownership model here. */
174                 mmd->subdiv = NULL;
175                 // BKE_subdiv_stats_print(&subdiv->stats);
176         }
177         else {
178                 result = multires_as_mesh(mmd, ctx, mesh, subdiv);
179                 // BKE_subdiv_stats_print(&subdiv->stats);
180                 if (subdiv != mmd->subdiv) {
181                         BKE_subdiv_free(subdiv);
182                 }
183         }
184         return result;
185 }
186
187 ModifierTypeInfo modifierType_Multires = {
188         /* name */              "Multires",
189         /* structName */        "MultiresModifierData",
190         /* structSize */        sizeof(MultiresModifierData),
191         /* type */              eModifierTypeType_Constructive,
192         /* flags */             eModifierTypeFlag_AcceptsMesh |
193                                 eModifierTypeFlag_SupportsMapping |
194                                 eModifierTypeFlag_RequiresOriginalData,
195
196         /* copyData */          copyData,
197
198         /* deformVerts_DM */    NULL,
199         /* deformMatrices_DM */ NULL,
200         /* deformVertsEM_DM */  NULL,
201         /* deformMatricesEM_DM*/NULL,
202         /* applyModifier_DM */  NULL,
203
204         /* deformVerts */       NULL,
205         /* deformMatrices */    NULL,
206         /* deformVertsEM */     NULL,
207         /* deformMatricesEM */  NULL,
208         /* applyModifier */     applyModifier,
209
210         /* initData */          initData,
211         /* requiredDataMask */  NULL,
212         /* freeData */          freeData,
213         /* isDisabled */        NULL,
214         /* updateDepsgraph */   NULL,
215         /* dependsOnTime */     NULL,
216         /* dependsOnNormals */  NULL,
217         /* foreachObjectLink */ NULL,
218         /* foreachIDLink */     NULL,
219         /* foreachTexLink */    NULL,
220 };