4aee0ba589e4241683f2e8fecef8eecc53229d6c
[blender.git] / source / blender / modifiers / intern / MOD_subsurf.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_subsurf.c
32  *  \ingroup modifiers
33  */
34
35
36 #include <stddef.h>
37
38 #include "DNA_object_types.h"
39 #include "DNA_scene_types.h"
40 #include "DNA_mesh_types.h"
41
42 #include "BLI_utildefines.h"
43
44 #include "BKE_cdderivedmesh.h"
45 #include "BKE_scene.h"
46 #include "BKE_subdiv.h"
47 #include "BKE_subdiv_ccg.h"
48 #include "BKE_subdiv_mesh.h"
49 #include "BKE_subsurf.h"
50
51 #include "DEG_depsgraph.h"
52 #include "DEG_depsgraph_query.h"
53
54 #include "MOD_modifiertypes.h"
55
56 #include "intern/CCGSubSurf.h"
57
58 static void initData(ModifierData *md)
59 {
60         SubsurfModifierData *smd = (SubsurfModifierData *) md;
61
62         smd->levels = 1;
63         smd->renderLevels = 2;
64         smd->uv_smooth = SUBSURF_UV_SMOOTH_PRESERVE_CORNERS;
65         smd->quality = 3;
66 }
67
68 static void copyData(const ModifierData *md, ModifierData *target, const int flag)
69 {
70 #if 0
71         const SubsurfModifierData *smd = (const SubsurfModifierData *) md;
72 #endif
73         SubsurfModifierData *tsmd = (SubsurfModifierData *) target;
74
75         modifier_copyData_generic(md, target, flag);
76
77         tsmd->emCache = tsmd->mCache = NULL;
78 }
79
80 static void freeData(ModifierData *md)
81 {
82         SubsurfModifierData *smd = (SubsurfModifierData *) md;
83
84         if (smd->mCache) {
85                 ccgSubSurf_free(smd->mCache);
86                 smd->mCache = NULL;
87         }
88         if (smd->emCache) {
89                 ccgSubSurf_free(smd->emCache);
90                 smd->emCache = NULL;
91         }
92 }
93
94 static bool isDisabled(const Scene *scene, ModifierData *md, bool useRenderParams)
95 {
96         SubsurfModifierData *smd = (SubsurfModifierData *) md;
97         int levels = (useRenderParams) ? smd->renderLevels : smd->levels;
98
99         return get_render_subsurf_level(&scene->r, levels, useRenderParams != 0) == 0;
100 }
101
102 #ifndef WITH_OPENSUBDIV_MODIFIER
103
104 static DerivedMesh *applyModifier_DM(
105         ModifierData *md, const ModifierEvalContext *ctx,
106         DerivedMesh *derivedData)
107 {
108         SubsurfModifierData *smd = (SubsurfModifierData *) md;
109         struct Scene *scene = DEG_get_evaluated_scene(ctx->depsgraph);
110         SubsurfFlags subsurf_flags = 0;
111         DerivedMesh *result;
112         const bool useRenderParams = (ctx->flag & MOD_APPLY_RENDER) != 0;
113         const bool isFinalCalc = (ctx->flag & MOD_APPLY_USECACHE) != 0;
114
115         bool do_cddm_convert = useRenderParams || !isFinalCalc;
116
117         if (useRenderParams)
118                 subsurf_flags |= SUBSURF_USE_RENDER_PARAMS;
119         if (isFinalCalc)
120                 subsurf_flags |= SUBSURF_IS_FINAL_CALC;
121         if (ctx->object->mode & OB_MODE_EDIT)
122                 subsurf_flags |= SUBSURF_IN_EDIT_MODE;
123
124         result = subsurf_make_derived_from_derived(derivedData, smd, scene, NULL, subsurf_flags);
125         result->cd_flag = derivedData->cd_flag;
126
127         {
128                 DerivedMesh *cddm = CDDM_copy(result);
129                 result->release(result);
130                 result = cddm;
131         }
132
133         (void) do_cddm_convert;
134
135         return result;
136 }
137
138 applyModifier_DM_wrapper(applyModifier, applyModifier_DM)
139
140 #endif
141
142 #ifdef WITH_OPENSUBDIV_MODIFIER
143 static int subdiv_levels_for_modifier_get(const SubsurfModifierData *smd,
144                                           const ModifierEvalContext *ctx)
145 {
146         Scene *scene = DEG_get_evaluated_scene(ctx->depsgraph);
147         const bool use_render_params = (ctx->flag & MOD_APPLY_RENDER);
148         const int requested_levels = (use_render_params) ? smd->renderLevels
149                                                          : smd->levels;
150         return get_render_subsurf_level(&scene->r,
151                                         requested_levels,
152                                         use_render_params);
153 }
154
155 static void subdiv_settings_init(SubdivSettings *settings,
156                                  const SubsurfModifierData *smd)
157 {
158         settings->is_simple = (smd->subdivType == SUBSURF_TYPE_SIMPLE);
159         settings->is_adaptive = !settings->is_simple;
160         settings->level = smd->quality;
161         settings->fvar_linear_interpolation =
162                 BKE_subdiv_fvar_interpolation_from_uv_smooth(smd->uv_smooth);
163 }
164
165 /* Subdivide into fully qualified mesh. */
166
167 static void subdiv_mesh_settings_init(SubdivToMeshSettings *settings,
168                                       const SubsurfModifierData *smd,
169                                       const ModifierEvalContext *ctx)
170 {
171         const int level = subdiv_levels_for_modifier_get(smd, ctx);
172         settings->resolution = (1 << level) + 1;
173 }
174
175 static Mesh *subdiv_as_mesh(SubsurfModifierData *smd,
176                             const ModifierEvalContext *ctx,
177                             Mesh *mesh,
178                             Subdiv *subdiv)
179 {
180         Mesh *result = mesh;
181         SubdivToMeshSettings mesh_settings;
182         subdiv_mesh_settings_init(&mesh_settings, smd, ctx);
183         if (mesh_settings.resolution < 3) {
184                 return result;
185         }
186         result = BKE_subdiv_to_mesh(subdiv, &mesh_settings, mesh);
187         return result;
188 }
189
190 /* Subdivide into CCG. */
191
192 static void subdiv_ccg_settings_init(SubdivToCCGSettings *settings,
193                                      const SubsurfModifierData *smd,
194                                      const ModifierEvalContext *ctx)
195 {
196         const int level = subdiv_levels_for_modifier_get(smd, ctx);
197         settings->resolution = (1 << level) + 1;
198         settings->need_normal = true;
199         settings->need_mask = false;
200 }
201
202 static Mesh *subdiv_as_ccg(SubsurfModifierData *smd,
203                             const ModifierEvalContext *ctx,
204                             Mesh *mesh,
205                             Subdiv *subdiv)
206 {
207         Mesh *result = mesh;
208         SubdivToCCGSettings ccg_settings;
209         subdiv_ccg_settings_init(&ccg_settings, smd, ctx);
210         if (ccg_settings.resolution < 3) {
211                 return result;
212         }
213         result = BKE_subdiv_to_ccg_mesh(subdiv, &ccg_settings, mesh);
214         return result;
215 }
216
217 /* Modifier itself. */
218
219 static Mesh *applyModifier_subdiv(ModifierData *md,
220                                   const ModifierEvalContext *ctx,
221                                   Mesh *mesh)
222 {
223         Mesh *result = mesh;
224         SubsurfModifierData *smd = (SubsurfModifierData *) md;
225         SubdivSettings subdiv_settings;
226         subdiv_settings_init(&subdiv_settings, smd);
227         if (subdiv_settings.level == 0) {
228                 return result;
229         }
230         /* TODO(sergey): Try to re-use subdiv when possible. */
231         Subdiv *subdiv = BKE_subdiv_new_from_mesh(&subdiv_settings, mesh);
232         if (subdiv == NULL) {
233                 /* Happens on bad topology, ut also on empty input mesh. */
234                 return result;
235         }
236         /* TODO(sergey): Decide whether we ever want to use CCG for subsurf,
237          * maybe when it is a last modifier in the stack?
238          */
239         if (true) {
240                 result = subdiv_as_mesh(smd, ctx, mesh, subdiv);
241         }
242         else {
243                 result = subdiv_as_ccg(smd, ctx, mesh, subdiv);
244         }
245         /* TODO(sergey): Cache subdiv somehow. */
246         // BKE_subdiv_stats_print(&subdiv->stats);
247         BKE_subdiv_free(subdiv);
248         return result;
249 }
250 #endif
251
252 ModifierTypeInfo modifierType_Subsurf = {
253         /* name */              "Subdivision",
254         /* structName */        "SubsurfModifierData",
255         /* structSize */        sizeof(SubsurfModifierData),
256         /* type */              eModifierTypeType_Constructive,
257         /* flags */             eModifierTypeFlag_AcceptsMesh |
258                                 eModifierTypeFlag_SupportsMapping |
259                                 eModifierTypeFlag_SupportsEditmode |
260                                 eModifierTypeFlag_EnableInEditmode |
261                                 eModifierTypeFlag_AcceptsCVs,
262
263         /* copyData */          copyData,
264
265         /* deformVerts_DM */    NULL,
266         /* deformMatrices_DM */ NULL,
267         /* deformVertsEM_DM */  NULL,
268         /* deformMatricesEM_DM*/NULL,
269         /* applyModifier_DM */  NULL,
270
271         /* deformVerts */       NULL,
272         /* deformMatrices */    NULL,
273         /* deformVertsEM */     NULL,
274         /* deformMatricesEM */  NULL,
275 #ifdef WITH_OPENSUBDIV_MODIFIER
276         /* applyModifier */     applyModifier_subdiv,
277 #else
278         /* applyModifier */     applyModifier,
279 #endif
280
281         /* initData */          initData,
282         /* requiredDataMask */  NULL,
283         /* freeData */          freeData,
284         /* isDisabled */        isDisabled,
285         /* updateDepsgraph */   NULL,
286         /* dependsOnTime */     NULL,
287         /* dependsOnNormals */  NULL,
288         /* foreachObjectLink */ NULL,
289         /* foreachIDLink */     NULL,
290         /* foreachTexLink */    NULL,
291 };