Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / editors / gizmo_library / gizmo_library_utils.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) 2015 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file \ingroup edgizmolib
21  *
22  * \name Gizmo Library Utilities
23  *
24  * \brief This file contains functions for common behaviors of gizmos.
25  */
26
27 #include "BLI_math.h"
28
29 #include "DNA_view3d_types.h"
30 #include "DNA_screen_types.h"
31
32 #include "BKE_context.h"
33
34 #include "RNA_access.h"
35
36 #include "WM_api.h"
37 #include "WM_types.h"
38
39 #include "ED_view3d.h"
40
41 /* own includes */
42 #include "gizmo_library_intern.h"
43
44 /* factor for precision tweaking */
45 #define GIZMO_PRECISION_FAC 0.05f
46
47
48 BLI_INLINE float gizmo_offset_from_value_constr(
49         const float range_fac, const float min, const float range, const float value,
50         const bool inverted)
51 {
52         return inverted ? (range_fac * (min + range - value) / range) : (range_fac * (value / range));
53 }
54
55 BLI_INLINE float gizmo_value_from_offset_constr(
56         const float range_fac, const float min, const float range, const float value,
57         const bool inverted)
58 {
59         return inverted ? (min + range - (value * range / range_fac)) : (value * range / range_fac);
60 }
61
62 float gizmo_offset_from_value(
63         GizmoCommonData *data, const float value, const bool constrained, const bool inverted)
64 {
65         if (constrained)
66                 return gizmo_offset_from_value_constr(data->range_fac, data->min, data->range, value, inverted);
67
68         return value;
69 }
70
71 float gizmo_value_from_offset(
72         GizmoCommonData *data, GizmoInteraction *inter, const float offset,
73         const bool constrained, const bool inverted, const bool use_precision)
74 {
75         const float max = data->min + data->range;
76
77         if (use_precision) {
78                 /* add delta offset of this step to total precision_offset */
79                 inter->precision_offset += offset - inter->prev_offset;
80         }
81         inter->prev_offset = offset;
82
83         float ofs_new = inter->init_offset + offset - inter->precision_offset * (1.0f - GIZMO_PRECISION_FAC);
84         float value;
85
86         if (constrained) {
87                 value = gizmo_value_from_offset_constr(data->range_fac, data->min, data->range, ofs_new, inverted);
88         }
89         else {
90                 value = ofs_new;
91         }
92
93         /* clamp to custom range */
94         if (data->is_custom_range_set) {
95                 CLAMP(value, data->min, max);
96         }
97
98         return value;
99 }
100
101 void gizmo_property_data_update(
102         wmGizmo *gz, GizmoCommonData *data, wmGizmoProperty *gz_prop,
103         const bool constrained, const bool inverted)
104 {
105         if (gz_prop->custom_func.value_get_fn != NULL) {
106                 /* pass  */
107         }
108         else if (gz_prop->prop != NULL) {
109                 /* pass  */
110         }
111         else {
112                 data->offset = 0.0f;
113                 return;
114         }
115
116         float value = WM_gizmo_target_property_float_get(gz, gz_prop);
117
118         if (constrained) {
119                 if (data->is_custom_range_set == false) {
120                         float range[2];
121                         if (WM_gizmo_target_property_float_range_get(gz, gz_prop, range)) {
122                                 data->range = range[1] - range[0];
123                                 data->min = range[0];
124                         }
125                         else {
126                                 BLI_assert(0);
127                         }
128                 }
129                 data->offset = gizmo_offset_from_value_constr(data->range_fac, data->min, data->range, value, inverted);
130         }
131         else {
132                 data->offset = value;
133         }
134 }
135
136 void gizmo_property_value_reset(
137         bContext *C, const wmGizmo *gz, GizmoInteraction *inter,
138         wmGizmoProperty *gz_prop)
139 {
140         WM_gizmo_target_property_float_set(C, gz, gz_prop, inter->init_value);
141 }
142
143 /* -------------------------------------------------------------------- */
144
145 void gizmo_color_get(
146         const wmGizmo *gz, const bool highlight,
147         float r_col[4])
148 {
149         if (highlight && !(gz->flag & WM_GIZMO_DRAW_HOVER)) {
150                 copy_v4_v4(r_col, gz->color_hi);
151         }
152         else {
153                 copy_v4_v4(r_col, gz->color);
154         }
155 }
156
157 /* -------------------------------------------------------------------- */
158
159 /**
160  * Takes mouse coordinates and returns them in relation to the gizmo.
161  * Both 2D & 3D supported, use so we can use 2D gizmos in the 3D view.
162  */
163 bool gizmo_window_project_2d(
164         bContext *C, const struct wmGizmo *gz, const float mval[2], int axis, bool use_offset,
165         float r_co[2])
166 {
167         float mat[4][4];
168         {
169                 float mat_identity[4][4];
170                 struct WM_GizmoMatrixParams params = {NULL};
171                 if (use_offset == false) {
172                         unit_m4(mat_identity);
173                         params.matrix_offset = mat_identity;
174                 }
175                 WM_gizmo_calc_matrix_final_params(gz, &params, mat);
176         }
177
178         /* rotate mouse in relation to the center and relocate it */
179         if (gz->parent_gzgroup->type->flag & WM_GIZMOGROUPTYPE_3D) {
180                 /* For 3d views, transform 2D mouse pos onto plane. */
181                 ARegion *ar = CTX_wm_region(C);
182
183                 float plane[4], co[3];
184                 plane_from_point_normal_v3(plane, mat[3], mat[2]);
185                 bool clip_ray = ((RegionView3D *)ar->regiondata)->is_persp;
186                 if (ED_view3d_win_to_3d_on_plane(ar, plane, mval, clip_ray, co)) {
187                         float imat[4][4];
188                         invert_m4_m4(imat, mat);
189                         mul_m4_v3(imat, co);
190                         r_co[0] = co[(axis + 1) % 3];
191                         r_co[1] = co[(axis + 2) % 3];
192                         return true;
193                 }
194                 return false;
195         }
196         else {
197                 float co[3] = {mval[0], mval[1], 0.0f};
198                 float imat[4][4];
199                 invert_m4_m4(imat, mat);
200                 mul_m4_v3(imat, co);
201                 copy_v2_v2(r_co, co);
202                 return true;
203         }
204 }
205
206 bool gizmo_window_project_3d(
207         bContext *C, const struct wmGizmo *gz, const float mval[2], bool use_offset,
208         float r_co[3])
209 {
210         float mat[4][4];
211         {
212                 float mat_identity[4][4];
213                 struct WM_GizmoMatrixParams params = {NULL};
214                 if (use_offset == false) {
215                         unit_m4(mat_identity);
216                         params.matrix_offset = mat_identity;
217                 }
218                 WM_gizmo_calc_matrix_final_params(gz, &params, mat);
219         }
220
221         if (gz->parent_gzgroup->type->flag & WM_GIZMOGROUPTYPE_3D) {
222                 View3D *v3d = CTX_wm_view3d(C);
223                 ARegion *ar = CTX_wm_region(C);
224                 /* Note: we might want a custom reference point passed in,
225                  * instead of the gizmo center. */
226                 ED_view3d_win_to_3d(v3d, ar, mat[3], mval, r_co);
227                 invert_m4(mat);
228                 mul_m4_v3(mat, r_co);
229                 return true;
230         }
231         else {
232                 float co[3] = {mval[0], mval[1], 0.0f};
233                 float imat[4][4];
234                 invert_m4_m4(imat, mat);
235                 mul_m4_v3(imat, co);
236                 copy_v2_v2(r_co, co);
237                 return true;
238         }
239 }