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 "DNA_mesh_types.h"
28 #include "DNA_object_types.h"
29 #include "DNA_scene_types.h"
30
31 #include "BLI_utildefines.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         if (false) {
84                 mmd->subdiv = subdiv;
85         }
86         return subdiv;
87 }
88
89 /* Subdivide into fully qualified mesh. */
90
91 static Mesh *multires_as_mesh(MultiresModifierData *mmd,
92                               const ModifierEvalContext *ctx,
93                               Mesh *mesh,
94                               Subdiv *subdiv)
95 {
96         Mesh *result = mesh;
97         const bool use_render_params = (ctx->flag & MOD_APPLY_RENDER);
98         const bool ignore_simplify = (ctx->flag & MOD_APPLY_IGNORE_SIMPLIFY);
99         const Scene *scene = DEG_get_evaluated_scene(ctx->depsgraph);
100         Object *object = ctx->object;
101         SubdivToMeshSettings mesh_settings;
102         BKE_multires_subdiv_mesh_settings_init(
103         &mesh_settings, scene, object, mmd, use_render_params, ignore_simplify);
104         if (mesh_settings.resolution < 3) {
105                 return result;
106         }
107         BKE_subdiv_displacement_attach_from_multires(subdiv, mesh, mmd);
108         result = BKE_subdiv_to_mesh(subdiv, &mesh_settings, mesh);
109         return result;
110 }
111
112 /* Subdivide into CCG. */
113
114 static void multires_ccg_settings_init(SubdivToCCGSettings *settings,
115                                        const MultiresModifierData *mmd,
116                                        const ModifierEvalContext *ctx,
117                                        Mesh *mesh)
118 {
119         const bool has_mask =
120                 CustomData_has_layer(&mesh->ldata, CD_GRID_PAINT_MASK);
121         const bool use_render_params = (ctx->flag & MOD_APPLY_RENDER);
122         const bool ignore_simplify = (ctx->flag & MOD_APPLY_IGNORE_SIMPLIFY);
123         const Scene *scene = DEG_get_evaluated_scene(ctx->depsgraph);
124         Object *object = ctx->object;
125         const int level = multires_get_level(
126                 scene, object, mmd, use_render_params, ignore_simplify);
127         settings->resolution = (1 << level) + 1;
128         settings->need_normal = true;
129         settings->need_mask = has_mask;
130 }
131
132 static Mesh *multires_as_ccg(MultiresModifierData *mmd,
133                              const ModifierEvalContext *ctx,
134                              Mesh *mesh,
135                              Subdiv *subdiv)
136 {
137         Mesh *result = mesh;
138         SubdivToCCGSettings ccg_settings;
139         multires_ccg_settings_init(&ccg_settings, mmd, ctx, mesh);
140         if (ccg_settings.resolution < 3) {
141                 return result;
142         }
143         BKE_subdiv_displacement_attach_from_multires(subdiv, mesh, mmd);
144         result = BKE_subdiv_to_ccg_mesh(subdiv, &ccg_settings, mesh);
145         return result;
146 }
147
148 static Mesh *applyModifier(ModifierData *md,
149                            const ModifierEvalContext *ctx,
150                            Mesh *mesh)
151 {
152         Mesh *result = mesh;
153         MultiresModifierData *mmd = (MultiresModifierData *)md;
154         SubdivSettings subdiv_settings;
155         BKE_multires_subdiv_settings_init(&subdiv_settings, mmd);
156         if (subdiv_settings.level == 0) {
157                 return result;
158         }
159         BKE_subdiv_settings_validate_for_mesh(&subdiv_settings, mesh);
160         Subdiv *subdiv = subdiv_descriptor_ensure(mmd, &subdiv_settings, mesh);
161         if (subdiv == NULL) {
162                 /* Happens on bad topology, ut also on empty input mesh. */
163                 return result;
164         }
165         /* NOTE: Orco needs final coordinates on CPU side, which are expected to be
166          * accessible via MVert. For this reason we do not evaluate multires to
167          * grids when orco is requested. */
168         const bool for_orco = (ctx->flag & MOD_APPLY_ORCO) != 0;
169         if ((ctx->object->mode & OB_MODE_SCULPT) && !for_orco) {
170                 /* NOTE: CCG takes ownership over Subdiv. */
171                 result = multires_as_ccg(mmd, ctx, mesh, subdiv);
172                 result->runtime.subdiv_ccg_tot_level = mmd->totlvl;
173                 // BKE_subdiv_stats_print(&subdiv->stats);
174         }
175         else {
176                 result = multires_as_mesh(mmd, ctx, mesh, subdiv);
177                 // BKE_subdiv_stats_print(&subdiv->stats);
178                 if (subdiv != mmd->subdiv) {
179                         BKE_subdiv_free(subdiv);
180                 }
181         }
182         return result;
183 }
184
185 ModifierTypeInfo modifierType_Multires = {
186         /* name */              "Multires",
187         /* structName */        "MultiresModifierData",
188         /* structSize */        sizeof(MultiresModifierData),
189         /* type */              eModifierTypeType_Constructive,
190         /* flags */             eModifierTypeFlag_AcceptsMesh |
191                                 eModifierTypeFlag_SupportsMapping |
192                                 eModifierTypeFlag_RequiresOriginalData,
193
194         /* copyData */          copyData,
195
196         /* deformVerts_DM */    NULL,
197         /* deformMatrices_DM */ NULL,
198         /* deformVertsEM_DM */  NULL,
199         /* deformMatricesEM_DM*/NULL,
200         /* applyModifier_DM */  NULL,
201
202         /* deformVerts */       NULL,
203         /* deformMatrices */    NULL,
204         /* deformVertsEM */     NULL,
205         /* deformMatricesEM */  NULL,
206         /* applyModifier */     applyModifier,
207
208         /* initData */          initData,
209         /* requiredDataMask */  NULL,
210         /* freeData */          freeData,
211         /* isDisabled */        NULL,
212         /* updateDepsgraph */   NULL,
213         /* dependsOnTime */     NULL,
214         /* dependsOnNormals */  NULL,
215         /* foreachObjectLink */ NULL,
216         /* foreachIDLink */     NULL,
217         /* foreachTexLink */    NULL,
218 };