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