Blender V5.3
snap3d_gizmo.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2020 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
14
15#include "BLI_math_vector_c.hh"
16
17#include "BKE_context.hh"
18#include "BKE_screen.hh"
19
20#include "ED_gizmo_library.hh"
21#include "ED_screen.hh"
22#include "ED_view3d.hh"
23
24#include "RNA_access.hh"
25#include "RNA_define.hh"
26#include "RNA_prototypes.hh"
27
28#include "WM_api.hh"
29
30/* own includes */
32
33namespace blender {
34
40
41/* -------------------------------------------------------------------- */
44
50
52{
53 V3DSnapCursorState *snap_state = (reinterpret_cast<SnapGizmo3D *>(gz))->snap_state;
54 snap_state->flag |= eV3DSnapCursor(flag);
55}
56
58{
60 return snap_data->is_enabled;
61}
62
64 wmGizmo *gz,
65 float r_loc[3],
66 float r_nor[3],
67 int r_elem_index[3],
68 eSnapMode *r_snap_elem)
69{
70 if (C) {
71 /* Snap values are updated too late at the cursor. Be sure to update ahead of time. */
72 const wmEvent *event = CTX_wm_window(C)->runtime->eventstate;
73 if (event) {
74 ARegion *region = CTX_wm_region(C);
75 const int2 mval = {
76 event->xy[0] - region->winrct.xmin,
77 event->xy[1] - region->winrct.ymin,
78 };
79 SnapGizmo3D *snap_gizmo = reinterpret_cast<SnapGizmo3D *>(gz);
80 ED_view3d_cursor_snap_data_update(snap_gizmo->snap_state, C, region, mval);
81 }
82 }
83
85
86 if (r_loc) {
87 copy_v3_v3(r_loc, snap_data->loc);
88 }
89 if (r_nor) {
90 copy_v3_v3(r_nor, snap_data->nor);
91 }
92 if (r_elem_index) {
93 copy_v3_v3_int(r_elem_index, snap_data->elem_index);
94 }
95 if (r_snap_elem) {
96 *r_snap_elem = snap_data->type_target;
97 }
98}
99
101
102/* -------------------------------------------------------------------- */
105
107{
108 return reinterpret_cast<SnapGizmo3D *>(gizmo_find_from_properties(
109 static_cast<const IDProperty *>(ptr->data), SPACE_VIEW3D, RGN_TYPE_WINDOW));
110}
111
113{
114 SnapGizmo3D *snap_gizmo = gizmo_snap_rna_find_operator(ptr);
115 if (snap_gizmo) {
116 return snap_gizmo->snap_state;
117 }
118
120}
121
122static void gizmo_snap_rna_prevpoint_get_fn(PointerRNA *ptr, PropertyRNA * /*prop*/, float *values)
123{
125 if (snap_state->prevpoint) {
126 copy_v3_v3(values, snap_state->prevpoint);
127 }
128}
129
131 PropertyRNA * /*prop*/,
132 const float *values)
133{
136}
137
139 PropertyRNA * /*prop*/,
140 float *values)
141{
143 copy_v3_v3(values, snap_data->loc);
144}
145
147 PropertyRNA * /*prop*/,
148 const float *values)
149{
151 copy_v3_v3(snap_data->loc, values);
152}
153
155 PropertyRNA * /*prop*/,
156 float *values)
157{
159 copy_v3_v3(values, snap_data->nor);
160}
161
163 PropertyRNA * /*prop*/,
164 int *values)
165{
167 copy_v3_v3_int(values, snap_data->elem_index);
168}
169
171{
173 return int(snap_data->type_source);
174}
175
177 PropertyRNA * /*prop*/,
178 const int value)
179{
181 snap_data->type_source = eSnapMode(value);
182}
183
185
186/* -------------------------------------------------------------------- */
189
190static void snap_cursor_free(SnapGizmo3D *snap_gizmo)
191{
192 if (snap_gizmo->snap_state) {
193 snap_gizmo->snap_state_stored = *snap_gizmo->snap_state;
195 snap_gizmo->snap_state = nullptr;
196 }
197}
198
199/* XXX: Delayed snap cursor removal. */
200static bool snap_cursor_poll(ARegion *region, void *data)
201{
202 SnapGizmo3D *snap_gizmo = static_cast<SnapGizmo3D *>(data);
203 if (!(snap_gizmo->gizmo.state & WM_GIZMO_STATE_HIGHLIGHT) &&
204 !(snap_gizmo->gizmo.flag & WM_GIZMO_DRAW_VALUE))
205 {
206 return false;
207 }
208
209 if (snap_gizmo->gizmo.flag & WM_GIZMO_HIDDEN) {
210 snap_cursor_free(snap_gizmo);
211 return false;
212 }
213
215 snap_gizmo->gizmo.parent_gzgroup->type))
216 {
217 /* Wrong viewport. */
218 snap_cursor_free(snap_gizmo);
219 return false;
220 }
221 return true;
222}
223
225
226/* -------------------------------------------------------------------- */
229
230static void snap_gizmo_setup(wmGizmo *gz)
231{
233
234 SnapGizmo3D *snap_gizmo = reinterpret_cast<SnapGizmo3D *>(gz);
236 snap_gizmo->snap_state->draw_point = true;
237 snap_gizmo->snap_state->draw_plane = false;
238 snap_gizmo->snap_state->poll = snap_cursor_poll;
239 snap_gizmo->snap_state->poll_data = snap_gizmo;
240
241 snap_gizmo->snap_state_stored = *snap_gizmo->snap_state;
242}
243
244static void snap_gizmo_draw(const bContext * /*C*/, wmGizmo *gz)
245{
246 SnapGizmo3D *snap_gizmo = reinterpret_cast<SnapGizmo3D *>(gz);
247 if (snap_gizmo->snap_state == nullptr) {
249 *snap_gizmo->snap_state = snap_gizmo->snap_state_stored;
250 }
251
252 /* All drawing is handled at the paint cursor.
253 * Therefore, make sure that the #V3DSnapCursorState is the one of the gizmo being drawn. */
255}
256
257static int snap_gizmo_test_select(bContext *C, wmGizmo *gz, const int mval[2])
258{
259 SnapGizmo3D *snap_gizmo = reinterpret_cast<SnapGizmo3D *>(gz);
260 const ARegion *region = CTX_wm_region(C);
261
262 /* Snap values are updated too late at the cursor. Be sure to update ahead of time. */
263 int2 mval_copy;
264 {
265 const wmEvent *event = CTX_wm_window(C)->runtime->eventstate;
266 if (event) {
267 mval_copy = {
268 event->xy[0] - region->winrct.xmin,
269 event->xy[1] - region->winrct.ymin,
270 };
271 }
272 else {
273 mval_copy = mval;
274 }
275 }
276 ED_view3d_cursor_snap_data_update(snap_gizmo->snap_state, C, region, mval_copy);
278
279 if (snap_data->type_target != SCE_SNAP_TO_NONE) {
280 return 0;
281 }
282 return -1;
283}
284
286 wmGizmo * /*gz*/,
287 const wmEvent * /*event*/,
288 eWM_GizmoFlagTweak /*tweak_flag*/)
289{
291}
292
294 wmGizmo * /*gz*/,
295 const wmEvent * /*event*/)
296{
298}
299
300static void snap_gizmo_free(wmGizmo *gz)
301{
302 snap_cursor_free(reinterpret_cast<SnapGizmo3D *>(gz));
303}
304
306{
307 /* identifiers */
308 gzt->idname = "GIZMO_GT_snap_3d";
309
310 /* API callbacks. */
311 gzt->setup = snap_gizmo_setup;
312 gzt->draw = snap_gizmo_draw;
314 gzt->modal = snap_gizmo_modal;
316 gzt->free = snap_gizmo_free;
317
318 gzt->struct_size = sizeof(SnapGizmo3D);
319
321 {
322 /* Get Snap Element Items enum. */
323 bool free;
324 PointerRNA toolsettings_ptr = RNA_pointer_create_discrete(nullptr, RNA_ToolSettings, nullptr);
325 PropertyRNA *prop = RNA_struct_find_property(&toolsettings_ptr, "snap_elements");
327 nullptr, &toolsettings_ptr, prop, &rna_enum_snap_element_items, nullptr, &free);
328
329 BLI_assert(free == false);
330 }
331
332 /* Setup. */
333 PropertyRNA *prop;
334 prop = RNA_def_float_array(gzt->srna,
335 "prev_point",
336 3,
337 nullptr,
338 FLT_MIN,
339 FLT_MAX,
340 "Previous Point",
341 "Point that defines the location of the perpendicular snap",
342 FLT_MIN,
343 FLT_MAX);
347 nullptr,
348 nullptr,
349 nullptr);
350
351 /* Returns. */
353 "location",
354 3,
355 nullptr,
356 FLT_MIN,
357 FLT_MAX,
358 "Location",
359 "Snap Point Location",
360 FLT_MIN,
361 FLT_MAX);
365 nullptr,
366 nullptr,
367 nullptr);
368
369 prop = RNA_def_float_vector_xyz(gzt->srna,
370 "normal",
371 3,
372 nullptr,
373 FLT_MIN,
374 FLT_MAX,
375 "Normal",
376 "Snap Point Normal",
377 FLT_MIN,
378 FLT_MAX);
380 prop, gizmo_snap_rna_normal_get_fn, nullptr, nullptr, nullptr, nullptr);
381
382 prop = RNA_def_int_vector(gzt->srna,
383 "snap_elem_index",
384 3,
385 nullptr,
386 INT_MIN,
387 INT_MAX,
388 "Snap Element",
389 "Array index of face, edge and vert snapped",
390 INT_MIN,
391 INT_MAX);
393 prop, gizmo_snap_rna_snap_elem_index_get_fn, nullptr, nullptr, nullptr, nullptr);
394
395 prop = RNA_def_enum(gzt->srna,
396 "snap_source_type",
399 "Snap Source Type",
400 "Snap Source type (influences drawing)");
404 nullptr,
405 nullptr,
406 nullptr);
407}
408
413
415
416} // namespace blender
#define C
Definition RandGen.cpp:29
#define FLT_MAX
#define FLT_MIN
#define INT_MAX
void free(Subdiv *subdiv)
Definition subdiv.cc:192
BMesh Iterators.
BLI_assert(slot->slot_subtype.map==BMO_OP_SLOT_SUBTYPE_MAP_FLT)
static void gizmo_snap_rna_prevpoint_set_fn(PointerRNA *ptr, PropertyRNA *, const float *values)
static int gizmo_snap_rna_snap_source_type_get_fn(PointerRNA *, PropertyRNA *)
PropertyRNA * RNA_struct_find_property(PointerRNA *ptr, const char *identifier)
V3DSnapCursorState * ED_view3d_cursor_snap_state_create()
MINLINE void copy_v3_v3(float r[3], const float a[3])
void ED_gizmotypes_snap_3d_data_get(const bContext *C, wmGizmo *gz, float r_loc[3], float r_nor[3], int r_elem_index[3], eSnapMode *r_snap_elem)
void WM_gizmotype_append(void(*gtfunc)(wmGizmoType *))
V3DSnapCursorState * ED_view3d_cursor_snap_state_active_get()
PropertyRNA * RNA_def_float_array(StructOrFunctionRNA *cont_, const char *identifier, const int len, const float *default_value, const float hardmin, const float hardmax, const char *ui_name, const char *ui_description, const float softmin, const float softmax)
static wmOperatorStatus snap_gizmo_invoke(bContext *, wmGizmo *, const wmEvent *)
void ED_gizmotypes_snap_3d_flag_set(wmGizmo *gz, int flag)
static bool snap_cursor_poll(ARegion *region, void *data)
MINLINE void copy_v3_v3_int(int r[3], const int a[3])
static void snap_gizmo_setup(wmGizmo *gz)
void RNA_property_enum_items(bContext *C, PointerRNA *ptr, PropertyRNA *prop, const EnumPropertyItem **r_item, int *r_totitem, bool *r_free)
PropertyRNA * RNA_def_enum(StructOrFunctionRNA *cont_, const char *identifier, const EnumPropertyItem *items, const int default_value, const char *ui_name, const char *ui_description)
PropertyRNA * RNA_def_int_vector(StructOrFunctionRNA *cont_, const char *identifier, const int len, const int *default_value, const int hardmin, const int hardmax, const char *ui_name, const char *ui_description, const int softmin, const int softmax)
bool ED_gizmotypes_snap_3d_is_enabled(const wmGizmo *)
wmWindow * CTX_wm_window(const bContext *C)
PropertyRNA * RNA_def_float_translation(StructOrFunctionRNA *cont_, const char *identifier, const int len, const float *default_value, const float hardmin, const float hardmax, const char *ui_name, const char *ui_description, const float softmin, const float softmax)
static V3DSnapCursorState * gizmo_snap_state_from_rna_get(PointerRNA *ptr)
V3DSnapCursorData * ED_view3d_cursor_snap_data_get()
static void gizmo_snap_rna_location_get_fn(PointerRNA *, PropertyRNA *, float *values)
void RNA_def_property_float_array_funcs_runtime(PropertyRNA *prop, FloatArrayPropertyGetFunc getfunc, FloatArrayPropertySetFunc setfunc, FloatPropertyRangeFunc rangefunc, FloatArrayPropertyGetTransformFunc get_transform_fn, FloatArrayPropertySetTransformFunc set_transform_fn)
ed::transform::SnapObjectContext * ED_gizmotypes_snap_3d_context_ensure(Scene *scene, wmGizmo *)
static SnapGizmo3D * gizmo_snap_rna_find_operator(PointerRNA *ptr)
void ED_view3d_cursor_snap_state_free(V3DSnapCursorState *state)
VecBase< int32_t, 2 > int2
static void snap_gizmo_draw(const bContext *, wmGizmo *gz)
ed::transform::SnapObjectContext * ED_view3d_cursor_snap_context_ensure(Scene *scene)
eWM_GizmoFlagTweak
Gizmo tweak flag. Bit-flag passed to gizmo while tweaking.
BMesh const char void * data
static void snap_gizmo_free(wmGizmo *gz)
wmGizmoGroup * WM_gizmomap_group_find_ptr(wmGizmoMap *gzmap, const wmGizmoGroupType *gzgt)
wmGizmo * gizmo_find_from_properties(const IDProperty *properties, const int spacetype, const int regionid)
static void gizmo_snap_rna_normal_get_fn(PointerRNA *, PropertyRNA *, float *values)
static int snap_gizmo_test_select(bContext *C, wmGizmo *gz, const int mval[2])
PointerRNA RNA_pointer_create_discrete(ID *id, StructRNA *type, void *data)
void ED_view3d_cursor_snap_data_update(V3DSnapCursorState *state, const bContext *C, const ARegion *region, const int2 &mval)
static wmOperatorStatus snap_gizmo_modal(bContext *, wmGizmo *, const wmEvent *, eWM_GizmoFlagTweak)
void RNA_def_property_enum_funcs_runtime(PropertyRNA *prop, EnumPropertyGetFunc getfunc, EnumPropertySetFunc setfunc, EnumPropertyItemFunc itemfunc, EnumPropertyGetTransformFunc get_transform_fn, EnumPropertySetTransformFunc set_transform_fn)
static void snap_cursor_free(SnapGizmo3D *snap_gizmo)
void ED_view3d_cursor_snap_state_prevpoint_set(V3DSnapCursorState *state, const float prev_point[3])
@ WM_GIZMO_NO_TOOLTIP
@ WM_GIZMO_DRAW_VALUE
PropertyRNA * RNA_def_float_vector_xyz(StructOrFunctionRNA *cont_, const char *identifier, const int len, const float *default_value, const float hardmin, const float hardmax, const char *ui_name, const char *ui_description, const float softmin, const float softmax)
@ WM_GIZMO_STATE_HIGHLIGHT
static void gizmo_snap_rna_snap_source_type_set_fn(PointerRNA *, PropertyRNA *, const int value)
const EnumPropertyItem rna_enum_snap_element_items[]
Definition rna_scene.cc:163
void ED_gizmotypes_snap_3d()
void ED_view3d_cursor_snap_state_active_set(V3DSnapCursorState *state)
void RNA_def_property_int_array_funcs_runtime(PropertyRNA *prop, IntArrayPropertyGetFunc getfunc, IntArrayPropertySetFunc setfunc, IntPropertyRangeFunc rangefunc, IntArrayPropertyGetTransformFunc get_transform_fn, IntArrayPropertySetTransformFunc set_transform_fn)
static void gizmo_snap_rna_snap_elem_index_get_fn(PointerRNA *, PropertyRNA *, int *values)
static void GIZMO_GT_snap_3d(wmGizmoType *gzt)
static void gizmo_snap_rna_prevpoint_get_fn(PointerRNA *ptr, PropertyRNA *, float *values)
static void gizmo_snap_rna_location_set_fn(PointerRNA *, PropertyRNA *, const float *values)
ARegion * CTX_wm_region(const bContext *C)
bke::ARegionRuntime * runtime
V3DSnapCursorState * snap_state
V3DSnapCursorState snap_state_stored
bool(*) poll(ARegion *region, void *custom_poll_data)
Definition ED_view3d.hh:380
wmGizmoGroupType * type
wmGizmoFnInvoke invoke
wmGizmoFnTestSelect test_select
wmGizmoGroup * parent_gzgroup
eWM_GizmoFlag flag
eWM_GizmoFlagState state
bke::WindowRuntime * runtime