usd_writer_abstract.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2019 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
#pragma once
 
#include "IO_abstract_hierarchy_iterator.h"
#include "usd_exporter_context.hh"
 
#include <pxr/usd/sdf/path.h>
#include <pxr/usd/usd/prim.h>
#include <pxr/usd/usdGeom/boundable.h>
#include <pxr/usd/usdShade/material.h>
#include <pxr/usd/usdUtils/sparseValueWriter.h>
 
#include "WM_types.hh"
 
#include <string>
 
struct ID;
struct IDProperty;
struct Material;
struct ReportList;
 
namespace blender {
template<typename T> struct Bounds;
}
 
namespace blender::io::usd {
 
using blender::io::AbstractHierarchyWriter;
using blender::io::HierarchyContext;
 
class USDAbstractWriter : public AbstractHierarchyWriter {
 protected:
  const USDExporterContext usd_export_context_;
  pxr::UsdUtilsSparseValueWriter usd_value_writer_;
 
  bool frame_has_been_written_;
  bool is_animated_;
 
 public:
  USDAbstractWriter(const USDExporterContext &usd_export_context);
 
  void write(HierarchyContext &context) override;

  virtual bool is_supported(const HierarchyContext *context) const;
 
  const pxr::SdfPath &usd_path() const;

  ReportList *reports() const
  {
    return usd_export_context_.export_params.worker_status->reports;
  }
 
 protected:
  virtual void do_write(HierarchyContext &context) = 0;
  std::string get_export_file_path() const;
  pxr::UsdTimeCode get_export_time_code() const;
 
  /* Returns the parent path of exported materials. */
  pxr::SdfPath get_material_library_path() const;
  /* Returns the parent path of exported materials for instance prototypes. */
  pxr::SdfPath get_proto_material_root_path(const HierarchyContext &context) const;
  /* Ensure the USD material is created in the default material library folder. */
  pxr::UsdShadeMaterial ensure_usd_material_created(const HierarchyContext &context,
                                                    Material *material) const;
  /* Calls ensure_usd_material_created(). Additionally, if the context is an
   * instancing prototype, creates a reference to the library material under the
   * prototype root. */
  pxr::UsdShadeMaterial ensure_usd_material(const HierarchyContext &context,
                                            Material *material) const;
 
  void write_id_properties(const pxr::UsdPrim &prim,
                           const ID &id,
                           pxr::UsdTimeCode = pxr::UsdTimeCode::Default()) const;
  void write_user_properties(const pxr::UsdPrim &prim,
                             IDProperty *properties,
                             pxr::UsdTimeCode = pxr::UsdTimeCode::Default()) const;
 
  void write_visibility(const HierarchyContext &context,
                        const pxr::UsdTimeCode time,
                        const pxr::UsdGeomImageable &usd_geometry);

  virtual bool mark_as_instance(const HierarchyContext &context, const pxr::UsdPrim &prim);

  void author_extent(const pxr::UsdGeomBoundable &boundable, const pxr::UsdTimeCode time);

  void author_extent(const pxr::UsdGeomBoundable &boundable,
                     const std::optional<Bounds<float3>> &bounds,
                     const pxr::UsdTimeCode time);
};
 
}  // namespace blender::io::usd