Add ability to hide editor transform gizmo

[ryevdokimov]

Related to: godotengine/godot-proposals#7834

There are scenarios where users want to be able to hide it, so this adds the option to.

Edit: The initial draft of this PR had the "View Gizmos" button toggle the visibility. Now it is a separate option.

2024-01-31.15-34-43.mp4

Collision gizmo without transform gizmo:

2024-01-31.16-01-04.mp4

• Bugsquad edit, closes: Can't disable the 3D transform gizmo in the editor #94312

[Mickeon]

Unsure if it should be hidden in the same toggle used by other gizmos, as it is arguably the most important gizmo, but it makes sense in theory.

[ryevdokimov]

I don't see why not. All the other Gizmos have their own toggle. I see this option as a literal "I don't want to see ANY gizmos button."

[AThousandShips]

I'd say this is a different kind of gizmo, hence why it isn't in that list (unless I'm mistaken)

[ryevdokimov]

You're correct. It's not on the list, but neither is the selection box "gizmo?" and that is considered part of the "Show Gizmos" functionality. I suppose it all depends on the actual intended purpose of the button.

[AThousandShips]

I think they are intended to always be shown, and are technically gizmos, but not in the same sense, for one they're used together with several other gizmos, though those other ones are largely mutually exclusive, as they're specific, while the transform and selection ones are generic, I think the toggle is to hide these specific ones, rather than the generic ones

I don't think this is an oversight, and I don't think it's any more distracting than the axis lines and grid etc.

[fire]

I think it's a backwards compatibility change to use the same toggle. One way is to have a different toggle for it and rename the old one to mention its excludes certain gizmos within the small tooltip / label sizes.

[ryevdokimov]

I think the toggle is to hide these specific ones, rather than the generic ones

If I'm understanding you correctly then hiding the selection box gizmo is a bug?

[AThousandShips]

If I'm understanding you correctly then hiding the selection box gizmo is a bug?

Mt bad didn't know it was hidden, I'm not sure about that one, but I'd rather say that's a bug and not this part

[ryevdokimov]

I think it's a backwards compatibility change to use the same toggle. One way is to have a different toggle for it and rename the old one.

Fair enough, I can look into doing that. I'll just need to understand if this is combined with the selection box, or should the selection box never hide, or if it's a separate thing all together?

I personally do think there is a utility to allowing users to hide everything. Enable them to have a freelook preview camera basically.

[AThousandShips]

Should be a separate setting as stated above, in that case, it breaks compatibility IMO

[ryevdokimov]

I was talking about the selection box. Although I suppose that's a separate issue all together. I can just leave it alone for now, and just have a separate option for hiding the transform gizmo.

[AThousandShips]

Meant for the hiding of this, I'd say to combine both sides of it

[ryevdokimov]

Meant for the hiding of this, I'd say to combine both sides of it

I'll just open an issue for this and make a separate PR in the future, if that's fine.

[ryevdokimov]

Ok, I made a separate option to toggle the transform gizmo. See attached video in the inital post.

[Aratch]

It's obviously not part of this PR, but will this option be eventually exposed to GdScript via EditorInterface?

[Mickeon]

I don't see why it should be. The best one could do without bloating EditorInterface is turn it into a action/shortcut, so that it can be at least triggered by other means.

[Aratch]

I don't see why it should be. The best one could do without bloating EditorInterface is turn it into a action/shortcut, so that it can be at least triggered by other means.

That's a fair assessment. I could open a proposal if necessary, but in short: when an EditorPlugin implements some sort of edit mode that relies on a node selection, it's AFAICT not possible to hide the editor's built-in gizmos, though you can turn off the default input behaviour (it's been a while since I've worked on something like this, admittedly).

[Mickeon]

No I understand, I personally experienced the same issue. Still, that sounds like it could be something extra to custom Node3DGizmos. Something like a _is_transform_gizmo_visible overridable method, so that it doesn't interfere with the setting but can still be customized.

Outside the scope of this PR, though. Could use a proposal indeed.

[fire]

I reviewed the video and it implements my request to move it to a separate boolean. Did not review the code.

[Calinou]

Tested locally, it works as expected.

This makes sense to add, if only to support the scenario where you hold down F and look at an object while you're dragging it.

[akien-mga]

Thanks!

[Rawalanche]

Why is my proposal listed in this PR? It has nothing to do with my proposal. My proposal was specifically about not having gizmo just in the select mode, which is meant for selecting, and not transforming. Having a toggle for transform gizmo that is shared by all modes and nested deep in some menu has absolutely, I mean absolutely nothing to do with the proposal I made.

It doesn't solve the request in any way. Godot still has no true select mode where one can reliably select nodes in the viewport without a risk of making accidental transform operation.

[ryevdokimov]

I wrote related, but not closes/implements (which is why your proposal is still open) because your proposal at the time was the only one that had some relevancy to give credence to this PR. I agree it doesn't solve the issue, but it at least allows you to manually hide the transform gizmo while select mode is activated. My understanding is you want an option for this to happen automatically and completely disable transforming functionality. The code written for this PR could serve as a good reference point of how to implement that.

[Rawalanche]

I wrote related, but not closes/implements (which is why your proposal is still open) because your proposal at the time was the only one that had some relevancy to give credence to this PR. I agree it doesn't solve the issue, but it at least allows you to manually hide the transform gizmo while select mode is activated. My understanding is you want an option for this to happen automatically and completely disable transforming functionality. The code written for this PR could serve as a good reference point of how to implement that.

Ok, you're right. I was just worried my proposal is gonna get closed because this PR was merged. If it's going to stay open then it's fine. I will try to make a PR myself soon. It should hopefully be easy.

It's still a bit messy because now we have two different things we call gizmos. The 3D viewport transform manipulators as well as view overlays in the View menu. I think the latter should be renamed to overlays or something. Gizmos and Transform Gizmos is kinda weird naming.

[ryevdokimov]

I was just worried my proposal is gonna get closed because this PR was merged.

No worries, I link these things for myself as well in case I personally want to implement a related PR. I gave your proposal a thumb up, I just haven't run into the issue enough times to dedicate the time to it.

It's still a bit messy.

I agree. Not to add to whole relevancy thing, but I did create a proposal to move most the stuff in the view menu to the perspective menu and have all "gizmos" including the transform manipulator as you call it, be toggled there: godotengine/godot-proposals#11363