Merge branch 'master' into blender2.8
[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_scene_types.h"
39 #include "DNA_object_types.h"
40
41 #ifdef WITH_OPENSUBDIV
42 #  include "DNA_userdef_types.h"
43 #endif
44
45 #include "BLI_utildefines.h"
46
47
48 #include "BKE_cdderivedmesh.h"
49 #include "BKE_scene.h"
50 #include "BKE_subsurf.h"
51
52 #include "DEG_depsgraph.h"
53 #include "DEG_depsgraph_query.h"
54
55 #include "MOD_modifiertypes.h"
56
57 #include "intern/CCGSubSurf.h"
58
59 static void initData(ModifierData *md)
60 {
61         SubsurfModifierData *smd = (SubsurfModifierData *) md;
62
63         smd->levels = 1;
64         smd->renderLevels = 2;
65         smd->flags |= eSubsurfModifierFlag_SubsurfUv;
66 }
67
68 static void copyData(const ModifierData *md, ModifierData *target)
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);
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(ModifierData *md, int useRenderParams)
95 {
96         SubsurfModifierData *smd = (SubsurfModifierData *) md;
97         int levels = (useRenderParams) ? smd->renderLevels : smd->levels;
98
99         return get_render_subsurf_level(&md->scene->r, levels, useRenderParams != 0) == 0;
100 }
101
102 static DerivedMesh *applyModifier(ModifierData *md, const ModifierEvalContext *ctx,
103                                   DerivedMesh *derivedData)
104 {
105         SubsurfModifierData *smd = (SubsurfModifierData *) md;
106         SubsurfFlags subsurf_flags = 0;
107         DerivedMesh *result;
108         const bool useRenderParams = (ctx->flag & MOD_APPLY_RENDER) != 0;
109         const bool isFinalCalc = (ctx->flag & MOD_APPLY_USECACHE) != 0;
110
111 #ifdef WITH_OPENSUBDIV
112         const bool allow_gpu = (ctx->flag & MOD_APPLY_ALLOW_GPU) != 0;
113 #endif
114         bool do_cddm_convert = useRenderParams || !isFinalCalc;
115
116         if (useRenderParams)
117                 subsurf_flags |= SUBSURF_USE_RENDER_PARAMS;
118         if (isFinalCalc)
119                 subsurf_flags |= SUBSURF_IS_FINAL_CALC;
120         if (ctx->object->mode & OB_MODE_EDIT)
121                 subsurf_flags |= SUBSURF_IN_EDIT_MODE;
122
123 #ifdef WITH_OPENSUBDIV
124         /* TODO(sergey): Not entirely correct, modifiers on top of subsurf
125          * could be disabled.
126          */
127         if (md->next == NULL &&
128             allow_gpu &&
129             do_cddm_convert == false &&
130             smd->use_opensubdiv)
131         {
132                 if (U.opensubdiv_compute_type == USER_OPENSUBDIV_COMPUTE_NONE) {
133                         modifier_setError(md, "OpenSubdiv is disabled in User Preferences");
134                 }
135                 else if ((ctx->object->mode & (OB_MODE_VERTEX_PAINT | OB_MODE_WEIGHT_PAINT | OB_MODE_TEXTURE_PAINT)) != 0) {
136                         modifier_setError(md, "OpenSubdiv is not supported in paint modes");
137                 }
138                 else if ((DEG_get_eval_flags_for_id(ctx->depsgraph, &ctx->object->id) & DAG_EVAL_NEED_CPU) == 0) {
139                         subsurf_flags |= SUBSURF_USE_GPU_BACKEND;
140                         do_cddm_convert = false;
141                 }
142                 else {
143                         modifier_setError(md, "OpenSubdiv is disabled due to dependencies");
144                 }
145         }
146 #endif
147
148         result = subsurf_make_derived_from_derived(derivedData, smd, NULL, subsurf_flags);
149         result->cd_flag = derivedData->cd_flag;
150
151         {
152                 DerivedMesh *cddm = CDDM_copy(result);
153                 result->release(result);
154                 result = cddm;
155         }
156
157 #ifndef WITH_OPESUBDIV
158         (void) do_cddm_convert;
159 #endif
160
161         return result;
162 }
163
164 static DerivedMesh *applyModifierEM(
165         ModifierData *md, const ModifierEvalContext *ctx,
166         struct BMEditMesh *UNUSED(editData),
167         DerivedMesh *derivedData)
168 {
169         SubsurfModifierData *smd = (SubsurfModifierData *) md;
170         DerivedMesh *result;
171         /* 'orco' using editmode flags would cause cache to be used twice in editbmesh_calc_modifiers */
172         SubsurfFlags ss_flags = (ctx->flag & MOD_APPLY_ORCO) ? 0 : (SUBSURF_FOR_EDIT_MODE | SUBSURF_IN_EDIT_MODE);
173 #ifdef WITH_OPENSUBDIV
174         const bool allow_gpu = (ctx->flag & MOD_APPLY_ALLOW_GPU) != 0;
175         if (md->next == NULL && allow_gpu && smd->use_opensubdiv) {
176                 modifier_setError(md, "OpenSubdiv is not supported in edit mode");
177         }
178 #endif
179
180         result = subsurf_make_derived_from_derived(derivedData, smd, NULL, ss_flags);
181
182         return result;
183 }
184
185 static bool dependsOnNormals(ModifierData *md)
186 {
187 #ifdef WITH_OPENSUBDIV
188         SubsurfModifierData *smd = (SubsurfModifierData *) md;
189         if (smd->use_opensubdiv && md->next == NULL) {
190                 return true;
191         }
192 #else
193         UNUSED_VARS(md);
194 #endif
195         return false;
196 }
197
198 ModifierTypeInfo modifierType_Subsurf = {
199         /* name */              "Subsurf",
200         /* structName */        "SubsurfModifierData",
201         /* structSize */        sizeof(SubsurfModifierData),
202         /* type */              eModifierTypeType_Constructive,
203         /* flags */             eModifierTypeFlag_AcceptsMesh |
204                                 eModifierTypeFlag_SupportsMapping |
205                                 eModifierTypeFlag_SupportsEditmode |
206                                 eModifierTypeFlag_EnableInEditmode |
207                                 eModifierTypeFlag_AcceptsCVs,
208
209         /* copyData */          copyData,
210
211         /* deformVerts_DM */    NULL,
212         /* deformMatrices_DM */ NULL,
213         /* deformVertsEM_DM */  NULL,
214         /* deformMatricesEM_DM*/NULL,
215         /* applyModifier_DM */  applyModifier,
216         /* applyModifierEM_DM */applyModifierEM,
217
218         /* deformVerts */       NULL,
219         /* deformMatrices */    NULL,
220         /* deformVertsEM */     NULL,
221         /* deformMatricesEM */  NULL,
222         /* applyModifier */     NULL,
223         /* applyModifierEM */   NULL,
224
225         /* initData */          initData,
226         /* requiredDataMask */  NULL,
227         /* freeData */          freeData,
228         /* isDisabled */        isDisabled,
229         /* updateDepsgraph */   NULL,
230         /* dependsOnTime */     NULL,
231         /* dependsOnNormals */  dependsOnNormals,
232         /* foreachObjectLink */ NULL,
233         /* foreachIDLink */     NULL,
234         /* foreachTexLink */    NULL,
235 };
236