Blender V5.3
usd_writer_points.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
7#include "usd_utils.hh"
8
10#include "BKE_attribute.hh"
11#include "BKE_report.hh"
12
13#include "DNA_object_types.h"
15
16#include <pxr/base/vt/array.h>
17#include <pxr/usd/usdGeom/points.h>
18#include <pxr/usd/usdGeom/primvarsAPI.h>
19
20namespace blender::io::usd {
21
23{
24 const pxr::UsdStageRefPtr stage = usd_export_context_.stage;
25 const pxr::SdfPath &usd_path = usd_export_context_.usd_path;
26 const pxr::UsdTimeCode time = get_export_time_code();
27
28 const PointCloud *points = id_cast<const PointCloud *>(context.object->data);
29 Span<pxr::GfVec3f> positions = points->positions().cast<pxr::GfVec3f>();
30 VArray<float> radii = points->radius();
31
32 const pxr::UsdGeomPoints usd_points = pxr::UsdGeomPoints::Define(stage, usd_path);
33
34 pxr::VtArray<pxr::GfVec3f> usd_positions;
35 usd_positions.assign(positions.begin(), positions.end());
36
37 pxr::UsdAttribute attr_positions = usd_points.CreatePointsAttr(pxr::VtValue(), true);
38 if (!attr_positions.HasValue()) {
39 attr_positions.Set(usd_positions, pxr::UsdTimeCode::Default());
40 }
41 usd_value_writer_.SetAttribute(attr_positions, usd_positions, time);
42
43 if (!radii.is_empty()) {
44 pxr::VtArray<float> usd_widths;
45 usd_widths.resize(radii.size());
46 for (const int i : radii.index_range()) {
47 usd_widths[i] = radii[i] * 2.0f;
48 }
49
50 pxr::UsdAttribute attr_widths = usd_points.CreateWidthsAttr(pxr::VtValue(), true);
51 if (!attr_widths.HasValue()) {
52 attr_widths.Set(usd_widths, pxr::UsdTimeCode::Default());
53 }
54 usd_value_writer_.SetAttribute(attr_widths, usd_widths, time);
55 }
56
57 this->write_ids(points, usd_points, time);
58 this->write_velocities(points, usd_points, time);
59 this->write_custom_data(points, usd_points, time);
60
61 this->author_extent(usd_points, points->bounds_min_max(), time);
62}
63
64static std::optional<pxr::TfToken> convert_blender_domain_to_usd(
65 const bke::AttrDomain blender_domain)
66{
67 switch (blender_domain) {
69 return pxr::UsdGeomTokens->varying;
70
71 default:
72 return std::nullopt;
73 }
74}
75
76void USDPointsWriter::write_generic_data(const bke::AttributeIter &attr,
77 const pxr::UsdGeomPoints &usd_points,
78 const pxr::UsdTimeCode time)
79{
80 const std::optional<pxr::TfToken> pv_interp = convert_blender_domain_to_usd(attr.domain);
81 const std::optional<pxr::SdfValueTypeName> pv_type = convert_blender_type_to_usd(attr.data_type);
82
83 if (!pv_interp || !pv_type) {
84 BKE_reportf(this->reports(),
86 "Attribute '%s' (Blender domain %d, type %d) cannot be converted to USD",
87 attr.name.c_str(),
88 int(attr.domain),
89 int(attr.data_type));
90 return;
91 }
92
93 const GVArray attribute = *attr.get();
94 if (attribute.is_empty()) {
95 return;
96 }
97
98 const pxr::TfToken pv_name(
100 const pxr::UsdGeomPrimvarsAPI pv_api = pxr::UsdGeomPrimvarsAPI(usd_points);
101
102 pxr::UsdGeomPrimvar pv_attr = pv_api.CreatePrimvar(pv_name, *pv_type, *pv_interp);
103
105}
106
107void USDPointsWriter::write_custom_data(const PointCloud *points,
108 const pxr::UsdGeomPoints &usd_points,
109 const pxr::UsdTimeCode time)
110{
111 const bke::AttributeAccessor attributes = points->attributes();
112
113 attributes.foreach_attribute([&](const bke::AttributeIter &iter) {
114 /* Skip "internal" Blender properties and attributes dealt with elsewhere. */
115 if (iter.name[0] == '.' || bke::attribute_name_is_anonymous(iter.name) ||
116 ELEM(iter.name, "position", "radius", "id", "velocity"))
117 {
118 return;
119 }
120
121 this->write_generic_data(iter, usd_points, time);
122 });
123}
124
125void USDPointsWriter::write_ids(const PointCloud *points,
126 const pxr::UsdGeomPoints &usd_points,
127 const pxr::UsdTimeCode time)
128{
129 const VArraySpan ids = *points->attributes().lookup<int>("id", bke::AttrDomain::Point);
130 if (ids.is_empty()) {
131 return;
132 }
133
134 pxr::VtInt64Array usd_ids(ids.begin(), ids.end());
135 pxr::UsdAttribute attr_ids = usd_points.CreateIdsAttr(pxr::VtValue(), true);
136 set_attribute(attr_ids, usd_ids, time, usd_value_writer_);
137}
138
139void USDPointsWriter::write_velocities(const PointCloud *points,
140 const pxr::UsdGeomPoints &usd_points,
141 const pxr::UsdTimeCode time)
142{
143 const VArraySpan velocity = *points->attributes().lookup<float3>("velocity",
145 if (velocity.is_empty()) {
146 return;
147 }
148
149 Span<pxr::GfVec3f> data = velocity.cast<pxr::GfVec3f>();
150 pxr::VtArray<pxr::GfVec3f> usd_velocities;
151 usd_velocities.assign(data.begin(), data.end());
152
153 pxr::UsdAttribute attr_vel = usd_points.CreateVelocitiesAttr(pxr::VtValue(), true);
154 if (!attr_vel.HasValue()) {
155 attr_vel.Set(usd_velocities, pxr::UsdTimeCode::Default());
156 }
157
158 usd_value_writer_.SetAttribute(attr_vel, usd_velocities, time);
159}
160
161} // namespace blender::io::usd
Object is a sort of wrapper for general info.
#define ELEM(...)
AttributeSet attributes
constexpr const T * end() const
Definition BLI_span.hh:228
constexpr const T * begin() const
Definition BLI_span.hh:224
constexpr const char * c_str() const
GAttributeReader get() const
constexpr bool is_empty() const
void author_extent(const pxr::UsdGeomBoundable &boundable, const pxr::UsdTimeCode time)
const pxr::SdfPath & usd_path() const
pxr::UsdTimeCode get_export_time_code() const
pxr::UsdUtilsSparseValueWriter usd_value_writer_
const USDExporterContext usd_export_context_
void do_write(HierarchyContext &context) override
#define attribute(slot)
bool attribute_name_is_anonymous(const StringRef name)
void copy_blender_attribute_to_primvar(const GVArray &attribute, const bke::AttrType data_type, const pxr::UsdTimeCode time, const pxr::UsdGeomPrimvar &primvar, pxr::UsdUtilsSparseValueWriter &value_writer)
std::optional< pxr::SdfValueTypeName > convert_blender_type_to_usd(const bke::AttrType blender_type, bool use_color3f_type)
static std::optional< pxr::TfToken > convert_blender_domain_to_usd(const bke::AttrDomain blender_domain, bool is_bezier)
void set_attribute(const pxr::UsdAttribute &attr, const USDT value, pxr::UsdTimeCode time, pxr::UsdUtilsSparseValueWriter &value_writer)
std::string make_safe_primvar_name(const StringRef name, bool allow_unicode)
Definition usd_utils.cc:88
@ RPT_WARNING
Definition BKE_report.hh:40
BMesh const char void * data
void BKE_reportf(ReportList *reports, eReportType type, const char *format,...) ATTR_PRINTF_FORMAT(3
Definition report.cc:191
VecBase< float, 3 > float3