Add BonePicker and simple auto mapping to BoneMapper

[TokageItLab]

Co-authored-by: K. S. Ernest (iFire) Lee [email protected]

Section 6 and 7 of godotengine/godot-proposals#4510.
Closes godotengine/godot-proposals#4510.

Bones are estimated based on commonly used bone names and parent-child relationships. They are based on my experience and data collected by @fire.

Note: For now, this only works if you use SkeletonProfileHumanoid, which is the default preset for SkeletonProfile in Godot and it is for the most part hard coded.

[fire]

Will be providing models and such to tokage.

[TokageItLab]

Update usability.

[TokageItLab]

Enum list generation is too heavy (not related to this PR), I will send improvement later.

[TokageItLab]

Added BonePicker as Section 6 of godotengine/godot-proposals#4510.
By implementing the BonePicker and eliminating the Enum, the generation of the GUI has been made lighter.

[JohanAR]

@TokageItLab I don't know which one caused it to fail, but it no longer happens with the updated commit. Is it still relevant to know? Now it looks like it autodetects everything for group Body except upper chest and root, while nothing is detected for the head (model has eyes but no jaw) or for the hands.

This is an example of how the fingers are named:

Maybe you can send me a message on the discord server if you need any more info about the model.

As for general usability feedback, it would be nice if it was possible to keep the bone picker open, for example replacing the scene tree in the left view. This would drastically reduce the amount of clicking per bone one wants to map.

It would also be nice if the skeleton was drawn on top of the model while working with the Skeleton3D, similar to how it looks in Unity, with the currently selected bone (in the picker) being highlighted of course.

[TokageItLab]

@JohanAR Thanks, finger0, finger1 are indeed undetectable cases as I expected.

As for general usability feedback, it would be nice if it was possible to keep the bone picker open, for example replacing the scene tree in the left view. This would drastically reduce the amount of clicking per bone one wants to map.

It would also be nice if the skeleton was drawn on top of the model while working with the Skeleton3D, similar to how it looks in Unity, with the currently selected bone (in the picker) being highlighted of course.

We discussed with @lyuma the same thing about it, but it is hard work and has been put on the back burner for now.

[JohanAR]

@TokageItLab would it be possible for the bone picker popup to at least remember which tree nodes were expanded the last time, so it doesn't collapse the entire tree every time it is opened?

[TokageItLab]

@JohanAR Okay, I made it recording the folding state.

[JohanAR]

@TokageItLab Awesome! Feels much quicker to manually assign bones already :)

Another minor suggestion: Make double clicking a bone in the popup select it, so I don't have to press the ok button. And maybe make it possible to double click the circles in the in the group illustration, so that opens the picker for the selected item.

[TokageItLab]

@JohanAR Fixed. Tree class has a double-click signal, so it can be confirmed with a double-click now. However, Button class does not have a double-click signal, so the opening picker still needs to press the button for the picker.

[TokageItLab]

So far, I consider sequential number naming such as finger0, finger1 is a corner case.

The reason for using such numbers for fingers is that in some of the models I have seen, there are some cases where the fingers are merged.

For example, there are models that bind the thumb as finger0 and the other four fingers as finger1. In other cases, there are models that bind the thumb as finger0, the index and middle fingers as finger1, and the ring and little fingers as finger2.

In these cases, it would be correct to treat finger0 as the thumb, but for the other fingers, there is no clear name because they are merged. In other words, auto-mapping cannot make the correct decision.

It would be correct to map each bone from thumb to little finger if finger0-finger4 existed as an extension of that. However, for now that is pretty much a corner case that only the proprietary Biped system in 3dx max might generate. Auto-mapping is just an assist tool, and its accuracy is not guaranteed for all cases. Manual mapping and reusing BoneMap resources should be sufficient for those cases IMO.

[TokageItLab]

As a subplan for cases where finger detection cannot be done by generic name, I added a string sorting of the bone names containing "finger" to perform the assignment. This should probably work for 3ds max Biped models @JohanAR.

This means that it could break if there are 4 sequentially numbered fingers and one accessory name containing "finger" is on the palm, but I think that is a extreme-extreme corner case.

[akien-mga]

Needs rebase.

[akien-mga]

Thanks!