usd_reader_stage.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2021 Tangent Animation and. NVIDIA Corporation. All rights reserved.
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
#pragma once
 
#include "BLI_map.hh"
#include "BLI_set.hh"
#include "BLI_vector.hh"
 
#include "usd.hh"
#include "usd_hash_types.hh"
#include "usd_reader_domelight.hh"
#include "usd_reader_prim.hh"
 
#include <pxr/usd/usdGeom/imageable.h>
 
struct Collection;
struct ImportSettings;
struct Main;
struct ReportList;
 
namespace blender::io::usd {
 
class USDPointInstancerReader;

using ProtoReaderMap = blender::Map<pxr::SdfPath, blender::Vector<USDPrimReader *>>;
 
using UsdPathSet = blender::Set<pxr::SdfPath>;
 
class USDStageReader {
 
 protected:
  pxr::UsdStageRefPtr stage_;
  USDImportParams params_;
  ImportSettings settings_;
 
  blender::Vector<USDPrimReader *> readers_;
 
  /* USD dome lights are converted to a world material,
   * rather than light objects, so are handled differently */
  blender::Vector<USDDomeLightReader *> dome_light_readers_;
 
  /* USD material prim paths encountered during stage
   * traversal, for importing unused materials. */
  blender::Vector<pxr::SdfPath> material_paths_;
 
  /* Readers for scene-graph instance prototypes. */
  ProtoReaderMap proto_readers_;
 
  /* Readers for point instancer prototypes. */
  ProtoReaderMap instancer_proto_readers_;
 
 public:
  USDStageReader(pxr::UsdStageRefPtr stage,
                 const USDImportParams &params,
                 const std::function<CacheFile *()> &get_cache_file_fn = {});
 
  ~USDStageReader();
 
  USDPrimReader *create_reader_if_allowed(const pxr::UsdPrim &prim);
 
  USDPrimReader *create_reader(const pxr::UsdPrim &prim);
 
  void collect_readers();

  void process_armature_modifiers() const;
 
  /* Convert every material prim on the stage to a Blender
   * material, including materials not used by any geometry.
   * Note that collect_readers() must be called before calling
   * import_all_materials(). */
  void import_all_materials(struct Main *bmain);
 
  /* Add fake users for any imported materials with no
   * users. This is typically required when importing all
   * materials. */
  void fake_users_for_unused_materials();

  void find_material_import_hook_sources();

  void call_material_import_hooks(struct Main *bmain) const;
 
  bool valid() const;
 
  pxr::UsdStageRefPtr stage()
  {
    return stage_;
  }
  const USDImportParams &params() const
  {
    return params_;
  }
 
  const ImportSettings &settings() const
  {
    return settings_;
  }

  ReportList *reports() const
  {
    return params_.worker_status ? params_.worker_status->reports : nullptr;
  }

  void clear_readers();
 
  const blender::Vector<USDPrimReader *> &readers() const
  {
    return readers_;
  };
 
  const blender::Vector<USDDomeLightReader *> &dome_light_readers() const
  {
    return dome_light_readers_;
  };
 
  void sort_readers();

  void create_proto_collections(Main *bmain, Collection *parent_collection);
 
 private:
  USDPrimReader *collect_readers(const pxr::UsdPrim &prim,
                                 const UsdPathSet &pruned_prims,
                                 bool defined_prims_only,
                                 blender::Vector<USDPrimReader *> &r_readers);

  bool include_by_visibility(const pxr::UsdGeomImageable &imageable) const;

  bool include_by_purpose(const pxr::UsdGeomImageable &imageable) const;

  bool merge_with_parent(USDPrimReader *reader) const;

  bool is_primitive_prim(const pxr::UsdPrim &prim) const;

  UsdPathSet collect_point_instancer_proto_paths() const;
  void collect_point_instancer_proto_paths(const pxr::UsdPrim &prim, UsdPathSet &r_paths) const;

  void create_point_instancer_proto_readers(const UsdPathSet &proto_paths);
};
 
};  // namespace blender::io::usd