doxygen: add newline after \file
[blender.git] / source / blender / draw / intern / draw_debug.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 2018, Blender Foundation.
17  */
18
19 /** \file
20  * \ingroup draw
21  *
22  * \brief Simple API to draw debug shapes in the viewport.
23  */
24
25 #include "MEM_guardedalloc.h"
26
27 #include "DNA_object_types.h"
28
29 #include "BKE_object.h"
30
31 #include "BLI_link_utils.h"
32
33 #include "GPU_immediate.h"
34
35 #include "draw_debug.h"
36 #include "draw_manager.h"
37
38 /* --------- Register --------- */
39
40 /* Matrix applied to all points before drawing. Could be a stack if needed. */
41 static float g_modelmat[4][4];
42
43 void DRW_debug_modelmat_reset(void)
44 {
45         unit_m4(g_modelmat);
46 }
47
48 void DRW_debug_modelmat(const float modelmat[4][4])
49 {
50         copy_m4_m4(g_modelmat, modelmat);
51 }
52
53 void DRW_debug_line_v3v3(const float v1[3], const float v2[3], const float color[4])
54 {
55         DRWDebugLine *line = MEM_mallocN(sizeof(DRWDebugLine), "DRWDebugLine");
56         mul_v3_m4v3(line->pos[0], g_modelmat, v1);
57         mul_v3_m4v3(line->pos[1], g_modelmat, v2);
58         copy_v4_v4(line->color, color);
59         BLI_LINKS_PREPEND(DST.debug.lines, line);
60 }
61
62 void DRW_debug_polygon_v3(const float (*v)[3], const int vert_len, const float color[4])
63 {
64         BLI_assert(vert_len > 1);
65
66         for (int i = 0; i < vert_len; ++i) {
67                 DRW_debug_line_v3v3(v[i], v[(i + 1) % vert_len], color);
68         }
69 }
70
71 /* NOTE: g_modelmat is still applied on top. */
72 void DRW_debug_m4(const float m[4][4])
73 {
74         float v0[3] = {0.0f, 0.0f, 0.0f};
75         float v1[3] = {1.0f, 0.0f, 0.0f};
76         float v2[3] = {0.0f, 1.0f, 0.0f};
77         float v3[3] = {0.0f, 0.0f, 1.0f};
78
79         mul_m4_v3(m, v0);
80         mul_m4_v3(m, v1);
81         mul_m4_v3(m, v2);
82         mul_m4_v3(m, v3);
83
84         DRW_debug_line_v3v3(v0, v1, (float[4]){1.0f, 0.0f, 0.0f, 1.0f});
85         DRW_debug_line_v3v3(v0, v2, (float[4]){0.0f, 1.0f, 0.0f, 1.0f});
86         DRW_debug_line_v3v3(v0, v3, (float[4]){0.0f, 0.0f, 1.0f, 1.0f});
87 }
88
89 void DRW_debug_bbox(const BoundBox *bbox, const float color[4])
90 {
91         DRW_debug_line_v3v3(bbox->vec[0], bbox->vec[1], color);
92         DRW_debug_line_v3v3(bbox->vec[1], bbox->vec[2], color);
93         DRW_debug_line_v3v3(bbox->vec[2], bbox->vec[3], color);
94         DRW_debug_line_v3v3(bbox->vec[3], bbox->vec[0], color);
95
96         DRW_debug_line_v3v3(bbox->vec[4], bbox->vec[5], color);
97         DRW_debug_line_v3v3(bbox->vec[5], bbox->vec[6], color);
98         DRW_debug_line_v3v3(bbox->vec[6], bbox->vec[7], color);
99         DRW_debug_line_v3v3(bbox->vec[7], bbox->vec[4], color);
100
101         DRW_debug_line_v3v3(bbox->vec[0], bbox->vec[4], color);
102         DRW_debug_line_v3v3(bbox->vec[1], bbox->vec[5], color);
103         DRW_debug_line_v3v3(bbox->vec[2], bbox->vec[6], color);
104         DRW_debug_line_v3v3(bbox->vec[3], bbox->vec[7], color);
105 }
106
107 void DRW_debug_m4_as_bbox(const float m[4][4], const float color[4], const bool invert)
108 {
109         BoundBox bb;
110         const float min[3] = {-1.0f, -1.0f, -1.0f}, max[3] = {1.0f, 1.0f, 1.0f};
111         float project_matrix[4][4];
112         if (invert) {
113                 invert_m4_m4(project_matrix, m);
114         }
115         else {
116                 copy_m4_m4(project_matrix, m);
117         }
118
119         BKE_boundbox_init_from_minmax(&bb, min, max);
120         for (int i = 0; i < 8; ++i) {
121                 mul_project_m4_v3(project_matrix, bb.vec[i]);
122         }
123         DRW_debug_bbox(&bb, color);
124 }
125
126 void DRW_debug_sphere(const float center[3], const float radius, const float color[4])
127 {
128         float size_mat[4][4];
129         DRWDebugSphere *sphere = MEM_mallocN(sizeof(DRWDebugSphere), "DRWDebugSphere");
130         /* Bake all transform into a Matrix4 */
131         scale_m4_fl(size_mat, radius);
132         copy_m4_m4(sphere->mat, g_modelmat);
133         translate_m4(sphere->mat, center[0], center[1], center[2]);
134         mul_m4_m4m4(sphere->mat, sphere->mat, size_mat);
135
136         copy_v4_v4(sphere->color, color);
137         BLI_LINKS_PREPEND(DST.debug.spheres, sphere);
138 }
139
140 /* --------- Render --------- */
141
142 static void drw_debug_draw_lines(void)
143 {
144         int count = BLI_linklist_count((LinkNode *)DST.debug.lines);
145
146         if (count == 0) {
147                 return;
148         }
149
150         GPUVertFormat *vert_format = immVertexFormat();
151         uint pos = GPU_vertformat_attr_add(vert_format, "pos", GPU_COMP_F32, 3, GPU_FETCH_FLOAT);
152         uint col = GPU_vertformat_attr_add(vert_format, "color", GPU_COMP_F32, 4, GPU_FETCH_FLOAT);
153
154         immBindBuiltinProgram(GPU_SHADER_3D_FLAT_COLOR);
155
156         immBegin(GPU_PRIM_LINES, count * 2);
157
158         while (DST.debug.lines) {
159                 void *next = DST.debug.lines->next;
160
161                 immAttr4fv(col, DST.debug.lines->color);
162                 immVertex3fv(pos, DST.debug.lines->pos[0]);
163
164                 immAttr4fv(col, DST.debug.lines->color);
165                 immVertex3fv(pos, DST.debug.lines->pos[1]);
166
167                 MEM_freeN(DST.debug.lines);
168                 DST.debug.lines = next;
169         }
170         immEnd();
171
172         immUnbindProgram();
173 }
174
175 static void drw_debug_draw_spheres(void)
176 {
177         int count = BLI_linklist_count((LinkNode *)DST.debug.spheres);
178
179         if (count == 0) {
180                 return;
181         }
182
183         float one = 1.0f;
184         GPUVertFormat vert_format = {0};
185         uint mat = GPU_vertformat_attr_add(&vert_format, "InstanceModelMatrix", GPU_COMP_F32, 16, GPU_FETCH_FLOAT);
186         uint col = GPU_vertformat_attr_add(&vert_format, "color", GPU_COMP_F32, 3, GPU_FETCH_FLOAT);
187         uint siz = GPU_vertformat_attr_add(&vert_format, "size", GPU_COMP_F32, 1, GPU_FETCH_FLOAT);
188
189         GPUVertBuf *inst_vbo = GPU_vertbuf_create_with_format(&vert_format);
190
191         GPU_vertbuf_data_alloc(inst_vbo, count);
192
193         int v = 0;
194         while (DST.debug.spheres) {
195                 void *next = DST.debug.spheres->next;
196
197                 GPU_vertbuf_attr_set(inst_vbo, mat, v, DST.debug.spheres->mat[0]);
198                 GPU_vertbuf_attr_set(inst_vbo, col, v, DST.debug.spheres->color);
199                 GPU_vertbuf_attr_set(inst_vbo, siz, v, &one);
200                 v++;
201
202                 MEM_freeN(DST.debug.spheres);
203                 DST.debug.spheres = next;
204         }
205
206         GPUBatch *empty_sphere = DRW_cache_empty_sphere_get();
207
208         GPUBatch *draw_batch = GPU_batch_create(GPU_PRIM_LINES, empty_sphere->verts[0], NULL);
209         GPU_batch_instbuf_set(draw_batch, inst_vbo, true);
210         GPU_batch_program_set_builtin(draw_batch, GPU_SHADER_INSTANCE_VARIYING_COLOR_VARIYING_SIZE);
211
212         GPU_batch_draw(draw_batch);
213         GPU_batch_discard(draw_batch);
214 }
215
216 void drw_debug_draw(void)
217 {
218         drw_debug_draw_lines();
219         drw_debug_draw_spheres();
220 }
221
222 void drw_debug_init(void)
223 {
224         DRW_debug_modelmat_reset();
225 }