doxygen: add newline after \file
[blender.git] / source / blender / editors / gizmo_library / gizmo_types / value2d_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
17 /** \file
18  * \ingroup edgizmolib
19  *
20  * \name Value Gizmo
21  *
22  * \brief Gizmo that can be used to click and drag a value.
23  *
24  * Use this in cases where it may be useful to have a tool,
25  * but the tool doesn't relate to an on-screen handle.
26  * eg: smooth or randomize.
27  *
28  * Exactly how this maps X/Y axis, and draws - may change.
29  * The purpose here is to avoid having to write custom modal handlers for each operator.
30  *
31  * So we can use a single gizmo to make redoing an operator seem modal.
32  */
33
34 #include <float.h>
35 #include <math.h>
36
37 #include "MEM_guardedalloc.h"
38
39 #include "BKE_context.h"
40 #include "BLI_string.h"
41
42 #include "ED_screen.h"
43 #include "ED_gizmo_library.h"
44
45 #include "WM_types.h"
46 #include "WM_api.h"
47
48 /* own includes */
49 #include "../gizmo_geometry.h"
50 #include "../gizmo_library_intern.h"
51
52 /* -------------------------------------------------------------------- */
53 /** \name Value Gizmo
54  *
55  * \{ */
56
57 typedef struct ValueInteraction {
58         struct {
59                 float mval[2];
60                 float prop_value;
61         } init;
62         struct {
63                 float prop_value;
64                 eWM_GizmoFlagTweak tweak_flag;
65         } prev;
66         float range[2];
67 } ValueInteraction;
68
69 static void gizmo_value_draw(const bContext *UNUSED(C), wmGizmo *UNUSED(gz))
70 {
71         /* pass */
72 }
73
74 static int gizmo_value_modal(
75         bContext *C, wmGizmo *gz, const wmEvent *event,
76         eWM_GizmoFlagTweak tweak_flag)
77 {
78         ValueInteraction *inter = gz->interaction_data;
79         if ((event->type != MOUSEMOVE) && (inter->prev.tweak_flag == tweak_flag)) {
80                 return OPERATOR_RUNNING_MODAL;
81         }
82         ARegion *ar = CTX_wm_region(C);
83         const float value_scale = 4.0f;  /* Could be option. */
84         const float value_range = inter->range[1] - inter->range[0];
85         float value_delta = (
86                 inter->init.prop_value +
87                 (((event->mval[0] - inter->init.mval[0]) / ar->winx) * value_range)) * value_scale;
88
89
90         if (tweak_flag & WM_GIZMO_TWEAK_SNAP) {
91                 const double snap = 0.1;
92                 value_delta = (float)roundf((double)value_delta / snap) * snap;
93
94         }
95         if (tweak_flag & WM_GIZMO_TWEAK_PRECISE) {
96                 value_delta *= 0.1f;
97         }
98         const float value_final = inter->init.prop_value + value_delta;
99
100         if (value_final != inter->prev.prop_value) {
101                 /* set the property for the operator and call its modal function */
102                 wmGizmoProperty *gz_prop = WM_gizmo_target_property_find(gz, "offset");
103                 if (WM_gizmo_target_property_is_valid(gz_prop)) {
104                         WM_gizmo_target_property_float_set(C, gz, gz_prop, value_final);
105                 }
106
107                 {
108                         ScrArea *sa = CTX_wm_area(C);
109                         char str[64];
110                         SNPRINTF(str, "%.4f", value_final);
111                         ED_area_status_text(sa, str);
112                 }
113         }
114
115         inter->prev.prop_value = value_final;
116         inter->prev.tweak_flag = tweak_flag;
117
118         return OPERATOR_RUNNING_MODAL;
119 }
120
121
122 static int gizmo_value_invoke(
123         bContext *UNUSED(C), wmGizmo *gz, const wmEvent *event)
124 {
125         ValueInteraction *inter = MEM_callocN(sizeof(ValueInteraction), __func__);
126
127         inter->init.mval[0] = event->mval[0];
128         inter->init.mval[1] = event->mval[1];
129         inter->prev.prop_value = -FLT_MAX;
130
131         wmGizmoProperty *gz_prop = WM_gizmo_target_property_find(gz, "offset");
132         if (WM_gizmo_target_property_is_valid(gz_prop)) {
133                 inter->init.prop_value = WM_gizmo_target_property_float_get(gz, gz_prop);
134                 if (!WM_gizmo_target_property_float_range_get(gz, gz_prop, inter->range)) {
135                         inter->range[0] = 0.0f;
136                         inter->range[1] = 1.0f;
137                 }
138         }
139
140         gz->interaction_data = inter;
141
142         return OPERATOR_RUNNING_MODAL;
143 }
144
145 static void gizmo_value_exit(bContext *C, wmGizmo *gz, const bool cancel)
146 {
147         ScrArea *sa = CTX_wm_area(C);
148         ED_area_status_text(sa, NULL);
149         if (cancel) {
150                 ValueInteraction *inter = gz->interaction_data;
151                 wmGizmoProperty *gz_prop = WM_gizmo_target_property_find(gz, "offset");
152                 if (WM_gizmo_target_property_is_valid(gz_prop)) {
153                         WM_gizmo_target_property_float_set(C, gz, gz_prop, inter->init.prop_value);
154                 }
155         }
156 }
157
158 static int gizmo_value_test_select(
159         bContext *UNUSED(C), wmGizmo *UNUSED(gz), const int UNUSED(mval[2]))
160 {
161         return 0;
162 }
163
164 /** \} */
165
166 /* -------------------------------------------------------------------- */
167 /** \name Value Gizmo API
168  *
169  * \{ */
170
171 static void GIZMO_GT_value_2d(wmGizmoType *gzt)
172 {
173         /* identifiers */
174         gzt->idname = "GIZMO_GT_value_2d";
175
176         /* api callbacks */
177         gzt->draw = gizmo_value_draw;
178         gzt->invoke = gizmo_value_invoke;
179         gzt->exit = gizmo_value_exit;
180         gzt->modal = gizmo_value_modal;
181         gzt->test_select = gizmo_value_test_select;
182
183         gzt->struct_size = sizeof(wmGizmo);
184
185         WM_gizmotype_target_property_def(gzt, "offset", PROP_FLOAT, 1);
186         /* Options: relative / absolute */
187 }
188
189 void ED_gizmotypes_value_2d(void)
190 {
191         WM_gizmotype_append(GIZMO_GT_value_2d);
192 }
193
194 /** \} */