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_global.h"
46 #include "BKE_mesh.h"
47 #include "BKE_multires.h"
48 #include "BKE_modifier.h"
49 #include "BKE_subdiv.h"
50 #include "BKE_subdiv_ccg.h"
51 #include "BKE_subdiv_mesh.h"
52 #include "BKE_subsurf.h"
53
54 #include "DEG_depsgraph_query.h"
55
56 #include "MOD_modifiertypes.h"
57
58 static void initData(ModifierData *md)
59 {
60         MultiresModifierData *mmd = (MultiresModifierData *)md;
61
62         mmd->lvl = 0;
63         mmd->sculptlvl = 0;
64         mmd->renderlvl = 0;
65         mmd->totlvl = 0;
66         mmd->uv_smooth = SUBSURF_UV_SMOOTH_PRESERVE_CORNERS;
67         mmd->quality = 3;
68 }
69
70 /* Subdivide into fully qualified mesh. */
71
72 static Mesh *multires_as_mesh(MultiresModifierData *mmd,
73                               const ModifierEvalContext *ctx,
74                               Mesh *mesh,
75                               Subdiv *subdiv)
76 {
77         Mesh *result = mesh;
78         const bool use_render_params = (ctx->flag & MOD_APPLY_RENDER);
79         const bool ignore_simplify = (ctx->flag & MOD_APPLY_IGNORE_SIMPLIFY);
80         const Scene *scene = DEG_get_evaluated_scene(ctx->depsgraph);
81         Object *object = ctx->object;
82         SubdivToMeshSettings mesh_settings;
83         BKE_multires_subdiv_mesh_settings_init(
84         &mesh_settings, scene, object, mmd, use_render_params, ignore_simplify);
85         if (mesh_settings.resolution < 3) {
86                 return result;
87         }
88         BKE_subdiv_displacement_attach_from_multires(subdiv, mesh, mmd);
89         result = BKE_subdiv_to_mesh(subdiv, &mesh_settings, mesh);
90         return result;
91 }
92
93 /* Subdivide into CCG. */
94
95 static void multires_ccg_settings_init(SubdivToCCGSettings *settings,
96                                        const MultiresModifierData *mmd,
97                                        const ModifierEvalContext *ctx,
98                                        Mesh *mesh)
99 {
100         const bool has_mask =
101                 CustomData_has_layer(&mesh->ldata, CD_GRID_PAINT_MASK);
102         const bool use_render_params = (ctx->flag & MOD_APPLY_RENDER);
103         const bool ignore_simplify = (ctx->flag & MOD_APPLY_IGNORE_SIMPLIFY);
104         const Scene *scene = DEG_get_evaluated_scene(ctx->depsgraph);
105         Object *object = ctx->object;
106         const int level = multires_get_level(
107                 scene, object, mmd, use_render_params, ignore_simplify);
108         settings->resolution = (1 << level) + 1;
109         settings->need_normal = true;
110         settings->need_mask = has_mask;
111 }
112
113 static Mesh *multires_as_ccg(MultiresModifierData *mmd,
114                              const ModifierEvalContext *ctx,
115                              Mesh *mesh,
116                              Subdiv *subdiv)
117 {
118         Mesh *result = mesh;
119         SubdivToCCGSettings ccg_settings;
120         multires_ccg_settings_init(&ccg_settings, mmd, ctx, mesh);
121         if (ccg_settings.resolution < 3) {
122                 return result;
123         }
124         BKE_subdiv_displacement_attach_from_multires(subdiv, mesh, mmd);
125         result = BKE_subdiv_to_ccg_mesh(subdiv, &ccg_settings, mesh);
126         return result;
127 }
128
129 static Mesh *applyModifier(ModifierData *md,
130                            const ModifierEvalContext *ctx,
131                            Mesh *mesh)
132 {
133         Mesh *result = mesh;
134         MultiresModifierData *mmd = (MultiresModifierData *)md;
135         SubdivSettings subdiv_settings;
136         BKE_multires_subdiv_settings_init(&subdiv_settings, mmd);
137         if (subdiv_settings.level == 0) {
138                 return result;
139         }
140         /* TODO(sergey): Try to re-use subdiv when possible. */
141         Subdiv *subdiv = BKE_subdiv_new_from_mesh(&subdiv_settings, mesh);
142         if (subdiv == NULL) {
143                 /* Happens on bad topology, ut also on empty input mesh. */
144                 return result;
145         }
146         /* NOTE: Orco needs final coordinates on CPU side, which are expected to be
147          * accessible via MVert. For this reason we do not evaluate multires to
148          * grids when orco is requested.
149          */
150         const bool for_orco = (ctx->flag & MOD_APPLY_ORCO) != 0;
151         if ((ctx->object->mode & OB_MODE_SCULPT) && !for_orco) {
152                 /* NOTE: CCG takes ownership over Subdiv. */
153                 result = multires_as_ccg(mmd, ctx, mesh, subdiv);
154                 result->runtime.subdiv_ccg_tot_level = mmd->totlvl;
155                 // BKE_subdiv_stats_print(&subdiv->stats);
156         }
157         else {
158                 result = multires_as_mesh(mmd, ctx, mesh, subdiv);
159                 /* TODO(sergey): Cache subdiv somehow. */
160                 // BKE_subdiv_stats_print(&subdiv->stats);
161                 BKE_subdiv_free(subdiv);
162         }
163         return result;
164 }
165
166 ModifierTypeInfo modifierType_Multires = {
167         /* name */              "Multires",
168         /* structName */        "MultiresModifierData",
169         /* structSize */        sizeof(MultiresModifierData),
170         /* type */              eModifierTypeType_Constructive,
171         /* flags */             eModifierTypeFlag_AcceptsMesh |
172                                 eModifierTypeFlag_SupportsMapping |
173                                 eModifierTypeFlag_RequiresOriginalData,
174
175         /* copyData */          modifier_copyData_generic,
176
177         /* deformVerts_DM */    NULL,
178         /* deformMatrices_DM */ NULL,
179         /* deformVertsEM_DM */  NULL,
180         /* deformMatricesEM_DM*/NULL,
181         /* applyModifier_DM */  NULL,
182
183         /* deformVerts */       NULL,
184         /* deformMatrices */    NULL,
185         /* deformVertsEM */     NULL,
186         /* deformMatricesEM */  NULL,
187         /* applyModifier */     applyModifier,
188
189         /* initData */          initData,
190         /* requiredDataMask */  NULL,
191         /* freeData */          NULL,
192         /* isDisabled */        NULL,
193         /* updateDepsgraph */   NULL,
194         /* dependsOnTime */     NULL,
195         /* dependsOnNormals */  NULL,
196         /* foreachObjectLink */ NULL,
197         /* foreachIDLink */     NULL,
198         /* foreachTexLink */    NULL,
199 };