Fix T56657: Crash when creating a collection instance containing probes
[blender.git] / source / blender / draw / modes / edit_curve_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/edit_curve_mode.c
23  *  \ingroup draw
24  */
25
26 #include "DRW_engine.h"
27 #include "DRW_render.h"
28
29 #include "DNA_curve_types.h"
30 #include "DNA_view3d_types.h"
31
32 #include "BKE_object.h"
33
34 /* If builtin shaders are needed */
35 #include "GPU_shader.h"
36 #include "GPU_batch.h"
37
38 #include "draw_common.h"
39
40 #include "draw_mode_engines.h"
41
42 /* If needed, contains all global/Theme colors
43  * Add needed theme colors / values to DRW_globals_update() and update UBO
44  * Not needed for constant color. */
45 extern struct GPUUniformBuffer *globals_ubo; /* draw_common.c */
46 extern struct GlobalsUboStorage ts; /* draw_common.c */
47
48 extern char datatoc_common_globals_lib_glsl[];
49 extern char datatoc_edit_curve_overlay_loosevert_vert_glsl[];
50 extern char datatoc_edit_curve_overlay_frag_glsl[];
51 extern char datatoc_edit_curve_overlay_handle_geom_glsl[];
52
53 extern char datatoc_gpu_shader_3D_vert_glsl[];
54 extern char datatoc_gpu_shader_uniform_color_frag_glsl[];
55 extern char datatoc_gpu_shader_point_uniform_color_frag_glsl[];
56 extern char datatoc_gpu_shader_flat_color_frag_glsl[];
57
58 /* *********** LISTS *********** */
59 /* All lists are per viewport specific datas.
60  * They are all free when viewport changes engines
61  * or is free itself. Use EDIT_CURVE_engine_init() to
62  * initialize most of them and EDIT_CURVE_cache_init()
63  * for EDIT_CURVE_PassList */
64
65 typedef struct EDIT_CURVE_PassList {
66         /* Declare all passes here and init them in
67          * EDIT_CURVE_cache_init().
68          * Only contains (DRWPass *) */
69         struct DRWPass *wire_pass;
70         struct DRWPass *overlay_edge_pass;
71         struct DRWPass *overlay_vert_pass;
72 } EDIT_CURVE_PassList;
73
74 typedef struct EDIT_CURVE_FramebufferList {
75         /* Contains all framebuffer objects needed by this engine.
76          * Only contains (GPUFrameBuffer *) */
77         struct GPUFrameBuffer *fb;
78 } EDIT_CURVE_FramebufferList;
79
80 typedef struct EDIT_CURVE_TextureList {
81         /* Contains all framebuffer textures / utility textures
82          * needed by this engine. Only viewport specific textures
83          * (not per object). Only contains (GPUTexture *) */
84         struct GPUTexture *texture;
85 } EDIT_CURVE_TextureList;
86
87 typedef struct EDIT_CURVE_StorageList {
88         /* Contains any other memory block that the engine needs.
89          * Only directly MEM_(m/c)allocN'ed blocks because they are
90          * free with MEM_freeN() when viewport is freed.
91          * (not per object) */
92         struct CustomStruct *block;
93         struct EDIT_CURVE_PrivateData *g_data;
94 } EDIT_CURVE_StorageList;
95
96 typedef struct EDIT_CURVE_Data {
97         /* Struct returned by DRW_viewport_engine_data_ensure.
98          * If you don't use one of these, just make it a (void *) */
99         // void *fbl;
100         void *engine_type; /* Required */
101         EDIT_CURVE_FramebufferList *fbl;
102         EDIT_CURVE_TextureList *txl;
103         EDIT_CURVE_PassList *psl;
104         EDIT_CURVE_StorageList *stl;
105 } EDIT_CURVE_Data;
106
107 /* *********** STATIC *********** */
108
109 static struct {
110         /* Custom shaders :
111          * Add sources to source/blender/draw/modes/shaders
112          * init in EDIT_CURVE_engine_init();
113          * free in EDIT_CURVE_engine_free(); */
114
115         GPUShader *wire_sh;
116
117         GPUShader *overlay_edge_sh;  /* handles and nurbs control cage */
118         GPUShader *overlay_vert_sh;
119
120 } e_data = {NULL}; /* Engine data */
121
122 typedef struct EDIT_CURVE_PrivateData {
123         /* This keeps the references of the shading groups for
124          * easy access in EDIT_CURVE_cache_populate() */
125
126         /* resulting curve as 'wire' for curves (and optionally normals) */
127         DRWShadingGroup *wire_shgrp;
128
129         DRWShadingGroup *overlay_edge_shgrp;
130         DRWShadingGroup *overlay_vert_shgrp;
131 } EDIT_CURVE_PrivateData; /* Transient data */
132
133 /* *********** FUNCTIONS *********** */
134
135 /* Init Textures, Framebuffers, Storage and Shaders.
136  * It is called for every frames.
137  * (Optional) */
138 static void EDIT_CURVE_engine_init(void *vedata)
139 {
140         EDIT_CURVE_TextureList *txl = ((EDIT_CURVE_Data *)vedata)->txl;
141         EDIT_CURVE_FramebufferList *fbl = ((EDIT_CURVE_Data *)vedata)->fbl;
142         EDIT_CURVE_StorageList *stl = ((EDIT_CURVE_Data *)vedata)->stl;
143
144         UNUSED_VARS(txl, fbl, stl);
145
146         /* Init Framebuffers like this: order is attachment order (for color texs) */
147         /*
148          * DRWFboTexture tex[2] = {{&txl->depth, GPU_DEPTH_COMPONENT24, 0},
149          *                         {&txl->color, GPU_RGBA8, DRW_TEX_FILTER}};
150          */
151
152         /* DRW_framebuffer_init takes care of checking if
153          * the framebuffer is valid and has the right size*/
154         /*
155          * float *viewport_size = DRW_viewport_size_get();
156          * DRW_framebuffer_init(&fbl->occlude_wire_fb,
157          *                     (int)viewport_size[0], (int)viewport_size[1],
158          *                     tex, 2);
159          */
160
161         if (!e_data.wire_sh) {
162                 e_data.wire_sh = GPU_shader_get_builtin_shader(GPU_SHADER_3D_UNIFORM_COLOR);
163         }
164
165         if (!e_data.overlay_edge_sh) {
166                 e_data.overlay_edge_sh = DRW_shader_create_with_lib(
167                         datatoc_edit_curve_overlay_loosevert_vert_glsl,
168                         datatoc_edit_curve_overlay_handle_geom_glsl,
169                         datatoc_gpu_shader_flat_color_frag_glsl,
170                         datatoc_common_globals_lib_glsl, NULL);
171         }
172
173         if (!e_data.overlay_vert_sh) {
174                 e_data.overlay_vert_sh = DRW_shader_create_with_lib(
175                         datatoc_edit_curve_overlay_loosevert_vert_glsl, NULL,
176                         datatoc_edit_curve_overlay_frag_glsl,
177                         datatoc_common_globals_lib_glsl, NULL);
178         }
179 }
180
181 /* Here init all passes and shading groups
182  * Assume that all Passes are NULL */
183 static void EDIT_CURVE_cache_init(void *vedata)
184 {
185         EDIT_CURVE_PassList *psl = ((EDIT_CURVE_Data *)vedata)->psl;
186         EDIT_CURVE_StorageList *stl = ((EDIT_CURVE_Data *)vedata)->stl;
187
188         if (!stl->g_data) {
189                 /* Alloc transient pointers */
190                 stl->g_data = MEM_mallocN(sizeof(*stl->g_data), __func__);
191         }
192
193         {
194                 DRWShadingGroup *grp;
195
196                 /* Center-Line (wire) */
197                 psl->wire_pass = DRW_pass_create(
198                         "Curve Wire",
199                         DRW_STATE_WRITE_COLOR | DRW_STATE_WRITE_DEPTH | DRW_STATE_DEPTH_LESS_EQUAL | DRW_STATE_WIRE);
200
201                 grp = DRW_shgroup_create(e_data.wire_sh, psl->wire_pass);
202                 DRW_shgroup_uniform_vec4(grp, "color", ts.colorWireEdit, 1);
203                 stl->g_data->wire_shgrp = grp;
204
205
206                 psl->overlay_edge_pass = DRW_pass_create(
207                         "Curve Handle Overlay",
208                         DRW_STATE_WRITE_COLOR | DRW_STATE_WRITE_DEPTH | DRW_STATE_WIRE);
209
210                 grp = DRW_shgroup_create(e_data.overlay_edge_sh, psl->overlay_edge_pass);
211                 DRW_shgroup_uniform_block(grp, "globalsBlock", globals_ubo);
212                 DRW_shgroup_uniform_vec2(grp, "viewportSize", DRW_viewport_size_get(), 1);
213                 stl->g_data->overlay_edge_shgrp = grp;
214
215
216                 psl->overlay_vert_pass = DRW_pass_create(
217                         "Curve Vert Overlay",
218                         DRW_STATE_WRITE_COLOR | DRW_STATE_WRITE_DEPTH | DRW_STATE_POINT);
219
220                 grp = DRW_shgroup_create(e_data.overlay_vert_sh, psl->overlay_vert_pass);
221                 DRW_shgroup_uniform_block(grp, "globalsBlock", globals_ubo);
222                 DRW_shgroup_uniform_vec2(grp, "viewportSize", DRW_viewport_size_get(), 1);
223                 stl->g_data->overlay_vert_shgrp = grp;
224         }
225
226 }
227
228 /* Add geometry to shadingGroups. Execute for each objects */
229 static void EDIT_CURVE_cache_populate(void *vedata, Object *ob)
230 {
231         EDIT_CURVE_PassList *psl = ((EDIT_CURVE_Data *)vedata)->psl;
232         EDIT_CURVE_StorageList *stl = ((EDIT_CURVE_Data *)vedata)->stl;
233         const DRWContextState *draw_ctx = DRW_context_state_get();
234         View3D *v3d = draw_ctx->v3d;
235
236         UNUSED_VARS(psl, stl);
237
238         if (ob->type == OB_CURVE) {
239 #if 0
240                 if (ob == draw_ctx->object_edit)
241 #else
242                 if ((ob == draw_ctx->object_edit) || BKE_object_is_in_editmode(ob))
243 #endif
244                 {
245                         Curve *cu = ob->data;
246                         /* Get geometry cache */
247                         struct GPUBatch *geom;
248
249                         geom = DRW_cache_curve_edge_wire_get(ob);
250                         DRW_shgroup_call_add(stl->g_data->wire_shgrp, geom, ob->obmat);
251
252                         if ((cu->flag & CU_3D) && (cu->drawflag & CU_HIDE_NORMALS) == 0) {
253                                 geom = DRW_cache_curve_edge_normal_get(ob, v3d->overlay.normals_length);
254                                 DRW_shgroup_call_add(stl->g_data->wire_shgrp, geom, ob->obmat);
255                         }
256
257                         /* Add geom to a shading group */
258                         geom = DRW_cache_curve_edge_overlay_get(ob);
259                         if (geom) {
260                                 DRW_shgroup_call_add(stl->g_data->overlay_edge_shgrp, geom, ob->obmat);
261                         }
262
263                         geom = DRW_cache_curve_vert_overlay_get(ob);
264                         DRW_shgroup_call_add(stl->g_data->overlay_vert_shgrp, geom, ob->obmat);
265                 }
266         }
267 }
268
269 /* Optional: Post-cache_populate callback */
270 static void EDIT_CURVE_cache_finish(void *vedata)
271 {
272         EDIT_CURVE_PassList *psl = ((EDIT_CURVE_Data *)vedata)->psl;
273         EDIT_CURVE_StorageList *stl = ((EDIT_CURVE_Data *)vedata)->stl;
274
275         /* Do something here! dependant on the objects gathered */
276         UNUSED_VARS(psl, stl);
277 }
278
279 /* Draw time ! Control rendering pipeline from here */
280 static void EDIT_CURVE_draw_scene(void *vedata)
281 {
282         EDIT_CURVE_PassList *psl = ((EDIT_CURVE_Data *)vedata)->psl;
283         EDIT_CURVE_FramebufferList *fbl = ((EDIT_CURVE_Data *)vedata)->fbl;
284
285         /* Default framebuffer and texture */
286         DefaultFramebufferList *dfbl = DRW_viewport_framebuffer_list_get();
287         DefaultTextureList *dtxl = DRW_viewport_texture_list_get();
288
289         UNUSED_VARS(fbl);
290
291         MULTISAMPLE_SYNC_ENABLE(dfbl, dtxl);
292
293         /* Show / hide entire passes, swap framebuffers ... whatever you fancy */
294         /*
295          * DRW_framebuffer_texture_detach(dtxl->depth);
296          * DRW_framebuffer_bind(fbl->custom_fb);
297          * DRW_draw_pass(psl->pass);
298          * DRW_framebuffer_texture_attach(dfbl->default_fb, dtxl->depth, 0, 0);
299          * DRW_framebuffer_bind(dfbl->default_fb);
300          */
301
302         /* ... or just render passes on default framebuffer. */
303         DRW_draw_pass(psl->wire_pass);
304         DRW_draw_pass(psl->overlay_edge_pass);
305         DRW_draw_pass(psl->overlay_vert_pass);
306
307         MULTISAMPLE_SYNC_DISABLE(dfbl, dtxl)
308
309         /* If you changed framebuffer, double check you rebind
310          * the default one with its textures attached before finishing */
311 }
312
313 /* Cleanup when destroying the engine.
314  * This is not per viewport ! only when quitting blender.
315  * Mostly used for freeing shaders */
316 static void EDIT_CURVE_engine_free(void)
317 {
318         DRW_SHADER_FREE_SAFE(e_data.overlay_edge_sh);
319         DRW_SHADER_FREE_SAFE(e_data.overlay_vert_sh);
320 }
321
322 static const DrawEngineDataSize EDIT_CURVE_data_size = DRW_VIEWPORT_DATA_SIZE(EDIT_CURVE_Data);
323
324 DrawEngineType draw_engine_edit_curve_type = {
325         NULL, NULL,
326         N_("EditCurveMode"),
327         &EDIT_CURVE_data_size,
328         &EDIT_CURVE_engine_init,
329         &EDIT_CURVE_engine_free,
330         &EDIT_CURVE_cache_init,
331         &EDIT_CURVE_cache_populate,
332         &EDIT_CURVE_cache_finish,
333         NULL, /* draw_background but not needed by mode engines */
334         &EDIT_CURVE_draw_scene,
335         NULL,
336         NULL,
337 };