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