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(
103         ModifierData *md, const ModifierEvalContext *ctx,
104         DerivedMesh *derivedData)
105 {
106         SubsurfModifierData *smd = (SubsurfModifierData *) md;
107         SubsurfFlags subsurf_flags = 0;
108         DerivedMesh *result;
109         const bool useRenderParams = (ctx->flag & MOD_APPLY_RENDER) != 0;
110         const bool isFinalCalc = (ctx->flag & MOD_APPLY_USECACHE) != 0;
111
112 #ifdef WITH_OPENSUBDIV
113         const bool allow_gpu = (ctx->flag & MOD_APPLY_ALLOW_GPU) != 0;
114 #endif
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 #ifdef WITH_OPENSUBDIV
125         /* TODO(sergey): Not entirely correct, modifiers on top of subsurf
126          * could be disabled.
127          */
128         if (md->next == NULL &&
129             allow_gpu &&
130             do_cddm_convert == false &&
131             smd->use_opensubdiv)
132         {
133                 if (U.opensubdiv_compute_type == USER_OPENSUBDIV_COMPUTE_NONE) {
134                         modifier_setError(md, "OpenSubdiv is disabled in User Preferences");
135                 }
136                 else if ((ctx->object->mode & (OB_MODE_VERTEX_PAINT | OB_MODE_WEIGHT_PAINT | OB_MODE_TEXTURE_PAINT)) != 0) {
137                         modifier_setError(md, "OpenSubdiv is not supported in paint modes");
138                 }
139                 else if ((DEG_get_eval_flags_for_id(ctx->depsgraph, &ctx->object->id) & DAG_EVAL_NEED_CPU) == 0) {
140                         subsurf_flags |= SUBSURF_USE_GPU_BACKEND;
141                         do_cddm_convert = false;
142                 }
143                 else {
144                         modifier_setError(md, "OpenSubdiv is disabled due to dependencies");
145                 }
146         }
147 #endif
148
149         result = subsurf_make_derived_from_derived(derivedData, smd, NULL, subsurf_flags);
150         result->cd_flag = derivedData->cd_flag;
151
152         {
153                 DerivedMesh *cddm = CDDM_copy(result);
154                 result->release(result);
155                 result = cddm;
156         }
157
158 #ifndef WITH_OPESUBDIV
159         (void) do_cddm_convert;
160 #endif
161
162         return result;
163 }
164
165 static DerivedMesh *applyModifierEM(
166         ModifierData *md, const ModifierEvalContext *ctx,
167         struct BMEditMesh *UNUSED(editData),
168         DerivedMesh *derivedData)
169 {
170         SubsurfModifierData *smd = (SubsurfModifierData *) md;
171         DerivedMesh *result;
172         /* 'orco' using editmode flags would cause cache to be used twice in editbmesh_calc_modifiers */
173         SubsurfFlags ss_flags = (ctx->flag & MOD_APPLY_ORCO) ? 0 : (SUBSURF_FOR_EDIT_MODE | SUBSURF_IN_EDIT_MODE);
174 #ifdef WITH_OPENSUBDIV
175         const bool allow_gpu = (ctx->flag & MOD_APPLY_ALLOW_GPU) != 0;
176         if (md->next == NULL && allow_gpu && smd->use_opensubdiv) {
177                 modifier_setError(md, "OpenSubdiv is not supported in edit mode");
178         }
179 #endif
180
181         result = subsurf_make_derived_from_derived(derivedData, smd, NULL, ss_flags);
182
183         return result;
184 }
185
186 static bool dependsOnNormals(ModifierData *md)
187 {
188 #ifdef WITH_OPENSUBDIV
189         SubsurfModifierData *smd = (SubsurfModifierData *) md;
190         if (smd->use_opensubdiv && md->next == NULL) {
191                 return true;
192         }
193 #else
194         UNUSED_VARS(md);
195 #endif
196         return false;
197 }
198
199 ModifierTypeInfo modifierType_Subsurf = {
200         /* name */              "Subsurf",
201         /* structName */        "SubsurfModifierData",
202         /* structSize */        sizeof(SubsurfModifierData),
203         /* type */              eModifierTypeType_Constructive,
204         /* flags */             eModifierTypeFlag_AcceptsMesh |
205                                 eModifierTypeFlag_SupportsMapping |
206                                 eModifierTypeFlag_SupportsEditmode |
207                                 eModifierTypeFlag_EnableInEditmode |
208                                 eModifierTypeFlag_AcceptsCVs,
209
210         /* copyData */          copyData,
211
212         /* deformVerts_DM */    NULL,
213         /* deformMatrices_DM */ NULL,
214         /* deformVertsEM_DM */  NULL,
215         /* deformMatricesEM_DM*/NULL,
216         /* applyModifier_DM */  applyModifier,
217         /* applyModifierEM_DM */applyModifierEM,
218
219         /* deformVerts */       NULL,
220         /* deformMatrices */    NULL,
221         /* deformVertsEM */     NULL,
222         /* deformMatricesEM */  NULL,
223         /* applyModifier */     NULL,
224         /* applyModifierEM */   NULL,
225
226         /* initData */          initData,
227         /* requiredDataMask */  NULL,
228         /* freeData */          freeData,
229         /* isDisabled */        isDisabled,
230         /* updateDepsgraph */   NULL,
231         /* dependsOnTime */     NULL,
232         /* dependsOnNormals */  dependsOnNormals,
233         /* foreachObjectLink */ NULL,
234         /* foreachIDLink */     NULL,
235         /* foreachTexLink */    NULL,
236 };
237