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