5c60df270f909578308f3616cdeb8e2ad252afe3
[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 /* If builtin shaders are needed */
30 #include "GPU_shader.h"
31
32 #include "draw_common.h"
33
34 #include "draw_mode_engines.h"
35
36 /* If needed, contains all global/Theme colors
37  * Add needed theme colors / values to DRW_globals_update() and update UBO
38  * Not needed for constant color. */
39 extern struct GPUUniformBuffer *globals_ubo; /* draw_common.c */
40 extern struct GlobalsUboStorage ts; /* draw_common.c */
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 EDIT_CURVE_engine_init() to
46  * initialize most of them and EDIT_CURVE_cache_init()
47  * for EDIT_CURVE_PassList */
48
49 /* keep it under MAX_PASSES */
50 typedef struct EDIT_CURVE_PassList {
51         /* Declare all passes here and init them in
52          * EDIT_CURVE_cache_init().
53          * Only contains (DRWPass *) */
54         struct DRWPass *pass;
55 } EDIT_CURVE_PassList;
56
57 /* keep it under MAX_BUFFERS */
58 typedef struct EDIT_CURVE_FramebufferList {
59         /* Contains all framebuffer objects needed by this engine.
60          * Only contains (GPUFrameBuffer *) */
61         struct GPUFrameBuffer *fb;
62 } EDIT_CURVE_FramebufferList;
63
64 /* keep it under MAX_TEXTURES */
65 typedef struct EDIT_CURVE_TextureList {
66         /* Contains all framebuffer textures / utility textures
67          * needed by this engine. Only viewport specific textures
68          * (not per object). Only contains (GPUTexture *) */
69         struct GPUTexture *texture;
70 } EDIT_CURVE_TextureList;
71
72 /* keep it under MAX_STORAGE */
73 typedef struct EDIT_CURVE_StorageList {
74         /* Contains any other memory block that the engine needs.
75          * Only directly MEM_(m/c)allocN'ed blocks because they are
76          * free with MEM_freeN() when viewport is freed.
77          * (not per object) */
78         struct CustomStruct *block;
79         struct g_data *g_data;
80 } EDIT_CURVE_StorageList;
81
82 typedef struct EDIT_CURVE_Data {
83         /* Struct returned by DRW_viewport_engine_data_get.
84          * If you don't use one of these, just make it a (void *) */
85         // void *fbl;
86         void *engine_type; /* Required */
87         EDIT_CURVE_FramebufferList *fbl;
88         EDIT_CURVE_TextureList *txl;
89         EDIT_CURVE_PassList *psl;
90         EDIT_CURVE_StorageList *stl;
91 } EDIT_CURVE_Data;
92
93 /* *********** STATIC *********** */
94
95 static struct {
96         /* Custom shaders :
97          * Add sources to source/blender/draw/modes/shaders
98          * init in EDIT_CURVE_engine_init();
99          * free in EDIT_CURVE_engine_free(); */
100         struct GPUShader *custom_shader;
101 } e_data = {NULL}; /* Engine data */
102
103 typedef struct g_data {
104
105
106         /* This keeps the references of the shading groups for
107          * easy access in EDIT_CURVE_cache_populate() */
108         DRWShadingGroup *group;
109 } g_data; /* Transient data */
110
111 /* *********** FUNCTIONS *********** */
112
113 /* Init Textures, Framebuffers, Storage and Shaders.
114  * It is called for every frames.
115  * (Optional) */
116 static void EDIT_CURVE_engine_init(void *vedata)
117 {
118         EDIT_CURVE_TextureList *txl = ((EDIT_CURVE_Data *)vedata)->txl;
119         EDIT_CURVE_FramebufferList *fbl = ((EDIT_CURVE_Data *)vedata)->fbl;
120         EDIT_CURVE_StorageList *stl = ((EDIT_CURVE_Data *)vedata)->stl;
121
122         UNUSED_VARS(txl, fbl, stl);
123
124         /* Init Framebuffers like this: order is attachment order (for color texs) */
125         /*
126          * DRWFboTexture tex[2] = {{&txl->depth, DRW_BUF_DEPTH_24, 0},
127          *                         {&txl->color, DRW_BUF_RGBA_8, DRW_TEX_FILTER}};
128          */
129
130         /* DRW_framebuffer_init takes care of checking if
131          * the framebuffer is valid and has the right size*/
132         /*
133          * float *viewport_size = DRW_viewport_size_get();
134          * DRW_framebuffer_init(&fbl->occlude_wire_fb,
135          *                     (int)viewport_size[0], (int)viewport_size[1],
136          *                     tex, 2);
137          */
138
139         if (!e_data.custom_shader) {
140                 e_data.custom_shader = GPU_shader_get_builtin_shader(GPU_SHADER_3D_UNIFORM_COLOR);
141         }
142 }
143
144 /* Here init all passes and shading groups
145  * Assume that all Passes are NULL */
146 static void EDIT_CURVE_cache_init(void *vedata)
147 {
148         EDIT_CURVE_PassList *psl = ((EDIT_CURVE_Data *)vedata)->psl;
149         EDIT_CURVE_StorageList *stl = ((EDIT_CURVE_Data *)vedata)->stl;
150
151         if (!stl->g_data) {
152                 /* Alloc transient pointers */
153                 stl->g_data = MEM_mallocN(sizeof(g_data), "g_data");
154         }
155
156         {
157                 /* Create a pass */
158                 DRWState state = DRW_STATE_WRITE_COLOR | DRW_STATE_WRITE_DEPTH | DRW_STATE_DEPTH_LESS | DRW_STATE_BLEND | DRW_STATE_WIRE;
159                 psl->pass = DRW_pass_create("My Pass", state);
160
161                 /* Create a shadingGroup using a function in draw_common.c or custom one */
162                 /*
163                  * stl->g_data->group = shgroup_dynlines_uniform_color(psl->pass, ts.colorWire);
164                  * -- or --
165                  * stl->g_data->group = DRW_shgroup_create(e_data.custom_shader, psl->pass);
166                  */
167                 stl->g_data->group = DRW_shgroup_create(e_data.custom_shader, psl->pass);
168
169                 /* Uniforms need a pointer to it's value so be sure it's accessible at
170                  * any given time (i.e. use static vars) */
171                 static float color[4] = {0.2f, 0.5f, 0.3f, 1.0};
172                 DRW_shgroup_uniform_vec4(stl->g_data->group, "color", color, 1);
173         }
174
175 }
176
177 /* Add geometry to shadingGroups. Execute for each objects */
178 static void EDIT_CURVE_cache_populate(void *vedata, Object *ob)
179 {
180         EDIT_CURVE_PassList *psl = ((EDIT_CURVE_Data *)vedata)->psl;
181         EDIT_CURVE_StorageList *stl = ((EDIT_CURVE_Data *)vedata)->stl;
182
183         UNUSED_VARS(psl, stl);
184
185         if (ob->type == OB_MESH) {
186                 /* Get geometry cache */
187                 struct Batch *geom = DRW_cache_surface_get(ob);
188
189                 /* Add geom to a shading group */
190                 DRW_shgroup_call_add(stl->g_data->group, geom, ob->obmat);
191         }
192 }
193
194 /* Optional: Post-cache_populate callback */
195 static void EDIT_CURVE_cache_finish(void *vedata)
196 {
197         EDIT_CURVE_PassList *psl = ((EDIT_CURVE_Data *)vedata)->psl;
198         EDIT_CURVE_StorageList *stl = ((EDIT_CURVE_Data *)vedata)->stl;
199
200         /* Do something here! dependant on the objects gathered */
201         UNUSED_VARS(psl, stl);
202 }
203
204 /* Draw time ! Control rendering pipeline from here */
205 static void EDIT_CURVE_draw_scene(void *vedata)
206 {
207         EDIT_CURVE_PassList *psl = ((EDIT_CURVE_Data *)vedata)->psl;
208         EDIT_CURVE_FramebufferList *fbl = ((EDIT_CURVE_Data *)vedata)->fbl;
209
210         /* Default framebuffer and texture */
211         DefaultFramebufferList *dfbl = DRW_viewport_framebuffer_list_get();
212         DefaultTextureList *dtxl = DRW_viewport_texture_list_get();
213
214         UNUSED_VARS(fbl, dfbl, dtxl);
215
216         /* Show / hide entire passes, swap framebuffers ... whatever you fancy */
217         /*
218          * DRW_framebuffer_texture_detach(dtxl->depth);
219          * DRW_framebuffer_bind(fbl->custom_fb);
220          * DRW_draw_pass(psl->pass);
221          * DRW_framebuffer_texture_attach(dfbl->default_fb, dtxl->depth, 0);
222          * DRW_framebuffer_bind(dfbl->default_fb);
223          */
224
225         /* ... or just render passes on default framebuffer. */
226         DRW_draw_pass(psl->pass);
227
228         /* If you changed framebuffer, double check you rebind
229          * the default one with its textures attached before finishing */
230 }
231
232 /* Cleanup when destroying the engine.
233  * This is not per viewport ! only when quitting blender.
234  * Mostly used for freeing shaders */
235 static void EDIT_CURVE_engine_free(void)
236 {
237         // if (custom_shader)
238         //      DRW_shader_free(custom_shader);
239 }
240
241 /* Create collection settings here.
242  *
243  * Be sure to add this function there :
244  * source/blender/draw/DRW_engine.h
245  * source/blender/blenkernel/intern/layer.c
246  * source/blenderplayer/bad_level_call_stubs/stubs.c
247  *
248  * And relevant collection settings to :
249  * source/blender/makesrna/intern/rna_scene.c
250  * source/blender/blenkernel/intern/layer.c
251  */
252 #if 0
253 void EDIT_CURVE_collection_settings_create(CollectionEngineSettings *ces)
254 {
255         BLI_assert(ces);
256         // BKE_collection_engine_property_add_int(ces, "my_bool_prop", false);
257         // BKE_collection_engine_property_add_int(ces, "my_int_prop", 0);
258         // BKE_collection_engine_property_add_float(ces, "my_float_prop", 0.0f);
259 }
260 #endif
261
262 DrawEngineType draw_engine_edit_curve_type = {
263         NULL, NULL,
264         N_("EditCurveMode"),
265         &EDIT_CURVE_engine_init,
266         &EDIT_CURVE_engine_free,
267         &EDIT_CURVE_cache_init,
268         &EDIT_CURVE_cache_populate,
269         &EDIT_CURVE_cache_finish,
270         NULL, /* draw_background but not needed by mode engines */
271         &EDIT_CURVE_draw_scene
272 };