763129426139afd01f8652f6c157519c19ac7ad1
[blender.git] / source / blender / draw / modes / sculpt_mode.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  * Copyright 2016, Blender Foundation.
17  */
18
19 /** \file
20  * \ingroup draw
21  */
22
23 #include "DRW_engine.h"
24 #include "DRW_render.h"
25
26 #include "DNA_object_types.h"
27 #include "DNA_mesh_types.h"
28 #include "DNA_meshdata_types.h"
29
30 #include "BKE_pbvh.h"
31 #include "BKE_paint.h"
32
33 /* If builtin shaders are needed */
34 #include "GPU_shader.h"
35
36 #include "draw_common.h"
37
38 extern char datatoc_sculpt_mask_vert_glsl[];
39 extern char datatoc_gpu_shader_flat_color_frag_glsl[];
40 extern char datatoc_gpu_shader_3D_smooth_color_frag_glsl[];
41
42 /* *********** LISTS *********** */
43 /* All lists are per viewport specific datas.
44  * They are all free when viewport changes engines
45  * or is free itself. Use SCULPT_engine_init() to
46  * initialize most of them and SCULPT_cache_init()
47  * for SCULPT_PassList */
48
49 typedef struct SCULPT_PassList {
50         /* Declare all passes here and init them in
51          * SCULPT_cache_init().
52          * Only contains (DRWPass *) */
53         struct DRWPass *pass;
54 } SCULPT_PassList;
55
56 typedef struct SCULPT_FramebufferList {
57         /* Contains all framebuffer objects needed by this engine.
58          * Only contains (GPUFrameBuffer *) */
59         struct GPUFrameBuffer *fb;
60 } SCULPT_FramebufferList;
61
62 typedef struct SCULPT_TextureList {
63         /* Contains all framebuffer textures / utility textures
64          * needed by this engine. Only viewport specific textures
65          * (not per object). Only contains (GPUTexture *) */
66         struct GPUTexture *texture;
67 } SCULPT_TextureList;
68
69 typedef struct SCULPT_StorageList {
70         /* Contains any other memory block that the engine needs.
71          * Only directly MEM_(m/c)allocN'ed blocks because they are
72          * free with MEM_freeN() when viewport is freed.
73          * (not per object) */
74         struct CustomStruct *block;
75         struct SCULPT_PrivateData *g_data;
76 } SCULPT_StorageList;
77
78 typedef struct SCULPT_Data {
79         /* Struct returned by DRW_viewport_engine_data_ensure.
80          * If you don't use one of these, just make it a (void *) */
81         // void *fbl;
82         void *engine_type; /* Required */
83         SCULPT_FramebufferList *fbl;
84         SCULPT_TextureList *txl;
85         SCULPT_PassList *psl;
86         SCULPT_StorageList *stl;
87 } SCULPT_Data;
88
89 /* *********** STATIC *********** */
90
91 static struct {
92         /* Custom shaders :
93          * Add sources to source/blender/draw/modes/shaders
94          * init in SCULPT_engine_init();
95          * free in SCULPT_engine_free(); */
96         struct GPUShader *shader_flat;
97         struct GPUShader *shader_smooth;
98 } e_data = {NULL}; /* Engine data */
99
100 typedef struct SCULPT_PrivateData {
101         /* This keeps the references of the shading groups for
102          * easy access in SCULPT_cache_populate() */
103         DRWShadingGroup *group_flat;
104         DRWShadingGroup *group_smooth;
105 } SCULPT_PrivateData; /* Transient data */
106
107 /* *********** FUNCTIONS *********** */
108
109 /* Init Textures, Framebuffers, Storage and Shaders.
110  * It is called for every frames.
111  * (Optional) */
112 static void SCULPT_engine_init(void *vedata)
113 {
114         SCULPT_TextureList *txl = ((SCULPT_Data *)vedata)->txl;
115         SCULPT_FramebufferList *fbl = ((SCULPT_Data *)vedata)->fbl;
116         SCULPT_StorageList *stl = ((SCULPT_Data *)vedata)->stl;
117
118         UNUSED_VARS(txl, fbl, stl);
119
120         if (!e_data.shader_flat) {
121                 e_data.shader_flat = DRW_shader_create(datatoc_sculpt_mask_vert_glsl, NULL,
122                                                        datatoc_gpu_shader_flat_color_frag_glsl,
123                                                        "#define SHADE_FLAT");
124         }
125         if (!e_data.shader_smooth) {
126                 e_data.shader_smooth = DRW_shader_create(datatoc_sculpt_mask_vert_glsl, NULL,
127                                                          datatoc_gpu_shader_3D_smooth_color_frag_glsl, NULL);
128         }
129 }
130
131 /* Here init all passes and shading groups
132  * Assume that all Passes are NULL */
133 static void SCULPT_cache_init(void *vedata)
134 {
135         SCULPT_PassList *psl = ((SCULPT_Data *)vedata)->psl;
136         SCULPT_StorageList *stl = ((SCULPT_Data *)vedata)->stl;
137
138         if (!stl->g_data) {
139                 /* Alloc transient pointers */
140                 stl->g_data = MEM_mallocN(sizeof(*stl->g_data), __func__);
141         }
142
143         {
144                 /* Create a pass */
145                 DRWState state = DRW_STATE_WRITE_COLOR | DRW_STATE_DEPTH_EQUAL | DRW_STATE_MULTIPLY;
146                 psl->pass = DRW_pass_create("Sculpt Pass", state);
147
148                 /* Create a shadingGroup using a function in draw_common.c or custom one */
149                 /*
150                  * stl->g_data->group = shgroup_dynlines_uniform_color(psl->pass, ts.colorWire);
151                  * -- or --
152                  * stl->g_data->group = DRW_shgroup_create(e_data.custom_shader, psl->pass);
153                  */
154                 stl->g_data->group_flat = DRW_shgroup_create(e_data.shader_flat, psl->pass);
155                 stl->g_data->group_smooth = DRW_shgroup_create(e_data.shader_smooth, psl->pass);
156         }
157 }
158
159 static bool object_is_flat(const Object *ob)
160 {
161         Mesh *me = ob->data;
162         if (me->mpoly && me->mpoly[0].flag & ME_SMOOTH) {
163                 return false;
164         }
165         else {
166                 return true;
167         }
168 }
169
170 static void sculpt_draw_mask_cb(
171         DRWShadingGroup *shgroup,
172         void (*draw_fn)(DRWShadingGroup *shgroup, struct GPUBatch *geom),
173         void *user_data)
174 {
175         Object *ob = user_data;
176         PBVH *pbvh = ob->sculpt->pbvh;
177
178         if (pbvh) {
179                 BKE_pbvh_draw_cb(
180                         pbvh, NULL, NULL, false, true,
181                         (void (*)(void *, struct GPUBatch *))draw_fn, shgroup);
182         }
183 }
184
185 /* Add geometry to shadingGroups. Execute for each objects */
186 static void SCULPT_cache_populate(void *vedata, Object *ob)
187 {
188         SCULPT_PassList *psl = ((SCULPT_Data *)vedata)->psl;
189         SCULPT_StorageList *stl = ((SCULPT_Data *)vedata)->stl;
190
191         UNUSED_VARS(psl, stl);
192
193         if (ob->type == OB_MESH) {
194                 const DRWContextState *draw_ctx = DRW_context_state_get();
195
196                 if (ob->sculpt && (ob == draw_ctx->obact)) {
197                         /* XXX, needed for dyntopo-undo (which clears).
198                          * probably depsgraph should handlle? in 2.7x getting derived-mesh does this (mesh_build_data) */
199                         if (ob->sculpt->pbvh == NULL) {
200                                 /* create PBVH immediately (would be created on the fly too,
201                                  * but this avoids waiting on first stroke) */
202                                 Scene *scene = draw_ctx->scene;
203
204                                 BKE_sculpt_update_mesh_elements(draw_ctx->depsgraph, scene, scene->toolsettings->sculpt, ob, false, false);
205                         }
206
207                         PBVH *pbvh = ob->sculpt->pbvh;
208                         if (pbvh && pbvh_has_mask(pbvh)) {
209                                 /* Get geometry cache */
210                                 DRWShadingGroup *shgroup = object_is_flat(ob) ? stl->g_data->group_flat : stl->g_data->group_smooth;
211
212                                 DRW_shgroup_call_generate_add(shgroup, sculpt_draw_mask_cb, ob, ob->obmat);
213                         }
214                 }
215         }
216 }
217
218 /* Optional: Post-cache_populate callback */
219 static void SCULPT_cache_finish(void *vedata)
220 {
221         SCULPT_PassList *psl = ((SCULPT_Data *)vedata)->psl;
222         SCULPT_StorageList *stl = ((SCULPT_Data *)vedata)->stl;
223
224         /* Do something here! dependent on the objects gathered */
225         UNUSED_VARS(psl, stl);
226 }
227
228 /* Draw time ! Control rendering pipeline from here */
229 static void SCULPT_draw_scene(void *vedata)
230 {
231         SCULPT_PassList *psl = ((SCULPT_Data *)vedata)->psl;
232         SCULPT_FramebufferList *fbl = ((SCULPT_Data *)vedata)->fbl;
233
234         /* Default framebuffer and texture */
235         DefaultFramebufferList *dfbl = DRW_viewport_framebuffer_list_get();
236         DefaultTextureList *dtxl = DRW_viewport_texture_list_get();
237
238         UNUSED_VARS(fbl, dfbl, dtxl);
239
240         /* Show / hide entire passes, swap framebuffers ... whatever you fancy */
241         /*
242          * DRW_framebuffer_texture_detach(dtxl->depth);
243          * DRW_framebuffer_bind(fbl->custom_fb);
244          * DRW_draw_pass(psl->pass);
245          * DRW_framebuffer_texture_attach(dfbl->default_fb, dtxl->depth, 0, 0);
246          * DRW_framebuffer_bind(dfbl->default_fb);
247          */
248
249         /* ... or just render passes on default framebuffer. */
250         DRW_draw_pass(psl->pass);
251
252         /* If you changed framebuffer, double check you rebind
253          * the default one with its textures attached before finishing */
254 }
255
256 /* Cleanup when destroying the engine.
257  * This is not per viewport ! only when quitting blender.
258  * Mostly used for freeing shaders */
259 static void SCULPT_engine_free(void)
260 {
261         DRW_SHADER_FREE_SAFE(e_data.shader_flat);
262         DRW_SHADER_FREE_SAFE(e_data.shader_smooth);
263 }
264
265 static const DrawEngineDataSize SCULPT_data_size = DRW_VIEWPORT_DATA_SIZE(SCULPT_Data);
266
267 DrawEngineType draw_engine_sculpt_type = {
268         NULL, NULL,
269         N_("SculptMode"),
270         &SCULPT_data_size,
271         &SCULPT_engine_init,
272         &SCULPT_engine_free,
273         &SCULPT_cache_init,
274         &SCULPT_cache_populate,
275         &SCULPT_cache_finish,
276         NULL, /* draw_background but not needed by mode engines */
277         &SCULPT_draw_scene,
278         NULL,
279         NULL,
280 };