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