Enable OpenSubdiv modifier by default
[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 static int subdiv_levels_for_modifier_get(const SubsurfModifierData *smd,
103                                           const ModifierEvalContext *ctx)
104 {
105         Scene *scene = DEG_get_evaluated_scene(ctx->depsgraph);
106         const bool use_render_params = (ctx->flag & MOD_APPLY_RENDER);
107         const int requested_levels = (use_render_params) ? smd->renderLevels
108                                                          : smd->levels;
109         return get_render_subsurf_level(&scene->r,
110                                         requested_levels,
111                                         use_render_params);
112 }
113
114 static void subdiv_settings_init(SubdivSettings *settings,
115                                  const SubsurfModifierData *smd)
116 {
117         settings->is_simple = (smd->subdivType == SUBSURF_TYPE_SIMPLE);
118         settings->is_adaptive = !settings->is_simple;
119         settings->level = smd->quality;
120         settings->vtx_boundary_interpolation = SUBDIV_VTX_BOUNDARY_EDGE_ONLY;
121         settings->fvar_linear_interpolation =
122                 BKE_subdiv_fvar_interpolation_from_uv_smooth(smd->uv_smooth);
123 }
124
125 /* Subdivide into fully qualified mesh. */
126
127 static void subdiv_mesh_settings_init(SubdivToMeshSettings *settings,
128                                       const SubsurfModifierData *smd,
129                                       const ModifierEvalContext *ctx)
130 {
131         const int level = subdiv_levels_for_modifier_get(smd, ctx);
132         settings->resolution = (1 << level) + 1;
133 }
134
135 static Mesh *subdiv_as_mesh(SubsurfModifierData *smd,
136                             const ModifierEvalContext *ctx,
137                             Mesh *mesh,
138                             Subdiv *subdiv)
139 {
140         Mesh *result = mesh;
141         SubdivToMeshSettings mesh_settings;
142         subdiv_mesh_settings_init(&mesh_settings, smd, ctx);
143         if (mesh_settings.resolution < 3) {
144                 return result;
145         }
146         result = BKE_subdiv_to_mesh(subdiv, &mesh_settings, mesh);
147         return result;
148 }
149
150 /* Subdivide into CCG. */
151
152 static void subdiv_ccg_settings_init(SubdivToCCGSettings *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->need_normal = true;
159         settings->need_mask = false;
160 }
161
162 static Mesh *subdiv_as_ccg(SubsurfModifierData *smd,
163                             const ModifierEvalContext *ctx,
164                             Mesh *mesh,
165                             Subdiv *subdiv)
166 {
167         Mesh *result = mesh;
168         SubdivToCCGSettings ccg_settings;
169         subdiv_ccg_settings_init(&ccg_settings, smd, ctx);
170         if (ccg_settings.resolution < 3) {
171                 return result;
172         }
173         result = BKE_subdiv_to_ccg_mesh(subdiv, &ccg_settings, mesh);
174         return result;
175 }
176
177 /* Modifier itself. */
178
179 static Mesh *applyModifier(ModifierData *md,
180                            const ModifierEvalContext *ctx,
181                            Mesh *mesh)
182 {
183         Mesh *result = mesh;
184         SubsurfModifierData *smd = (SubsurfModifierData *) md;
185         SubdivSettings subdiv_settings;
186         subdiv_settings_init(&subdiv_settings, smd);
187         if (subdiv_settings.level == 0) {
188                 return result;
189         }
190         /* TODO(sergey): Try to re-use subdiv when possible. */
191         Subdiv *subdiv = BKE_subdiv_new_from_mesh(&subdiv_settings, mesh);
192         if (subdiv == NULL) {
193                 /* Happens on bad topology, ut also on empty input mesh. */
194                 return result;
195         }
196         /* TODO(sergey): Decide whether we ever want to use CCG for subsurf,
197          * maybe when it is a last modifier in the stack?
198          */
199         if (true) {
200                 result = subdiv_as_mesh(smd, ctx, mesh, subdiv);
201         }
202         else {
203                 result = subdiv_as_ccg(smd, ctx, mesh, subdiv);
204         }
205         /* TODO(sergey): Cache subdiv somehow. */
206         // BKE_subdiv_stats_print(&subdiv->stats);
207         BKE_subdiv_free(subdiv);
208         return result;
209 }
210
211 ModifierTypeInfo modifierType_Subsurf = {
212         /* name */              "Subdivision",
213         /* structName */        "SubsurfModifierData",
214         /* structSize */        sizeof(SubsurfModifierData),
215         /* type */              eModifierTypeType_Constructive,
216         /* flags */             eModifierTypeFlag_AcceptsMesh |
217                                 eModifierTypeFlag_SupportsMapping |
218                                 eModifierTypeFlag_SupportsEditmode |
219                                 eModifierTypeFlag_EnableInEditmode |
220                                 eModifierTypeFlag_AcceptsCVs,
221
222         /* copyData */          copyData,
223
224         /* deformVerts_DM */    NULL,
225         /* deformMatrices_DM */ NULL,
226         /* deformVertsEM_DM */  NULL,
227         /* deformMatricesEM_DM*/NULL,
228         /* applyModifier_DM */  NULL,
229
230         /* deformVerts */       NULL,
231         /* deformMatrices */    NULL,
232         /* deformVertsEM */     NULL,
233         /* deformMatricesEM */  NULL,
234         /* applyModifier */     applyModifier,
235
236         /* initData */          initData,
237         /* requiredDataMask */  NULL,
238         /* freeData */          freeData,
239         /* isDisabled */        isDisabled,
240         /* updateDepsgraph */   NULL,
241         /* dependsOnTime */     NULL,
242         /* dependsOnNormals */  NULL,
243         /* foreachObjectLink */ NULL,
244         /* foreachIDLink */     NULL,
245         /* foreachTexLink */    NULL,
246 };