Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / editors / gizmo_library / gizmo_types / arrow2d_gizmo.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  * The Original Code is Copyright (C) 2016 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file \ingroup edgizmolib
21  *
22  * \name 2D Arrow Gizmo
23  *
24  * \brief Simple arrow gizmo which is dragged into a certain direction.
25  */
26
27 #include "BLI_math.h"
28
29 #include "DNA_windowmanager_types.h"
30
31 #include "BKE_context.h"
32
33
34 #include "GPU_draw.h"
35 #include "GPU_immediate.h"
36 #include "GPU_matrix.h"
37 #include "GPU_state.h"
38
39 #include "MEM_guardedalloc.h"
40
41 #include "RNA_access.h"
42 #include "RNA_define.h"
43
44 #include "WM_types.h"
45
46 #include "ED_screen.h"
47 #include "ED_gizmo_library.h"
48
49 /* own includes */
50 #include "WM_api.h"
51
52 #include "../gizmo_library_intern.h"
53
54 static void arrow2d_draw_geom(wmGizmo *gz, const float matrix[4][4], const float color[4])
55 {
56         const float size = 0.11f;
57         const float size_breadth = size / 2.0f;
58         const float size_length = size * 1.7f;
59         /* Subtract the length so the arrow fits in the hotspot. */
60         const float arrow_length = RNA_float_get(gz->ptr, "length") - size_length;
61         const float arrow_angle = RNA_float_get(gz->ptr, "angle");
62
63         uint pos = GPU_vertformat_attr_add(immVertexFormat(), "pos", GPU_COMP_F32, 2, GPU_FETCH_FLOAT);
64
65         GPU_matrix_push();
66         GPU_matrix_mul(matrix);
67         GPU_matrix_rotate_2d(RAD2DEGF(arrow_angle));
68
69         immBindBuiltinProgram(GPU_SHADER_2D_UNIFORM_COLOR);
70
71         immUniformColor4fv(color);
72
73         immBegin(GPU_PRIM_LINES, 2);
74         immVertex2f(pos, 0.0f, 0.0f);
75         immVertex2f(pos, 0.0f, arrow_length);
76         immEnd();
77
78         immBegin(GPU_PRIM_TRIS, 3);
79         immVertex2f(pos, size_breadth, arrow_length);
80         immVertex2f(pos, -size_breadth, arrow_length);
81         immVertex2f(pos, 0.0f, arrow_length + size_length);
82         immEnd();
83
84         immUnbindProgram();
85
86         GPU_matrix_pop();
87 }
88
89 static void gizmo_arrow2d_draw(const bContext *UNUSED(C), wmGizmo *gz)
90 {
91         float color[4];
92
93         float matrix_final[4][4];
94
95         gizmo_color_get(gz, gz->state & WM_GIZMO_STATE_HIGHLIGHT, color);
96
97         GPU_line_width(gz->line_width);
98
99         WM_gizmo_calc_matrix_final(gz, matrix_final);
100
101         GPU_blend(true);
102         arrow2d_draw_geom(gz, matrix_final, color);
103         GPU_blend(false);
104
105         if (gz->interaction_data) {
106                 GizmoInteraction *inter = gz->interaction_data;
107
108                 GPU_blend(true);
109                 arrow2d_draw_geom(gz, inter->init_matrix_final, (const float[4]){0.5f, 0.5f, 0.5f, 0.5f});
110                 GPU_blend(false);
111         }
112 }
113
114 static void gizmo_arrow2d_setup(wmGizmo *gz)
115 {
116         gz->flag |= WM_GIZMO_DRAW_MODAL;
117 }
118
119 static int gizmo_arrow2d_invoke(
120         bContext *UNUSED(C), wmGizmo *gz, const wmEvent *UNUSED(event))
121 {
122         GizmoInteraction *inter = MEM_callocN(sizeof(GizmoInteraction), __func__);
123
124         copy_m4_m4(inter->init_matrix_basis, gz->matrix_basis);
125         WM_gizmo_calc_matrix_final(gz, inter->init_matrix_final);
126
127         gz->interaction_data = inter;
128
129         return OPERATOR_RUNNING_MODAL;
130 }
131
132 static int gizmo_arrow2d_test_select(
133         bContext *UNUSED(C), wmGizmo *gz, const int mval[2])
134 {
135         const float mval_fl[2] = {UNPACK2(mval)};
136         const float arrow_length = RNA_float_get(gz->ptr, "length");
137         const float arrow_angle = RNA_float_get(gz->ptr, "angle");
138         const float line_len = arrow_length * gz->scale_final;
139         float mval_local[2];
140
141         copy_v2_v2(mval_local, mval_fl);
142         sub_v2_v2(mval_local, gz->matrix_basis[3]);
143
144         float line[2][2];
145         line[0][0] = line[0][1] = line[1][0] = 0.0f;
146         line[1][1] = line_len;
147
148         /* rotate only if needed */
149         if (arrow_angle != 0.0f) {
150                 float rot_point[2];
151                 copy_v2_v2(rot_point, line[1]);
152                 rotate_v2_v2fl(line[1], rot_point, arrow_angle);
153         }
154
155         /* arrow line intersection check */
156         float isect_1[2], isect_2[2];
157         const int isect = isect_line_sphere_v2(
158                 line[0], line[1], mval_local, GIZMO_HOTSPOT + gz->line_width * 0.5f,
159                 isect_1, isect_2);
160
161         if (isect > 0) {
162                 float line_ext[2][2]; /* extended line for segment check including hotspot */
163                 copy_v2_v2(line_ext[0], line[0]);
164                 line_ext[1][0] = line[1][0] + GIZMO_HOTSPOT * ((line[1][0] - line[0][0]) / line_len);
165                 line_ext[1][1] = line[1][1] + GIZMO_HOTSPOT * ((line[1][1] - line[0][1]) / line_len);
166
167                 const float lambda_1 = line_point_factor_v2(isect_1, line_ext[0], line_ext[1]);
168                 if (isect == 1) {
169                         if (IN_RANGE_INCL(lambda_1, 0.0f, 1.0f)) {
170                                 return 0;
171                         }
172                 }
173                 else {
174                         BLI_assert(isect == 2);
175                         const float lambda_2 = line_point_factor_v2(isect_2, line_ext[0], line_ext[1]);
176                         if (IN_RANGE_INCL(lambda_1, 0.0f, 1.0f) && IN_RANGE_INCL(lambda_2, 0.0f, 1.0f)) {
177                                 return 0;
178                         }
179                 }
180         }
181
182         return -1;
183 }
184
185 /* -------------------------------------------------------------------- */
186 /** \name 2D Arrow Gizmo API
187  *
188  * \{ */
189
190 static void GIZMO_GT_arrow_2d(wmGizmoType *gzt)
191 {
192         /* identifiers */
193         gzt->idname = "GIZMO_GT_arrow_2d";
194
195         /* api callbacks */
196         gzt->draw = gizmo_arrow2d_draw;
197         gzt->setup = gizmo_arrow2d_setup;
198         gzt->invoke = gizmo_arrow2d_invoke;
199         gzt->test_select = gizmo_arrow2d_test_select;
200
201         gzt->struct_size = sizeof(wmGizmo);
202
203         /* rna */
204         RNA_def_float(gzt->srna, "length", 1.0f, 0.0f, FLT_MAX, "Arrow Line Length", "", 0.0f, FLT_MAX);
205         RNA_def_float_rotation(
206                 gzt->srna, "angle", 0, NULL, DEG2RADF(-360.0f), DEG2RADF(360.0f),
207                 "Roll", "", DEG2RADF(-360.0f), DEG2RADF(360.0f));
208 }
209
210 void ED_gizmotypes_arrow_2d(void)
211 {
212         WM_gizmotype_append(GIZMO_GT_arrow_2d);
213 }
214
215 /** \} */