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