Blender V5.3
usd_mesh_utils.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2024 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
5#include "usd_mesh_utils.hh"
8
9#include "BKE_attribute.hh"
10
11#include "DNA_mesh_types.h"
12
13#include "CLG_log.h"
14
15namespace blender {
16
17static CLG_LogRef LOG = {"io.usd"};
18
19namespace io::usd {
20
21template<typename USDT>
23 const pxr::UsdGeomPrimvar &primvar,
24 const pxr::TfToken &pv_name,
25 const pxr::UsdTimeCode time)
26{
27 const pxr::VtArray<USDT> usd_colors = get_primvar_array<USDT>(primvar, time);
28 if (usd_colors.empty()) {
29 return;
30 }
31
32 bke::MutableAttributeAccessor attributes = mesh->attributes_for_write();
33 const bke::AttrDomain color_domain = bke::AttrDomain::Corner;
34
35 const StringRef attr_name(pv_name.GetString());
36
37 if (primvar.GetInterpolation() == pxr::UsdGeomTokens->constant) {
39 colorspace_attr_to_scene_linear(primvar.GetAttr(), value);
40 set_single_value(attributes,
41 attr_name,
42 color_domain,
45 return;
46 }
47
49 attributes.lookup_or_add_for_write_only_span<ColorGeometry4f>(attr_name, color_domain);
50 if (!color_data) {
51 CLOG_WARN(&LOG, "Primvar '%s' could not be added to Blender", primvar.GetBaseName().GetText());
52 return;
53 }
54
55 const OffsetIndices faces = mesh->faces();
56 for (const int i : faces.index_range()) {
57 if (i >= usd_colors.size()) {
58 break;
59 }
60
61 /* Take the per-face USD color and place it on each face-corner. */
62 const IndexRange face = faces[i];
63 for (const int j : face.index_range()) {
64 const int corner = face.start() + j;
65 color_data.span[corner] = detail::convert_value<USDT, ColorGeometry4f>(usd_colors[i]);
66 }
67 }
68
69 colorspace_attr_to_scene_linear(primvar.GetAttr(), color_data.span);
70 color_data.finish();
71}
72
73static std::optional<bke::AttrDomain> convert_usd_varying_to_blender(const pxr::TfToken usd_domain)
74{
75 static const Map<pxr::TfToken, bke::AttrDomain> domain_map = []() {
77 map.add_new(pxr::UsdGeomTokens->faceVarying, bke::AttrDomain::Corner);
78 map.add_new(pxr::UsdGeomTokens->vertex, bke::AttrDomain::Point);
79 map.add_new(pxr::UsdGeomTokens->varying, bke::AttrDomain::Point);
80 map.add_new(pxr::UsdGeomTokens->face, bke::AttrDomain::Face);
81 /* Since there's no "domain" concept in USD, promote prim-level "constant" primvars to the
82 * Point domain in Blender. */
83 map.add_new(pxr::UsdGeomTokens->constant, bke::AttrDomain::Point);
84 map.add_new(pxr::UsdGeomTokens->uniform, bke::AttrDomain::Face);
85 /* Notice: Edge types are not supported! */
86 return map;
87 }();
88
89 const bke::AttrDomain *value = domain_map.lookup_ptr(usd_domain);
90
91 if (value == nullptr) {
92 return std::nullopt;
93 }
94
95 return *value;
96}
97
99 const pxr::UsdGeomPrimvar &primvar,
100 const pxr::UsdTimeCode time,
101 const bool is_left_handed)
102{
103 const pxr::SdfValueTypeName pv_type = primvar.GetTypeName();
104 const pxr::TfToken pv_interp = primvar.GetInterpolation();
105 const pxr::TfToken pv_name = pxr::UsdGeomPrimvar::StripPrimvarsName(primvar.GetPrimvarName());
106
107 const std::optional<bke::AttrDomain> domain = convert_usd_varying_to_blender(pv_interp);
108 const std::optional<bke::AttrType> type = convert_usd_type_to_blender(pv_type);
109
110 if (!domain.has_value() || !type.has_value()) {
111 CLOG_WARN(&LOG,
112 "Primvar '%s' (interpolation %s, type %s) cannot be converted to Blender",
113 pv_name.GetText(),
114 pv_interp.GetText(),
115 pv_type.GetAsToken().GetText());
116 return;
117 }
118
119 /* Blender does not currently support displaying Face colors with the Viewport Shading
120 * "Attribute" color type. Make a special case for "displayColor" primvars and put them on
121 * the Corner domain instead. */
122 if (pv_name == usdtokens::displayColor &&
123 ELEM(pv_interp, pxr::UsdGeomTokens->uniform, pxr::UsdGeomTokens->constant))
124 {
125 if (ELEM(pv_type,
126 pxr::SdfValueTypeNames->Color3fArray,
127 pxr::SdfValueTypeNames->Color3hArray,
128 pxr::SdfValueTypeNames->Color3dArray))
129 {
130 read_face_display_color<pxr::GfVec3f>(mesh, primvar, pv_name, time);
131 }
132 else {
133 read_face_display_color<pxr::GfVec4f>(mesh, primvar, pv_name, time);
134 }
135
136 return;
137 }
138
139 OffsetIndices<int> faces;
140 if (is_left_handed) {
141 faces = mesh->faces();
142 }
143
144 bke::MutableAttributeAccessor attributes = mesh->attributes_for_write();
145 copy_primvar_to_blender_attribute(primvar, time, *type, *domain, faces, attributes);
146}
147
148} // namespace io::usd
149} // namespace blender
#define CLOG_WARN(clg_ref,...)
Definition CLG_log.h:189
#define ELEM(...)
constexpr int64_t start() const
constexpr IndexRange index_range() const
const Value * lookup_ptr(const Key &key) const
Definition BLI_map.hh:508
void add_new(const Key &key, const Value &value)
Definition BLI_map.hh:265
GSpanAttributeWriter lookup_or_add_for_write_only_span(StringRef name, AttrDomain domain, AttrType data_type)
#define uniform(slot)
#define vertex
To convert_value(const From value)
static void read_face_display_color(Mesh *mesh, const pxr::UsdGeomPrimvar &primvar, const pxr::TfToken &pv_name, const pxr::UsdTimeCode time)
pxr::VtArray< T > get_primvar_array(const pxr::UsdGeomPrimvar &primvar, const pxr::UsdTimeCode time)
void colorspace_attr_to_scene_linear(const pxr::UsdAttribute &attr, pxr::GfVec3f &color)
void set_single_value(bke::MutableAttributeAccessor attributes, const StringRef attr_name, const bke::AttrDomain domain, const bke::AttrType data_type, const bke::AttributeInit &value)
void copy_primvar_to_blender_attribute(const pxr::UsdGeomPrimvar &primvar, const pxr::UsdTimeCode time, const bke::AttrType data_type, const bke::AttrDomain domain, const OffsetIndices< int > face_indices, bke::MutableAttributeAccessor attributes)
static std::optional< bke::AttrDomain > convert_usd_varying_to_blender(const pxr::TfToken usd_domain)
std::optional< bke::AttrType > convert_usd_type_to_blender(const pxr::SdfValueTypeName usd_type)
void read_generic_mesh_primvar(Mesh *mesh, const pxr::UsdGeomPrimvar &primvar, const pxr::UsdTimeCode time, const bool is_left_handed)
const pxr::TfToken displayColor("displayColor", pxr::TfToken::Immortal)
BMesh Iterators.
static CLG_LogRef LOG
Definition logging.cpp:12
ColorSceneLinear4f< eAlpha::Premultiplied > ColorGeometry4f