Feat: Improve ArmatureDebugger

[capdevon]

This update refines the ArmatureDebugger class by optimizing its structure and adding comprehensive Javadoc documentation. The changes improve code readability, maintainability, and provide detailed explanations for class functionality making it easier for developers to understand and utilize the armature debugging tools.

This PR introduces a significant refactor and optimization of the ArmatureNode class, which is responsible for visualizing JME3 armatures for debugging.

Key changes include:

• Improved Code Clarity and Maintainability:
  • Added comprehensive Javadoc comments to all classes, methods, and significant variables, explaining their purpose, parameters, and return values.
  • Optimized temporary vector usage to reduce allocations during updates and picking.
• Enhanced Joint and Bone Picking:
  • Refined the pick and collideWith methods for more robust 2D picking of joint heads and bone wires.
  • Implemented separate handling for joint heads (pixel-based picking) and bone wires (distance-based picking), improving selection accuracy.
• Flexible Coloring Options:
  • Added dedicated methods setHeadColor(Joint, ColorRGBA), setHeadColor(ColorRGBA), setLineColor(ColorRGBA) for easier programmatic control over the visualization colors.

These changes make ArmatureNode more robust, easier to understand, and more flexible for debugging armature animations and poses.

Edit:

Usage example:

        Spatial model = assetManager.loadModel("Models/Sinbad/Sinbad.mesh.xml");
        AnimMigrationUtils.migrate(model);
        rootNode.attachChild(model);

        SkinningControl skControl = model.getControl(SkinningControl.class);

        ArmatureDebugger debugger = new ArmatureDebugger(assetManager, skControl);
        debugger.setName(model.getName() + "_ArmatureDebugger");
        debugger.getBoneShapes().setHeadColor(ColorRGBA.Blue);
        debugger.getBoneShapes().setLineColor(ColorRGBA.Green);
        ((Node) model).attachChild(debugger);