godot-rust中SurfaceTool.commit()方法的使用注意事项

概述

在使用godot-rust绑定库开发Godot游戏时，SurfaceTool是一个常用的3D网格生成工具。然而，许多开发者在使用其commit()方法时会遇到崩溃问题。本文将详细介绍这个问题的原因及解决方案。

问题现象

当开发者按照常规方式调用SurfaceTool的commit()方法时，程序会在运行时崩溃。典型的错误代码如下：

let a_mesh = st.commit();

这段代码看起来简单直接，但在godot-rust中会导致程序崩溃。

根本原因

问题的根源在于Godot引擎原生的commit()方法实际上需要一个可选的Existing参数，而godot-rust绑定目前尚未正确处理这个可选参数。这与GDScript中的行为不同，在GDScript中可以简单地调用commit()而不传参数。

解决方案

目前推荐的解决方案是显式地传递一个null对象作为参数：

let a_mesh = st.commit(Null::null());

这种写法明确告诉Godot引擎我们不提供Existing参数，从而避免了崩溃问题。

完整示例

以下是一个使用SurfaceTool创建简单三角形网格的完整正确示例：

use godot::engine::mesh::PrimitiveType;
use godot::engine::{Mesh, MeshInstance3D, SurfaceTool};
use godot::prelude::*;

#[derive(GodotClass)]
#[class(base=MeshInstance3D)]
struct CustomMesh {
    base: Base<MeshInstance3D>,
}

#[godot_api]
impl IMeshInstance3D for CustomMesh {
    fn init(base: Base<MeshInstance3D>) -> Self {
        Self { base }
    }

    fn ready(&mut self) {
        let mut st = SurfaceTool::new_gd();
        st.begin(PrimitiveType::TRIANGLES);

        // 第一个顶点
        st.set_normal(Vector3::new(0.0, 0.0, 1.0));
        st.set_uv(Vector2::new(0.0, 0.0));
        st.add_vertex(Vector3::new(-1.0, -1.0, 0.0));
        
        // 第二个顶点
        st.set_normal(Vector3::new(0.0, 0.0, 1.0));
        st.set_uv(Vector2::new(0.0, 1.0));
        st.add_vertex(Vector3::new(-1.0, 1.0, 0.0));
        
        // 第三个顶点
        st.set_normal(Vector3::new(0.0, 0.0, 1.0));
        st.set_uv(Vector2::new(1.0, 1.0));
        st.add_vertex(Vector3::new(1.0, 1.0, 0.0));

        // 正确调用commit方法
        if let Some(mesh) = st.commit(Null::null()) {
            self.base_mut().set_mesh(mesh.upcast());
        }
    }
}

注意事项

1. 这个问题是godot-rust绑定特有的，在GDScript中不会出现
2. 未来版本的godot-rust可能会修复这个问题，使commit()可以不带参数调用
3. 当遇到类似API调用崩溃时，检查是否需要传递可选参数是一个好的排查方向

总结

在godot-rust中使用SurfaceTool时，务必记住commit()方法需要显式传递Null::null()作为参数。这个小小的改变可以避免程序崩溃，让你的3D网格生成代码正常工作。随着godot-rust的不断发展，这类API绑定问题将会逐渐减少，但目前开发者需要注意这些特殊情况的处理。