Gizmo: add invoke_prepare callback

Allows gizmo groups to set values based on the gizmo about to be invoked.

4 files changed, 10 insertions, 0 deletions

diff --git a/source/blender/windowmanager/gizmo/WM_gizmo_types.h b/source/blender/windowmanager/gizmo/WM_gizmo_types.h
index f67a0d05bee..dc3e77eb130 100644
--- a/source/blender/windowmanager/gizmo/WM_gizmo_types.h
+++ b/source/blender/windowmanager/gizmo/WM_gizmo_types.h
@@ -372,6 +372,8 @@ typedef struct wmGizmoGroupType {
 	wmGizmoGroupFnRefresh refresh;
 	/* refresh data for drawing, called before each redraw */
 	wmGizmoGroupFnDrawPrepare draw_prepare;
+	/* Initialize data for before invoke. */
+	wmGizmoGroupFnInvokePrepare invoke_prepare;
 
 	/* Keymap init callback for this gizmo-group (optional),
 	 * will fall back to default tweak keymap when left NULL. */
diff --git a/source/blender/windowmanager/gizmo/intern/wm_gizmo_group.c b/source/blender/windowmanager/gizmo/intern/wm_gizmo_group.c
index 221d8df6c2b..f4cb40b0b94 100644
--- a/source/blender/windowmanager/gizmo/intern/wm_gizmo_group.c
+++ b/source/blender/windowmanager/gizmo/intern/wm_gizmo_group.c
@@ -381,6 +381,9 @@ static bool gizmo_tweak_start_and_finish(
 			}
 		}
 		else {
+			if (gz->parent_gzgroup->type->invoke_prepare) {
+				gz->parent_gzgroup->type->invoke_prepare(C, gz->parent_gzgroup, gz);
+			}
 			/* Allow for 'button' gizmos, single click to run an action. */
 			WM_operator_name_call_ptr(C, mpop->type, WM_OP_INVOKE_DEFAULT, &mpop->ptr);
 		}
diff --git a/source/blender/windowmanager/gizmo/intern/wm_gizmo_map.c b/source/blender/windowmanager/gizmo/intern/wm_gizmo_map.c
index c6d6a5cd48c..2c52b06a32a 100644
--- a/source/blender/windowmanager/gizmo/intern/wm_gizmo_map.c
+++ b/source/blender/windowmanager/gizmo/intern/wm_gizmo_map.c
@@ -948,6 +948,9 @@ void wm_gizmomap_modal_set(
 		if (gz->type->invoke &&
 		    (gz->type->modal || gz->custom_modal))
 		{
+			if (gz->parent_gzgroup->type->invoke_prepare) {
+				gz->parent_gzgroup->type->invoke_prepare(C, gz->parent_gzgroup, gz);
+			}
 			const int retval = gz->type->invoke(C, gz, event);
 			if ((retval & OPERATOR_RUNNING_MODAL) == 0) {
 				return;
diff --git a/source/blender/windowmanager/gizmo/wm_gizmo_fn.h b/source/blender/windowmanager/gizmo/wm_gizmo_fn.h
index 88065a0fcd5..3361932c6e3 100644
--- a/source/blender/windowmanager/gizmo/wm_gizmo_fn.h
+++ b/source/blender/windowmanager/gizmo/wm_gizmo_fn.h
@@ -39,6 +39,8 @@ typedef void (*wmGizmoGroupFnRefresh)(
         const struct bContext *, struct wmGizmoGroup *);
 typedef void (*wmGizmoGroupFnDrawPrepare)(
         const struct bContext *, struct wmGizmoGroup *);
+typedef void (*wmGizmoGroupFnInvokePrepare)(
+        const struct bContext *, struct wmGizmoGroup *, struct wmGizmo *);
 typedef struct wmKeyMap *(*wmGizmoGroupFnSetupKeymap)(
         const struct wmGizmoGroupType *, struct wmKeyConfig *)
         ATTR_WARN_UNUSED_RESULT;