Fix T63283: Second subdivision modifier does not ignore crease
[blender.git] / source / blender / modifiers / intern / MOD_subsurf.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 "MEM_guardedalloc.h"
28
29 #include "BLI_utildefines.h"
30
31 #include "DNA_object_types.h"
32 #include "DNA_scene_types.h"
33 #include "DNA_mesh_types.h"
34
35 #include "BKE_cdderivedmesh.h"
36 #include "BKE_scene.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.h"
43 #include "DEG_depsgraph_query.h"
44
45 #include "MOD_modifiertypes.h"
46
47 #include "intern/CCGSubSurf.h"
48
49 typedef struct SubsurfRuntimeData {
50         /* Cached subdivision surface descriptor, with topology and settings. */
51         struct Subdiv *subdiv;
52 } SubsurfRuntimeData;
53
54 static void initData(ModifierData *md)
55 {
56         SubsurfModifierData *smd = (SubsurfModifierData *) md;
57
58         smd->levels = 1;
59         smd->renderLevels = 2;
60         smd->uv_smooth = SUBSURF_UV_SMOOTH_PRESERVE_CORNERS;
61         smd->quality = 3;
62         smd->flags |= eSubsurfModifierFlag_UseCrease;
63 }
64
65 static void copyData(const ModifierData *md, ModifierData *target, const int flag)
66 {
67 #if 0
68         const SubsurfModifierData *smd = (const SubsurfModifierData *) md;
69 #endif
70         SubsurfModifierData *tsmd = (SubsurfModifierData *) target;
71
72         modifier_copyData_generic(md, target, flag);
73
74         tsmd->emCache = tsmd->mCache = NULL;
75 }
76
77 static void freeRuntimeData(void *runtime_data_v)
78 {
79         if (runtime_data_v == NULL) {
80                 return;
81         }
82         SubsurfRuntimeData *runtime_data = (SubsurfRuntimeData *)runtime_data_v;
83         if (runtime_data->subdiv != NULL) {
84                 BKE_subdiv_free(runtime_data->subdiv);
85         }
86         MEM_freeN(runtime_data);
87 }
88
89 static void freeData(ModifierData *md)
90 {
91         SubsurfModifierData *smd = (SubsurfModifierData *) md;
92
93         if (smd->mCache) {
94                 ccgSubSurf_free(smd->mCache);
95                 smd->mCache = NULL;
96         }
97         if (smd->emCache) {
98                 ccgSubSurf_free(smd->emCache);
99                 smd->emCache = NULL;
100         }
101         freeRuntimeData(smd->modifier.runtime);
102 }
103
104 static bool isDisabled(const Scene *scene, ModifierData *md, bool useRenderParams)
105 {
106         SubsurfModifierData *smd = (SubsurfModifierData *) md;
107         int levels = (useRenderParams) ? smd->renderLevels : smd->levels;
108
109         return get_render_subsurf_level(&scene->r, levels, useRenderParams != 0) == 0;
110 }
111
112 static int subdiv_levels_for_modifier_get(const SubsurfModifierData *smd,
113                                           const ModifierEvalContext *ctx)
114 {
115         Scene *scene = DEG_get_evaluated_scene(ctx->depsgraph);
116         const bool use_render_params = (ctx->flag & MOD_APPLY_RENDER);
117         const int requested_levels = (use_render_params) ? smd->renderLevels
118                                                          : smd->levels;
119         return get_render_subsurf_level(&scene->r,
120                                         requested_levels,
121                                         use_render_params);
122 }
123
124 static void subdiv_settings_init(SubdivSettings *settings,
125                                  const SubsurfModifierData *smd)
126 {
127         settings->is_simple = (smd->subdivType == SUBSURF_TYPE_SIMPLE);
128         settings->is_adaptive = true;
129         settings->level = settings->is_simple ? 1 : smd->quality;
130         settings->use_creases = (smd->flags & eSubsurfModifierFlag_UseCrease);
131         settings->vtx_boundary_interpolation = SUBDIV_VTX_BOUNDARY_EDGE_ONLY;
132         settings->fvar_linear_interpolation =
133                 BKE_subdiv_fvar_interpolation_from_uv_smooth(smd->uv_smooth);
134 }
135
136 /* Main goal of this function is to give usable subdivision surface descriptor
137  * which matches settings and topology. */
138 static Subdiv *subdiv_descriptor_ensure(SubsurfModifierData *smd,
139                                         const SubdivSettings *subdiv_settings,
140                                         const Mesh *mesh)
141 {
142         SubsurfRuntimeData *runtime_data =
143                 (SubsurfRuntimeData *)smd->modifier.runtime;
144         Subdiv *subdiv = BKE_subdiv_update_from_mesh(
145                 runtime_data->subdiv, subdiv_settings, mesh);
146         runtime_data->subdiv = subdiv;
147         return subdiv;
148 }
149
150 /* Subdivide into fully qualified mesh. */
151
152 static void subdiv_mesh_settings_init(SubdivToMeshSettings *settings,
153                                       const SubsurfModifierData *smd,
154                                       const ModifierEvalContext *ctx)
155 {
156         const int level = subdiv_levels_for_modifier_get(smd, ctx);
157         settings->resolution = (1 << level) + 1;
158         settings->use_optimal_display =
159                 (smd->flags & eSubsurfModifierFlag_ControlEdges);
160 }
161
162 static Mesh *subdiv_as_mesh(SubsurfModifierData *smd,
163                             const ModifierEvalContext *ctx,
164                             Mesh *mesh,
165                             Subdiv *subdiv)
166 {
167         Mesh *result = mesh;
168         SubdivToMeshSettings mesh_settings;
169         subdiv_mesh_settings_init(&mesh_settings, smd, ctx);
170         if (mesh_settings.resolution < 3) {
171                 return result;
172         }
173         result = BKE_subdiv_to_mesh(subdiv, &mesh_settings, mesh);
174         return result;
175 }
176
177 /* Subdivide into CCG. */
178
179 static void subdiv_ccg_settings_init(SubdivToCCGSettings *settings,
180                                      const SubsurfModifierData *smd,
181                                      const ModifierEvalContext *ctx)
182 {
183         const int level = subdiv_levels_for_modifier_get(smd, ctx);
184         settings->resolution = (1 << level) + 1;
185         settings->need_normal = true;
186         settings->need_mask = false;
187 }
188
189 static Mesh *subdiv_as_ccg(SubsurfModifierData *smd,
190                             const ModifierEvalContext *ctx,
191                             Mesh *mesh,
192                             Subdiv *subdiv)
193 {
194         Mesh *result = mesh;
195         SubdivToCCGSettings ccg_settings;
196         subdiv_ccg_settings_init(&ccg_settings, smd, ctx);
197         if (ccg_settings.resolution < 3) {
198                 return result;
199         }
200         result = BKE_subdiv_to_ccg_mesh(subdiv, &ccg_settings, mesh);
201         return result;
202 }
203
204 static SubsurfRuntimeData *subsurf_ensure_runtime(SubsurfModifierData *smd)
205 {
206         SubsurfRuntimeData *runtime_data =
207                 (SubsurfRuntimeData *)smd->modifier.runtime;
208         if (runtime_data == NULL) {
209                 runtime_data = MEM_callocN(sizeof(*runtime_data), "subsurf runtime");
210                 smd->modifier.runtime = runtime_data;
211         }
212         return runtime_data;
213 }
214
215 /* Modifier itself. */
216
217 static Mesh *applyModifier(ModifierData *md,
218                            const ModifierEvalContext *ctx,
219                            Mesh *mesh)
220 {
221         Mesh *result = mesh;
222         SubsurfModifierData *smd = (SubsurfModifierData *) md;
223         SubdivSettings subdiv_settings;
224         subdiv_settings_init(&subdiv_settings, smd);
225         if (subdiv_settings.level == 0) {
226                 return result;
227         }
228         BKE_subdiv_settings_validate_for_mesh(&subdiv_settings, mesh);
229         SubsurfRuntimeData *runtime_data = subsurf_ensure_runtime(smd);
230         Subdiv *subdiv = subdiv_descriptor_ensure(smd, &subdiv_settings, mesh);
231         if (subdiv == NULL) {
232                 /* Happens on bad topology, but also on empty input mesh. */
233                 return result;
234         }
235         /* TODO(sergey): Decide whether we ever want to use CCG for subsurf,
236          * maybe when it is a last modifier in the stack? */
237         if (true) {
238                 result = subdiv_as_mesh(smd, ctx, mesh, subdiv);
239         }
240         else {
241                 result = subdiv_as_ccg(smd, ctx, mesh, subdiv);
242         }
243         // BKE_subdiv_stats_print(&subdiv->stats);
244         if (subdiv != runtime_data->subdiv) {
245                 BKE_subdiv_free(subdiv);
246         }
247         return result;
248 }
249
250 ModifierTypeInfo modifierType_Subsurf = {
251         /* name */              "Subdivision",
252         /* structName */        "SubsurfModifierData",
253         /* structSize */        sizeof(SubsurfModifierData),
254         /* type */              eModifierTypeType_Constructive,
255         /* flags */             eModifierTypeFlag_AcceptsMesh |
256                                 eModifierTypeFlag_SupportsMapping |
257                                 eModifierTypeFlag_SupportsEditmode |
258                                 eModifierTypeFlag_EnableInEditmode |
259                                 eModifierTypeFlag_AcceptsCVs,
260
261         /* copyData */          copyData,
262
263         /* deformVerts */       NULL,
264         /* deformMatrices */    NULL,
265         /* deformVertsEM */     NULL,
266         /* deformMatricesEM */  NULL,
267         /* applyModifier */     applyModifier,
268
269         /* initData */          initData,
270         /* requiredDataMask */  NULL,
271         /* freeData */          freeData,
272         /* isDisabled */        isDisabled,
273         /* updateDepsgraph */   NULL,
274         /* dependsOnTime */     NULL,
275         /* dependsOnNormals */  NULL,
276         /* foreachObjectLink */ NULL,
277         /* foreachIDLink */     NULL,
278         /* foreachTexLink */    NULL,
279         /* freeRuntimeData */   freeRuntimeData,
280 };