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