GPencil: Fix unreported problem when use Onion Skin in several windows
[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 #include <stddef.h>
25
26 #include "MEM_guardedalloc.h"
27
28 #include "BLI_utildefines.h"
29
30 #include "DNA_object_types.h"
31 #include "DNA_scene_types.h"
32 #include "DNA_mesh_types.h"
33
34 #include "BKE_cdderivedmesh.h"
35 #include "BKE_scene.h"
36 #include "BKE_subdiv.h"
37 #include "BKE_subdiv_ccg.h"
38 #include "BKE_subdiv_deform.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 : smd->levels;
118   return get_render_subsurf_level(&scene->r, requested_levels, use_render_params);
119 }
120
121 static void subdiv_settings_init(SubdivSettings *settings, const SubsurfModifierData *smd)
122 {
123   settings->is_simple = (smd->subdivType == SUBSURF_TYPE_SIMPLE);
124   settings->is_adaptive = true;
125   settings->level = settings->is_simple ? 1 : smd->quality;
126   settings->use_creases = (smd->flags & eSubsurfModifierFlag_UseCrease);
127   settings->vtx_boundary_interpolation = SUBDIV_VTX_BOUNDARY_EDGE_ONLY;
128   settings->fvar_linear_interpolation = BKE_subdiv_fvar_interpolation_from_uv_smooth(
129       smd->uv_smooth);
130 }
131
132 /* Main goal of this function is to give usable subdivision surface descriptor
133  * which matches settings and topology. */
134 static Subdiv *subdiv_descriptor_ensure(SubsurfModifierData *smd,
135                                         const SubdivSettings *subdiv_settings,
136                                         const Mesh *mesh)
137 {
138   SubsurfRuntimeData *runtime_data = (SubsurfRuntimeData *)smd->modifier.runtime;
139   Subdiv *subdiv = BKE_subdiv_update_from_mesh(runtime_data->subdiv, subdiv_settings, mesh);
140   runtime_data->subdiv = subdiv;
141   return subdiv;
142 }
143
144 /* Subdivide into fully qualified mesh. */
145
146 static void subdiv_mesh_settings_init(SubdivToMeshSettings *settings,
147                                       const SubsurfModifierData *smd,
148                                       const ModifierEvalContext *ctx)
149 {
150   const int level = subdiv_levels_for_modifier_get(smd, ctx);
151   settings->resolution = (1 << level) + 1;
152   settings->use_optimal_display = (smd->flags & eSubsurfModifierFlag_ControlEdges);
153 }
154
155 static Mesh *subdiv_as_mesh(SubsurfModifierData *smd,
156                             const ModifierEvalContext *ctx,
157                             Mesh *mesh,
158                             Subdiv *subdiv)
159 {
160   Mesh *result = mesh;
161   SubdivToMeshSettings mesh_settings;
162   subdiv_mesh_settings_init(&mesh_settings, smd, ctx);
163   if (mesh_settings.resolution < 3) {
164     return result;
165   }
166   result = BKE_subdiv_to_mesh(subdiv, &mesh_settings, mesh);
167   return result;
168 }
169
170 /* Subdivide into CCG. */
171
172 static void subdiv_ccg_settings_init(SubdivToCCGSettings *settings,
173                                      const SubsurfModifierData *smd,
174                                      const ModifierEvalContext *ctx)
175 {
176   const int level = subdiv_levels_for_modifier_get(smd, ctx);
177   settings->resolution = (1 << level) + 1;
178   settings->need_normal = true;
179   settings->need_mask = false;
180 }
181
182 static Mesh *subdiv_as_ccg(SubsurfModifierData *smd,
183                            const ModifierEvalContext *ctx,
184                            Mesh *mesh,
185                            Subdiv *subdiv)
186 {
187   Mesh *result = mesh;
188   SubdivToCCGSettings ccg_settings;
189   subdiv_ccg_settings_init(&ccg_settings, smd, ctx);
190   if (ccg_settings.resolution < 3) {
191     return result;
192   }
193   result = BKE_subdiv_to_ccg_mesh(subdiv, &ccg_settings, mesh);
194   return result;
195 }
196
197 static SubsurfRuntimeData *subsurf_ensure_runtime(SubsurfModifierData *smd)
198 {
199   SubsurfRuntimeData *runtime_data = (SubsurfRuntimeData *)smd->modifier.runtime;
200   if (runtime_data == NULL) {
201     runtime_data = MEM_callocN(sizeof(*runtime_data), "subsurf runtime");
202     smd->modifier.runtime = runtime_data;
203   }
204   return runtime_data;
205 }
206
207 /* Modifier itself. */
208
209 static Mesh *applyModifier(ModifierData *md, const ModifierEvalContext *ctx, Mesh *mesh)
210 {
211   Mesh *result = mesh;
212 #if !defined(WITH_OPENSUBDIV)
213   modifier_setError(md, "Disabled, built without OpenSubdiv");
214   return result;
215 #endif
216   SubsurfModifierData *smd = (SubsurfModifierData *)md;
217   SubdivSettings subdiv_settings;
218   subdiv_settings_init(&subdiv_settings, smd);
219   if (subdiv_settings.level == 0) {
220     return result;
221   }
222   BKE_subdiv_settings_validate_for_mesh(&subdiv_settings, mesh);
223   SubsurfRuntimeData *runtime_data = subsurf_ensure_runtime(smd);
224   Subdiv *subdiv = subdiv_descriptor_ensure(smd, &subdiv_settings, mesh);
225   if (subdiv == NULL) {
226     /* Happens on bad topology, but also on empty input mesh. */
227     return result;
228   }
229   /* TODO(sergey): Decide whether we ever want to use CCG for subsurf,
230    * maybe when it is a last modifier in the stack? */
231   if (true) {
232     result = subdiv_as_mesh(smd, ctx, mesh, subdiv);
233   }
234   else {
235     result = subdiv_as_ccg(smd, ctx, mesh, subdiv);
236   }
237   // BKE_subdiv_stats_print(&subdiv->stats);
238   if (subdiv != runtime_data->subdiv) {
239     BKE_subdiv_free(subdiv);
240   }
241   return result;
242 }
243
244 static void deformMatrices(ModifierData *md,
245                            const ModifierEvalContext *UNUSED(ctx),
246                            Mesh *mesh,
247                            float (*vertex_cos)[3],
248                            float (*deform_matrices)[3][3],
249                            int num_verts)
250 {
251 #if !defined(WITH_OPENSUBDIV)
252   modifier_setError(md, "Disabled, built without OpenSubdiv");
253   return;
254 #endif
255
256   /* Subsurf does not require extra space mapping, keep matrices as is. */
257   (void)deform_matrices;
258
259   SubsurfModifierData *smd = (SubsurfModifierData *)md;
260   SubdivSettings subdiv_settings;
261   subdiv_settings_init(&subdiv_settings, smd);
262   if (subdiv_settings.level == 0) {
263     return;
264   }
265   BKE_subdiv_settings_validate_for_mesh(&subdiv_settings, mesh);
266   SubsurfRuntimeData *runtime_data = subsurf_ensure_runtime(smd);
267   Subdiv *subdiv = subdiv_descriptor_ensure(smd, &subdiv_settings, mesh);
268   if (subdiv == NULL) {
269     /* Happens on bad topology, but also on empty input mesh. */
270     return;
271   }
272   BKE_subdiv_deform_coarse_vertices(subdiv, mesh, vertex_cos, num_verts);
273   if (subdiv != runtime_data->subdiv) {
274     BKE_subdiv_free(subdiv);
275   }
276 }
277
278 ModifierTypeInfo modifierType_Subsurf = {
279     /* name */ "Subdivision",
280     /* structName */ "SubsurfModifierData",
281     /* structSize */ sizeof(SubsurfModifierData),
282     /* type */ eModifierTypeType_Constructive,
283     /* flags */ eModifierTypeFlag_AcceptsMesh | eModifierTypeFlag_SupportsMapping |
284         eModifierTypeFlag_SupportsEditmode | eModifierTypeFlag_EnableInEditmode |
285         eModifierTypeFlag_AcceptsCVs,
286
287     /* copyData */ copyData,
288
289     /* deformVerts */ NULL,
290     /* deformMatrices */ deformMatrices,
291     /* deformVertsEM */ NULL,
292     /* deformMatricesEM */ NULL,
293     /* applyModifier */ applyModifier,
294
295     /* initData */ initData,
296     /* requiredDataMask */ NULL,
297     /* freeData */ freeData,
298     /* isDisabled */ isDisabled,
299     /* updateDepsgraph */ NULL,
300     /* dependsOnTime */ NULL,
301     /* dependsOnNormals */ NULL,
302     /* foreachObjectLink */ NULL,
303     /* foreachIDLink */ NULL,
304     /* foreachTexLink */ NULL,
305     /* freeRuntimeData */ freeRuntimeData,
306 };