Blender V5.3
usd_writer_abstract.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2019 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4#pragma once
5
8
9#include <pxr/usd/sdf/path.h>
10#include <pxr/usd/usd/prim.h>
11#include <pxr/usd/usdGeom/boundable.h>
12#include <pxr/usd/usdShade/material.h>
13#include <pxr/usd/usdUtils/sparseValueWriter.h>
14
15#include <string>
16
17namespace blender {
18
19struct ID;
20struct IDProperty;
21struct Material;
22struct ReportList;
23
24template<typename T> struct Bounds;
25
26namespace io::usd {
27
28using io::AbstractHierarchyWriter;
29using io::HierarchyContext;
30
32 protected:
34 pxr::UsdUtilsSparseValueWriter usd_value_writer_;
35
38
39 public:
40 USDAbstractWriter(const USDExporterContext &usd_export_context);
41
42 void write(HierarchyContext &context) override;
43
53 virtual bool is_supported(const HierarchyContext *context) const;
54
55 const pxr::SdfPath &usd_path() const;
56
58 ReportList *reports() const;
59
60 protected:
61 virtual void do_write(HierarchyContext &context) = 0;
62 std::string get_export_file_path() const;
63 pxr::UsdTimeCode get_export_time_code() const;
64
65 /* Returns the parent path of exported materials. */
66 pxr::SdfPath get_material_library_path() const;
67 /* Returns the parent path of exported materials for instance prototypes. */
68 pxr::SdfPath get_proto_material_root_path(const HierarchyContext &context) const;
69 /* Ensure the USD material is created in the default material library folder. */
70 pxr::UsdShadeMaterial ensure_usd_material_created(const HierarchyContext &context,
71 Material *material) const;
72 /* Calls ensure_usd_material_created(). Additionally, if the context is an
73 * instancing prototype, creates a reference to the library material under the
74 * prototype root. */
75 pxr::UsdShadeMaterial ensure_usd_material(const HierarchyContext &context,
76 Material *material) const;
77
78 void write_id_properties(const pxr::UsdPrim &prim,
79 const ID &id,
80 pxr::UsdTimeCode = pxr::UsdTimeCode::Default()) const;
81 void write_user_properties(const pxr::UsdPrim &prim,
82 IDProperty *properties,
83 pxr::UsdTimeCode = pxr::UsdTimeCode::Default()) const;
84
85 void write_visibility(const HierarchyContext &context,
86 const pxr::UsdTimeCode time,
87 const pxr::UsdGeomImageable &usd_geometry);
88
95 virtual bool mark_as_instance(const HierarchyContext &context, const pxr::UsdPrim &prim);
96
113 void author_extent(const pxr::UsdGeomBoundable &boundable, const pxr::UsdTimeCode time);
114
118 void author_extent(const pxr::UsdGeomBoundable &boundable,
119 const std::optional<Bounds<float3>> &bounds,
120 const pxr::UsdTimeCode time);
121
122 void add_to_prim_map(const pxr::SdfPath &usd_path, const ID *id) const;
123};
124
125} // namespace io::usd
126} // namespace blender
pxr::UsdShadeMaterial ensure_usd_material(const HierarchyContext &context, Material *material) const
virtual void do_write(HierarchyContext &context)=0
pxr::SdfPath get_proto_material_root_path(const HierarchyContext &context) const
void author_extent(const pxr::UsdGeomBoundable &boundable, const pxr::UsdTimeCode time)
const pxr::SdfPath & usd_path() const
void add_to_prim_map(const pxr::SdfPath &usd_path, const ID *id) const
void write_user_properties(const pxr::UsdPrim &prim, IDProperty *properties, pxr::UsdTimeCode=pxr::UsdTimeCode::Default()) const
pxr::UsdShadeMaterial ensure_usd_material_created(const HierarchyContext &context, Material *material) const
virtual bool mark_as_instance(const HierarchyContext &context, const pxr::UsdPrim &prim)
pxr::UsdTimeCode get_export_time_code() const
pxr::UsdUtilsSparseValueWriter usd_value_writer_
USDAbstractWriter(const USDExporterContext &usd_export_context)
void write_id_properties(const pxr::UsdPrim &prim, const ID &id, pxr::UsdTimeCode=pxr::UsdTimeCode::Default()) const
void write(HierarchyContext &context) override
void write_visibility(const HierarchyContext &context, const pxr::UsdTimeCode time, const pxr::UsdGeomImageable &usd_geometry)
virtual bool is_supported(const HierarchyContext *context) const
const USDExporterContext usd_export_context_
BMesh Iterators.