Merge branch 'blender2.7'
[blender.git] / source / blender / modifiers / intern / MOD_multires.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) 2005 by the Blender Foundation.
19  * All rights reserved.
20  *
21  * Contributor(s): Daniel Dunbar
22  *                 Ton Roosendaal,
23  *                 Ben Batt,
24  *                 Brecht Van Lommel,
25  *                 Campbell Barton
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  *
29  */
30
31 /** \file blender/modifiers/intern/MOD_multires.c
32  *  \ingroup modifiers
33  */
34
35
36 #include <stddef.h>
37
38 #include "DNA_mesh_types.h"
39 #include "DNA_object_types.h"
40 #include "DNA_scene_types.h"
41
42 #include "BLI_utildefines.h"
43
44 #include "BKE_cdderivedmesh.h"
45 #include "BKE_mesh.h"
46 #include "BKE_multires.h"
47 #include "BKE_modifier.h"
48 #include "BKE_subdiv.h"
49 #include "BKE_subdiv_ccg.h"
50 #include "BKE_subdiv_mesh.h"
51 #include "BKE_subsurf.h"
52
53 #include "DEG_depsgraph_query.h"
54
55 #include "MOD_modifiertypes.h"
56
57 static void initData(ModifierData *md)
58 {
59         MultiresModifierData *mmd = (MultiresModifierData *)md;
60
61         mmd->lvl = 0;
62         mmd->sculptlvl = 0;
63         mmd->renderlvl = 0;
64         mmd->totlvl = 0;
65         mmd->uv_smooth = SUBSURF_UV_SMOOTH_PRESERVE_CORNERS;
66         mmd->quality = 3;
67 }
68
69 static void freeData(ModifierData *md)
70 {
71         MultiresModifierData *mmd = (MultiresModifierData *) md;
72         if (mmd->subdiv != NULL) {
73                 BKE_subdiv_free(mmd->subdiv);
74         }
75 }
76
77 /* Main goal of this function is to give usable subdivision surface descriptor
78  * which matches settings and topology. */
79 static Subdiv *subdiv_descriptor_ensure(MultiresModifierData *mmd,
80                                         const SubdivSettings *subdiv_settings,
81                                         const Mesh *mesh)
82 {
83         Subdiv *subdiv = BKE_subdiv_update_from_mesh(
84                 mmd->subdiv, subdiv_settings, mesh);
85         if (false) {
86                 mmd->subdiv = subdiv;
87         }
88         return subdiv;
89 }
90
91 /* Subdivide into fully qualified mesh. */
92
93 static Mesh *multires_as_mesh(MultiresModifierData *mmd,
94                               const ModifierEvalContext *ctx,
95                               Mesh *mesh,
96                               Subdiv *subdiv)
97 {
98         Mesh *result = mesh;
99         const bool use_render_params = (ctx->flag & MOD_APPLY_RENDER);
100         const bool ignore_simplify = (ctx->flag & MOD_APPLY_IGNORE_SIMPLIFY);
101         const Scene *scene = DEG_get_evaluated_scene(ctx->depsgraph);
102         Object *object = ctx->object;
103         SubdivToMeshSettings mesh_settings;
104         BKE_multires_subdiv_mesh_settings_init(
105         &mesh_settings, scene, object, mmd, use_render_params, ignore_simplify);
106         if (mesh_settings.resolution < 3) {
107                 return result;
108         }
109         BKE_subdiv_displacement_attach_from_multires(subdiv, mesh, mmd);
110         result = BKE_subdiv_to_mesh(subdiv, &mesh_settings, mesh);
111         return result;
112 }
113
114 /* Subdivide into CCG. */
115
116 static void multires_ccg_settings_init(SubdivToCCGSettings *settings,
117                                        const MultiresModifierData *mmd,
118                                        const ModifierEvalContext *ctx,
119                                        Mesh *mesh)
120 {
121         const bool has_mask =
122                 CustomData_has_layer(&mesh->ldata, CD_GRID_PAINT_MASK);
123         const bool use_render_params = (ctx->flag & MOD_APPLY_RENDER);
124         const bool ignore_simplify = (ctx->flag & MOD_APPLY_IGNORE_SIMPLIFY);
125         const Scene *scene = DEG_get_evaluated_scene(ctx->depsgraph);
126         Object *object = ctx->object;
127         const int level = multires_get_level(
128                 scene, object, mmd, use_render_params, ignore_simplify);
129         settings->resolution = (1 << level) + 1;
130         settings->need_normal = true;
131         settings->need_mask = has_mask;
132 }
133
134 static Mesh *multires_as_ccg(MultiresModifierData *mmd,
135                              const ModifierEvalContext *ctx,
136                              Mesh *mesh,
137                              Subdiv *subdiv)
138 {
139         Mesh *result = mesh;
140         SubdivToCCGSettings ccg_settings;
141         multires_ccg_settings_init(&ccg_settings, mmd, ctx, mesh);
142         if (ccg_settings.resolution < 3) {
143                 return result;
144         }
145         BKE_subdiv_displacement_attach_from_multires(subdiv, mesh, mmd);
146         result = BKE_subdiv_to_ccg_mesh(subdiv, &ccg_settings, mesh);
147         return result;
148 }
149
150 static Mesh *applyModifier(ModifierData *md,
151                            const ModifierEvalContext *ctx,
152                            Mesh *mesh)
153 {
154         Mesh *result = mesh;
155         MultiresModifierData *mmd = (MultiresModifierData *)md;
156         SubdivSettings subdiv_settings;
157         BKE_multires_subdiv_settings_init(&subdiv_settings, mmd);
158         if (subdiv_settings.level == 0) {
159                 return result;
160         }
161         BKE_subdiv_settings_validate_for_mesh(&subdiv_settings, mesh);
162         Subdiv *subdiv = subdiv_descriptor_ensure(mmd, &subdiv_settings, mesh);
163         if (subdiv == NULL) {
164                 /* Happens on bad topology, ut also on empty input mesh. */
165                 return result;
166         }
167         /* NOTE: Orco needs final coordinates on CPU side, which are expected to be
168          * accessible via MVert. For this reason we do not evaluate multires to
169          * grids when orco is requested. */
170         const bool for_orco = (ctx->flag & MOD_APPLY_ORCO) != 0;
171         if ((ctx->object->mode & OB_MODE_SCULPT) && !for_orco) {
172                 /* NOTE: CCG takes ownership over Subdiv. */
173                 result = multires_as_ccg(mmd, ctx, mesh, subdiv);
174                 result->runtime.subdiv_ccg_tot_level = mmd->totlvl;
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 */          modifier_copyData_generic,
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 };