OpenUSD中获取网格UV属性的正确方法

在OpenUSD项目中，获取网格(Mesh)的UV属性是一个常见的需求。本文详细介绍了如何正确地从UsdGeomMesh对象中提取UV属性，并解释了相关API的变化历史。

旧版API的问题

在OpenUSD早期版本中，开发者可以直接通过UsdGeomMesh类的GetPrimvar方法来获取UV属性。例如：

VtArray<GfVec2f> uvs;
auto uvAttr = mesh.GetPrimvar(TfToken("primvars:st")).GetAttr();

然而，从OpenUSD v22.08版本开始，这种直接调用方式会导致编译错误，提示"GetPrimvar不是UsdGeomMesh的成员"。这是因为相关的API在v19.05版本被标记为废弃(deprecated)，并在v22.08版本中完全移除。

API变更背景

OpenUSD团队对Primvar(原始变量)API进行了重构，将其从UsdGeomImageable基类中分离出来，创建了专门的UsdGeomPrimvarsAPI类。这种设计变更的目的是：

1. 使API结构更加清晰和模块化
2. 减少基类的复杂性
3. 提供更专业的Primvar操作方法

新版API使用方法

现在，获取UV属性的正确方式是使用UsdGeomPrimvarsAPI类：

// 获取Prim对象
PXR_NS::UsdPrim prim = stage->GetPrimAtPath(PXR_NS::SdfPath("/Cube"));

// 创建PrimvarsAPI实例
PXR_NS::UsdGeomPrimvarsAPI primvarsAPI(prim);

// 检查是否存在UV属性
if(primvarsAPI.HasPrimvar(TfToken("primvars:st"))) {
    // 获取UV属性
    auto uvPrimvar = primvarsAPI.GetPrimvar(TfToken("primvars:st"));
    VtArray<GfVec2f> uvs;
    uvPrimvar.Get(&uvs);
}

关键点说明

1. Primvar名称：UV属性通常使用"primvars:st"作为名称，这是OpenUSD中的约定

2. API使用流程：

   • 首先通过Prim对象创建UsdGeomPrimvarsAPI实例
   • 使用HasPrimvar检查属性是否存在
   • 使用GetPrimvar获取属性
   • 最后通过Get方法提取实际数据

3. 数据类型：UV坐标通常以GfVec2f类型存储，表示二维浮点向量

兼容性考虑

如果你的代码需要同时支持新旧版本的OpenUSD，可以考虑以下兼容性方案：

#if USD_VERSION_NUM >= 2208
    // 使用新版API
    UsdGeomPrimvarsAPI primvarsAPI(mesh);
    auto uvPrimvar = primvarsAPI.GetPrimvar(TfToken("primvars:st"));
#else
    // 使用旧版API
    auto uvPrimvar = mesh.GetPrimvar(TfToken("primvars:st"));
#endif

总结

OpenUSD对Primvar API的重新设计体现了更好的模块化思想。虽然这种变更在短期内可能导致一些兼容性问题，但从长远来看，它提供了更清晰、更专业的API结构。开发者应当及时更新代码，使用新的UsdGeomPrimvarsAPI类来操作UV等Primvar属性。