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