Merge branch 'master' into blende2.8
[blender.git] / source / blender / draw / modes / edit_text_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_text_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
31 #include "BIF_glutil.h"
32
33 #include "BKE_font.h"
34
35 /* If builtin shaders are needed */
36 #include "GPU_shader.h"
37 #include "GPU_batch.h"
38
39 #include "draw_common.h"
40
41 #include "draw_mode_engines.h"
42
43 /* If needed, contains all global/Theme colors
44  * Add needed theme colors / values to DRW_globals_update() and update UBO
45  * Not needed for constant color. */
46 extern struct GPUUniformBuffer *globals_ubo; /* draw_common.c */
47 extern struct GlobalsUboStorage ts; /* draw_common.c */
48
49 /* *********** LISTS *********** */
50 /* All lists are per viewport specific datas.
51  * They are all free when viewport changes engines
52  * or is free itself. Use EDIT_TEXT_engine_init() to
53  * initialize most of them and EDIT_TEXT_cache_init()
54  * for EDIT_TEXT_PassList */
55
56 typedef struct EDIT_TEXT_PassList {
57         /* Declare all passes here and init them in
58          * EDIT_TEXT_cache_init().
59          * Only contains (DRWPass *) */
60         struct DRWPass *wire_pass;
61         struct DRWPass *overlay_select_pass;
62         struct DRWPass *overlay_cursor_pass;
63         struct DRWPass *text_box_pass;
64 } EDIT_TEXT_PassList;
65
66 typedef struct EDIT_TEXT_FramebufferList {
67         /* Contains all framebuffer objects needed by this engine.
68          * Only contains (GPUFrameBuffer *) */
69         struct GPUFrameBuffer *fb;
70 } EDIT_TEXT_FramebufferList;
71
72 typedef struct EDIT_TEXT_TextureList {
73         /* Contains all framebuffer textures / utility textures
74          * needed by this engine. Only viewport specific textures
75          * (not per object). Only contains (GPUTexture *) */
76         struct GPUTexture *texture;
77 } EDIT_TEXT_TextureList;
78
79 typedef struct EDIT_TEXT_StorageList {
80         /* Contains any other memory block that the engine needs.
81          * Only directly MEM_(m/c)allocN'ed blocks because they are
82          * free with MEM_freeN() when viewport is freed.
83          * (not per object) */
84         struct CustomStruct *block;
85         struct EDIT_TEXT_PrivateData *g_data;
86 } EDIT_TEXT_StorageList;
87
88 typedef struct EDIT_TEXT_Data {
89         /* Struct returned by DRW_viewport_engine_data_ensure.
90          * If you don't use one of these, just make it a (void *) */
91         // void *fbl;
92         void *engine_type; /* Required */
93         EDIT_TEXT_FramebufferList *fbl;
94         EDIT_TEXT_TextureList *txl;
95         EDIT_TEXT_PassList *psl;
96         EDIT_TEXT_StorageList *stl;
97 } EDIT_TEXT_Data;
98
99 /* *********** STATIC *********** */
100
101 static struct {
102         /* Custom shaders :
103          * Add sources to source/blender/draw/modes/shaders
104          * init in EDIT_TEXT_engine_init();
105          * free in EDIT_TEXT_engine_free(); */
106         GPUShader *wire_sh;
107         GPUShader *overlay_select_sh;
108         GPUShader *overlay_cursor_sh;
109 } e_data = {NULL}; /* Engine data */
110
111 typedef struct EDIT_TEXT_PrivateData {
112         /* resulting curve as 'wire' for fast editmode drawing */
113         DRWShadingGroup *wire_shgrp;
114         DRWShadingGroup *overlay_select_shgrp;
115         DRWShadingGroup *overlay_cursor_shgrp;
116         DRWShadingGroup *box_shgrp;
117         DRWShadingGroup *box_active_shgrp;
118 } EDIT_TEXT_PrivateData; /* Transient data */
119
120 /* *********** FUNCTIONS *********** */
121
122 /* Init Textures, Framebuffers, Storage and Shaders.
123  * It is called for every frames.
124  * (Optional) */
125 static void EDIT_TEXT_engine_init(void *vedata)
126 {
127         EDIT_TEXT_TextureList *txl = ((EDIT_TEXT_Data *)vedata)->txl;
128         EDIT_TEXT_FramebufferList *fbl = ((EDIT_TEXT_Data *)vedata)->fbl;
129         EDIT_TEXT_StorageList *stl = ((EDIT_TEXT_Data *)vedata)->stl;
130
131         UNUSED_VARS(txl, fbl, stl);
132
133         /* Init Framebuffers like this: order is attachment order (for color texs) */
134         /*
135          * DRWFboTexture tex[2] = {{&txl->depth, GPU_DEPTH_COMPONENT24, 0},
136          *                         {&txl->color, GPU_RGBA8, DRW_TEX_FILTER}};
137          */
138
139         /* DRW_framebuffer_init takes care of checking if
140          * the framebuffer is valid and has the right size*/
141         /*
142          * float *viewport_size = DRW_viewport_size_get();
143          * DRW_framebuffer_init(&fbl->occlude_wire_fb,
144          *                     (int)viewport_size[0], (int)viewport_size[1],
145          *                     tex, 2);
146          */
147
148         if (!e_data.wire_sh) {
149                 e_data.wire_sh = GPU_shader_get_builtin_shader(GPU_SHADER_3D_UNIFORM_COLOR);
150         }
151
152         if (!e_data.overlay_select_sh) {
153                 e_data.overlay_select_sh = GPU_shader_get_builtin_shader(GPU_SHADER_3D_UNIFORM_COLOR);
154         }
155
156         if (!e_data.overlay_cursor_sh) {
157                 e_data.overlay_cursor_sh = GPU_shader_get_builtin_shader(GPU_SHADER_3D_UNIFORM_COLOR);
158         }
159 }
160
161 /* Here init all passes and shading groups
162  * Assume that all Passes are NULL */
163 static void EDIT_TEXT_cache_init(void *vedata)
164 {
165         EDIT_TEXT_PassList *psl = ((EDIT_TEXT_Data *)vedata)->psl;
166         EDIT_TEXT_StorageList *stl = ((EDIT_TEXT_Data *)vedata)->stl;
167
168         if (!stl->g_data) {
169                 /* Alloc transient pointers */
170                 stl->g_data = MEM_mallocN(sizeof(*stl->g_data), __func__);
171         }
172
173         {
174                 /* Text outline (fast drawing!) */
175                 psl->wire_pass = DRW_pass_create(
176                         "Font Wire",
177                         DRW_STATE_WRITE_COLOR | DRW_STATE_WRITE_DEPTH | DRW_STATE_DEPTH_LESS_EQUAL | DRW_STATE_WIRE);
178                 stl->g_data->wire_shgrp = DRW_shgroup_create(e_data.wire_sh, psl->wire_pass);
179
180                 psl->overlay_select_pass = DRW_pass_create(
181                         "Font Select",
182                         DRW_STATE_WRITE_COLOR | DRW_STATE_WRITE_DEPTH);
183                 stl->g_data->overlay_select_shgrp = DRW_shgroup_create(e_data.overlay_select_sh, psl->overlay_select_pass);
184
185                 psl->overlay_cursor_pass = DRW_pass_create(
186                         "Font Cursor",
187                         DRW_STATE_WRITE_COLOR | DRW_STATE_WRITE_DEPTH);
188                 stl->g_data->overlay_cursor_shgrp = DRW_shgroup_create(e_data.overlay_cursor_sh, psl->overlay_cursor_pass);
189
190                 psl->text_box_pass = DRW_pass_create(
191                         "Font Text Boxes",
192                         DRW_STATE_WRITE_COLOR | DRW_STATE_WRITE_DEPTH);
193                 stl->g_data->box_shgrp = shgroup_dynlines_dashed_uniform_color(psl->text_box_pass, ts.colorWire);
194                 stl->g_data->box_active_shgrp = shgroup_dynlines_dashed_uniform_color(psl->text_box_pass, ts.colorActive);
195         }
196 }
197
198 /* Use 2D quad corners to create a matrix that set
199  * a [-1..1] quad at the right position. */
200 static void v2_quad_corners_to_mat4(float corners[4][2], float r_mat[4][4])
201 {
202         unit_m4(r_mat);
203         sub_v2_v2v2(r_mat[0], corners[1], corners[0]);
204         sub_v2_v2v2(r_mat[1], corners[3], corners[0]);
205         mul_v2_fl(r_mat[0], 0.5f);
206         mul_v2_fl(r_mat[1], 0.5f);
207         copy_v2_v2(r_mat[3], corners[0]);
208         add_v2_v2(r_mat[3], r_mat[0]);
209         add_v2_v2(r_mat[3], r_mat[1]);
210 }
211
212 static void edit_text_cache_populate_select(void *vedata, Object *ob)
213 {
214         EDIT_TEXT_StorageList *stl = ((EDIT_TEXT_Data *)vedata)->stl;
215         const Curve *cu = ob->data;
216         EditFont *ef = cu->editfont;
217         float final_mat[4][4], box[4][2];
218         struct GPUBatch *geom = DRW_cache_quad_get();
219
220         for (int i = 0; i < ef->selboxes_len; i++) {
221                 EditFontSelBox *sb = &ef->selboxes[i];
222
223                 float selboxw;
224                 if (i + 1 != ef->selboxes_len) {
225                         if (ef->selboxes[i + 1].y == sb->y)
226                                 selboxw = ef->selboxes[i + 1].x - sb->x;
227                         else
228                                 selboxw = sb->w;
229                 }
230                 else {
231                         selboxw = sb->w;
232                 }
233                 /* NOTE: v2_quad_corners_to_mat4 don't need the 3rd corner. */
234                 if (sb->rot == 0.0f) {
235                         copy_v2_fl2(box[0], sb->x, sb->y);
236                         copy_v2_fl2(box[1], sb->x + selboxw, sb->y);
237                         copy_v2_fl2(box[3], sb->x, sb->y + sb->h);
238                 }
239                 else {
240                         float mat[2][2];
241                         angle_to_mat2(mat, sb->rot);
242                         copy_v2_fl2(box[0], sb->x, sb->y);
243                         mul_v2_v2fl(box[1], mat[0], selboxw);
244                         add_v2_v2(box[1], &sb->x);
245                         mul_v2_v2fl(box[3], mat[1], sb->h);
246                         add_v2_v2(box[3], &sb->x);
247                 }
248                 v2_quad_corners_to_mat4(box, final_mat);
249                 mul_m4_m4m4(final_mat, ob->obmat, final_mat);
250
251                 DRW_shgroup_call_add(stl->g_data->overlay_select_shgrp, geom, final_mat);
252         }
253 }
254
255 static void edit_text_cache_populate_cursor(void *vedata, Object *ob)
256 {
257         EDIT_TEXT_StorageList *stl = ((EDIT_TEXT_Data *)vedata)->stl;
258         const Curve *cu = ob->data;
259         EditFont *edit_font = cu->editfont;
260         float (*cursor)[2] = edit_font->textcurs;
261         float mat[4][4];
262
263         v2_quad_corners_to_mat4(cursor, mat);
264         mul_m4_m4m4(mat, ob->obmat, mat);
265
266         struct GPUBatch *geom = DRW_cache_quad_get();
267         DRW_shgroup_call_add(stl->g_data->overlay_cursor_shgrp, geom, mat);
268 }
269
270 static void edit_text_cache_populate_boxes(void *vedata, Object *ob)
271 {
272         EDIT_TEXT_StorageList *stl = ((EDIT_TEXT_Data *)vedata)->stl;
273         const Curve *cu = ob->data;
274
275         DRWShadingGroup *shading_groups[] = {
276             stl->g_data->box_active_shgrp,
277             stl->g_data->box_shgrp,
278         };
279
280         float vec[3], vec1[3], vec2[3];
281         for (int i = 0; i < cu->totbox; i++) {
282                 TextBox *tb = &cu->tb[i];
283
284                 if ((tb->w == 0.0f) && (tb->h == 0.0f)) {
285                         continue;
286                 }
287
288                 const bool is_active = i == (cu->actbox - 1);
289                 DRWShadingGroup *shading_group = shading_groups[is_active ? 0 : 1];
290
291                 vec[0] = cu->xof + tb->x;
292                 vec[1] = cu->yof + tb->y + cu->fsize_realtime;
293                 vec[2] = 0.001;
294
295                 mul_v3_m4v3(vec1, ob->obmat, vec);
296                 vec[0] += tb->w;
297                 mul_v3_m4v3(vec2, ob->obmat, vec);
298
299                 DRW_shgroup_call_dynamic_add(shading_group, vec1);
300                 DRW_shgroup_call_dynamic_add(shading_group, vec2);
301
302                 vec[1] -= tb->h;
303                 copy_v3_v3(vec1, vec2);
304                 mul_v3_m4v3(vec2, ob->obmat, vec);
305
306                 DRW_shgroup_call_dynamic_add(shading_group, vec1);
307                 DRW_shgroup_call_dynamic_add(shading_group, vec2);
308
309                 vec[0] -= tb->w;
310                 copy_v3_v3(vec1, vec2);
311                 mul_v3_m4v3(vec2, ob->obmat, vec);
312
313                 DRW_shgroup_call_dynamic_add(shading_group, vec1);
314                 DRW_shgroup_call_dynamic_add(shading_group, vec2);
315
316                 vec[1] += tb->h;
317                 copy_v3_v3(vec1, vec2);
318                 mul_v3_m4v3(vec2, ob->obmat, vec);
319
320                 DRW_shgroup_call_dynamic_add(shading_group, vec1);
321                 DRW_shgroup_call_dynamic_add(shading_group, vec2);
322         }
323 }
324
325 /* Add geometry to shadingGroups. Execute for each objects */
326 static void EDIT_TEXT_cache_populate(void *vedata, Object *ob)
327 {
328         EDIT_TEXT_PassList *psl = ((EDIT_TEXT_Data *)vedata)->psl;
329         EDIT_TEXT_StorageList *stl = ((EDIT_TEXT_Data *)vedata)->stl;
330         const DRWContextState *draw_ctx = DRW_context_state_get();
331
332         UNUSED_VARS(psl, stl);
333
334         if (ob->type == OB_FONT) {
335                 if (ob == draw_ctx->object_edit) {
336                         const Curve *cu = ob->data;
337                         /* Get geometry cache */
338                         struct GPUBatch *geom;
339
340                         if (cu->flag & CU_FAST) {
341                                 geom = DRW_cache_text_edge_wire_get(ob);
342                                 if (geom) {
343                                         DRW_shgroup_call_add(stl->g_data->wire_shgrp, geom, ob->obmat);
344                                 }
345                         }
346                         else {
347                                 /* object mode draws */
348                         }
349
350                         edit_text_cache_populate_select(vedata, ob);
351                         edit_text_cache_populate_cursor(vedata, ob);
352                         edit_text_cache_populate_boxes(vedata, ob);
353                 }
354         }
355 }
356
357 /* Optional: Post-cache_populate callback */
358 static void EDIT_TEXT_cache_finish(void *vedata)
359 {
360         EDIT_TEXT_PassList *psl = ((EDIT_TEXT_Data *)vedata)->psl;
361         EDIT_TEXT_StorageList *stl = ((EDIT_TEXT_Data *)vedata)->stl;
362
363         /* Do something here! dependent on the objects gathered */
364         UNUSED_VARS(psl, stl);
365 }
366
367 /* Draw time ! Control rendering pipeline from here */
368 static void EDIT_TEXT_draw_scene(void *vedata)
369 {
370         EDIT_TEXT_PassList *psl = ((EDIT_TEXT_Data *)vedata)->psl;
371         EDIT_TEXT_FramebufferList *fbl = ((EDIT_TEXT_Data *)vedata)->fbl;
372
373         /* Default framebuffer and texture */
374         DefaultFramebufferList *dfbl = DRW_viewport_framebuffer_list_get();
375         DefaultTextureList *dtxl = DRW_viewport_texture_list_get();
376
377         UNUSED_VARS(fbl, dfbl, dtxl);
378
379         /* Show / hide entire passes, swap framebuffers ... whatever you fancy */
380         /*
381          * DRW_framebuffer_texture_detach(dtxl->depth);
382          * DRW_framebuffer_bind(fbl->custom_fb);
383          * DRW_draw_pass(psl->pass);
384          * DRW_framebuffer_texture_attach(dfbl->default_fb, dtxl->depth, 0, 0);
385          * DRW_framebuffer_bind(dfbl->default_fb);
386          */
387
388         DRW_draw_pass(psl->wire_pass);
389
390         if (!DRW_pass_is_empty(psl->text_box_pass)) {
391                 DRW_draw_pass(psl->text_box_pass);
392         }
393
394         set_inverted_drawing(1);
395         DRW_draw_pass(psl->overlay_select_pass);
396         DRW_draw_pass(psl->overlay_cursor_pass);
397         set_inverted_drawing(0);
398
399         /* If you changed framebuffer, double check you rebind
400          * the default one with its textures attached before finishing */
401 }
402
403 /* Cleanup when destroying the engine.
404  * This is not per viewport ! only when quitting blender.
405  * Mostly used for freeing shaders */
406 static void EDIT_TEXT_engine_free(void)
407 {
408         // DRW_SHADER_FREE_SAFE(custom_shader);
409 }
410
411 static const DrawEngineDataSize EDIT_TEXT_data_size = DRW_VIEWPORT_DATA_SIZE(EDIT_TEXT_Data);
412
413 DrawEngineType draw_engine_edit_text_type = {
414         NULL, NULL,
415         N_("EditTextMode"),
416         &EDIT_TEXT_data_size,
417         &EDIT_TEXT_engine_init,
418         &EDIT_TEXT_engine_free,
419         &EDIT_TEXT_cache_init,
420         &EDIT_TEXT_cache_populate,
421         &EDIT_TEXT_cache_finish,
422         NULL, /* draw_background but not needed by mode engines */
423         &EDIT_TEXT_draw_scene,
424         NULL,
425         NULL,
426 };