#include <usd_reader_stage.hh>

Public Member Functions
	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

void	import_all_materials (struct Main *bmain)

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 ()

const USDImportParams &	params () const

const ImportSettings &	settings () const

ReportList *	reports () const

void	clear_readers ()

const blender::Vector< USDPrimReader * > &	readers () const

const blender::Vector< USDDomeLightReader * > &	dome_light_readers () const

void	sort_readers ()

void	create_proto_collections (Main bmain, Collection parent_collection)

Protected Attributes
pxr::UsdStageRefPtr	stage_

USDImportParams	params_

ImportSettings	settings_

blender::Vector< USDPrimReader * >	readers_

blender::Vector< USDDomeLightReader * >	dome_light_readers_

blender::Vector< pxr::SdfPath >	material_paths_

ProtoReaderMap	proto_readers_

ProtoReaderMap	instancer_proto_readers_

Detailed Description

Definition at line 34 of file usd_reader_stage.hh.

Constructor & Destructor Documentation

◆ USDStageReader()

blender::io::usd::USDStageReader::USDStageReader	(	pxr::UsdStageRefPtr	stage,
		const USDImportParams &	params,
		const std::function< CacheFile *()> &	get_cache_file_fn = {} )

Definition at line 200 of file usd_reader_stage.cc.

References blender::io::usd::USDImportParams::apply_unit_conversion_scale, blender::io::usd::convert_to_z_up(), blender::io::usd::determine_blender_compat(), blender::io::usd::find_prefix_to_skip(), blender::io::usd::ImportSettings::get_cache_file, params(), blender::io::usd::USDImportParams::scale, blender::io::usd::ImportSettings::scene_scale, settings_, stage(), stage_, and blender::io::usd::ImportSettings::stage_meters_per_unit.

◆ ~USDStageReader()

blender::io::usd::USDStageReader::~USDStageReader ( )

Definition at line 216 of file usd_reader_stage.cc.

References clear_readers().

Member Function Documentation

◆ call_material_import_hooks()

void blender::io::usd::USDStageReader::call_material_import_hooks ( struct Main * bmain ) const

Invoke USD hook add-ons to convert materials. This function should be called from the main thread and not from a background job.

Definition at line 690 of file usd_reader_stage.cc.

References blender::io::usd::call_material_import_hooks(), CLOG_WARN, blender::io::usd::USDMaterialReader::import_usd_preview(), blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::is_empty(), blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::items(), LOG, params_, reports(), settings_, stage_, and blender::io::usd::ImportSettings::usd_path_to_mat_for_hook.

◆ clear_readers()

void blender::io::usd::USDStageReader::clear_readers ( )

Clear all cached reader collections.

Definition at line 721 of file usd_reader_stage.cc.

References blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::clear(), blender::io::usd::decref(), dome_light_readers_, instancer_proto_readers_, blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::items(), proto_readers_, and readers_.

Referenced by collect_readers(), and ~USDStageReader().

◆ collect_readers()

void blender::io::usd::USDStageReader::collect_readers ( )

Definition at line 531 of file usd_reader_stage.cc.

References blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::add(), clear_readers(), collect_readers(), blender::io::usd::USDImportParams::import_defined_only, blender::Set< Key, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::is_empty(), params_, proto_readers_, readers_, stage_, blender::io::usd::USDImportParams::support_scene_instancing, and valid().

Referenced by collect_readers(), and blender::io::usd::import_startjob().

◆ create_proto_collections()

void blender::io::usd::USDStageReader::create_proto_collections	(	Main *	bmain,
		Collection *	parent_collection )

Create prototype collections for instancing by the USD instance readers.

Definition at line 758 of file usd_reader_stage.cc.

References blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::add(), BKE_collection_object_add(), BLI_assert, CLOG_WARN, COLLECTION_HIDE_RENDER, COLLECTION_HIDE_VIEWPORT, blender::io::usd::create_collection(), DEG_id_tag_update(), Collection::flag, Collection::id, ID_RECALC_HIERARCHY, instancer_proto_readers_, integer_digits_i(), blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::is_empty(), blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::items(), blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::keys(), LOG, blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup_default(), blender::io::usd::USDPointInstancerReader::proto_paths(), proto_readers_, readers_, blender::io::usd::USDPointInstancerReader::set_collection(), and blender::io::usd::set_instance_collection().

◆ create_reader()

USDPrimReader * blender::io::usd::USDStageReader::create_reader ( const pxr::UsdPrim & prim )

Definition at line 284 of file usd_reader_stage.cc.

References params_, settings_, and blender::io::usd::USDImportParams::support_scene_instancing.

Referenced by blender::io::usd::CacheReader_open_usd_object().

◆ create_reader_if_allowed()

USDPrimReader * blender::io::usd::USDStageReader::create_reader_if_allowed ( const pxr::UsdPrim & prim )

Definition at line 234 of file usd_reader_stage.cc.

References blender::io::usd::USDImportParams::import_cameras, blender::io::usd::USDImportParams::import_curves, blender::io::usd::USDImportParams::import_lights, blender::io::usd::USDImportParams::import_meshes, blender::io::usd::USDImportParams::import_points, blender::io::usd::USDImportParams::import_shapes, blender::io::usd::USDImportParams::import_skeletons, blender::io::usd::USDImportParams::import_volumes, params_, settings_, and blender::io::usd::USDImportParams::support_scene_instancing.

◆ dome_light_readers()

const blender::Vector< USDDomeLightReader * > & blender::io::usd::USDStageReader::dome_light_readers ( ) const

inline

Definition at line 131 of file usd_reader_stage.hh.

References dome_light_readers_.

Referenced by blender::io::usd::import_startjob().

◆ fake_users_for_unused_materials()

void blender::io::usd::USDStageReader::fake_users_for_unused_materials ( )

Definition at line 666 of file usd_reader_stage.cc.

References id_fake_user_set(), settings_, blender::io::usd::ImportSettings::usd_path_to_mat, and blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::values().

◆ find_material_import_hook_sources()

void blender::io::usd::USDStageReader::find_material_import_hook_sources ( )

Discover the USD materials that can be converted by material import hook add-ons.

Definition at line 677 of file usd_reader_stage.cc.

References blender::Set< Key, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::add(), blender::io::usd::have_material_import_hook(), blender::io::usd::ImportSettings::mat_import_hook_sources, params_, range, reports(), settings_, and stage_.

Referenced by blender::io::usd::import_startjob().

◆ import_all_materials()

void blender::io::usd::USDStageReader::import_all_materials ( struct Main * bmain )

Definition at line 615 of file usd_reader_stage.cc.

References blender::io::usd::USDMaterialReader::add_material(), blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::add_new(), BLI_assert, BLI_assert_msg, blender::io::usd::build_material_map(), blender::Set< Key, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::contains(), blender::io::usd::find_existing_material(), Material::id, blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::is_empty(), blender::io::usd::make_safe_name(), blender::io::usd::ImportSettings::mat_import_hook_sources, blender::io::usd::ImportSettings::mat_name_to_mat, material_paths_, blender::io::usd::USDImportParams::mtl_name_collision_mode, ID::name, params_, settings_, stage_, blender::io::usd::USD_MTL_NAME_COLLISION_MAKE_UNIQUE, blender::io::usd::ImportSettings::usd_path_to_mat, blender::io::usd::ImportSettings::usd_path_to_mat_for_hook, and valid().

Referenced by blender::io::usd::import_startjob().

◆ params()

const USDImportParams & blender::io::usd::USDStageReader::params ( ) const

inline

Definition at line 107 of file usd_reader_stage.hh.

References params_.

Referenced by USDStageReader().

◆ process_armature_modifiers()

void blender::io::usd::USDStageReader::process_armature_modifiers ( ) const

Complete setting up the armature modifiers that were created for skinned meshes by setting the modifier object on the corresponding modifier.

Definition at line 572 of file usd_reader_stage.cc.

References blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::add(), BKE_modifiers_findby_type(), BKE_reportf(), eModifierType_Armature, blender::io::usd::USDMeshReader::get_skeleton_path(), blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup_default(), ArmatureModifierData::object, blender::io::usd::USDPrimReader::object(), readers_, reports(), and RPT_WARNING.

Referenced by blender::io::usd::import_startjob().

◆ readers()

const blender::Vector< USDPrimReader * > & blender::io::usd::USDStageReader::readers ( ) const

inline

Definition at line 126 of file usd_reader_stage.hh.

References readers_.

Referenced by blender::io::usd::call_import_hooks(), and blender::io::usd::import_startjob().

◆ reports()

ReportList * blender::io::usd::USDStageReader::reports ( ) const

inline

Get the wmJobWorkerStatus-provided reports list pointer, to use with the BKE_report API.

Definition at line 118 of file usd_reader_stage.hh.

References params_, wmJobWorkerStatus::reports, and blender::io::usd::USDImportParams::worker_status.

Referenced by call_material_import_hooks(), find_material_import_hook_sources(), and process_armature_modifiers().

◆ settings()

const ImportSettings & blender::io::usd::USDStageReader::settings ( ) const

inline

Definition at line 112 of file usd_reader_stage.hh.

References settings_.

Referenced by blender::io::usd::call_import_hooks().

◆ sort_readers()

void blender::io::usd::USDStageReader::sort_readers ( )

Definition at line 748 of file usd_reader_stage.cc.

References b, blender::parallel_sort(), and readers_.

Referenced by blender::io::usd::import_startjob().

◆ stage()

pxr::UsdStageRefPtr blender::io::usd::USDStageReader::stage ( )

inline

Definition at line 103 of file usd_reader_stage.hh.

References stage_.

Referenced by blender::io::usd::CacheReader_open_usd_object(), blender::io::usd::call_import_hooks(), and USDStageReader().

◆ valid()

bool blender::io::usd::USDStageReader::valid ( ) const

Definition at line 221 of file usd_reader_stage.cc.

References stage_.

Referenced by blender::io::usd::CacheReader_open_usd_object(), collect_readers(), and import_all_materials().

Member Data Documentation

◆ dome_light_readers_

blender::Vector<USDDomeLightReader *> blender::io::usd::USDStageReader::dome_light_readers_

protected

Definition at line 45 of file usd_reader_stage.hh.

Referenced by clear_readers(), and dome_light_readers().

◆ instancer_proto_readers_

ProtoReaderMap blender::io::usd::USDStageReader::instancer_proto_readers_

protected

Definition at line 55 of file usd_reader_stage.hh.

Referenced by clear_readers(), and create_proto_collections().

◆ material_paths_

blender::Vector<pxr::SdfPath> blender::io::usd::USDStageReader::material_paths_

protected

Definition at line 49 of file usd_reader_stage.hh.

Referenced by import_all_materials().

◆ params_

USDImportParams blender::io::usd::USDStageReader::params_

protected

Definition at line 38 of file usd_reader_stage.hh.

Referenced by call_material_import_hooks(), collect_readers(), create_reader(), create_reader_if_allowed(), find_material_import_hook_sources(), import_all_materials(), params(), and reports().

◆ proto_readers_

ProtoReaderMap blender::io::usd::USDStageReader::proto_readers_

protected

Definition at line 52 of file usd_reader_stage.hh.

Referenced by clear_readers(), collect_readers(), and create_proto_collections().

◆ readers_

blender::Vector<USDPrimReader *> blender::io::usd::USDStageReader::readers_

protected

Definition at line 41 of file usd_reader_stage.hh.

Referenced by clear_readers(), collect_readers(), create_proto_collections(), process_armature_modifiers(), readers(), and sort_readers().

◆ settings_

ImportSettings blender::io::usd::USDStageReader::settings_

protected

Definition at line 39 of file usd_reader_stage.hh.

Referenced by call_material_import_hooks(), create_reader(), create_reader_if_allowed(), fake_users_for_unused_materials(), find_material_import_hook_sources(), import_all_materials(), settings(), and USDStageReader().

◆ stage_

pxr::UsdStageRefPtr blender::io::usd::USDStageReader::stage_

protected

Definition at line 37 of file usd_reader_stage.hh.

Referenced by call_material_import_hooks(), collect_readers(), find_material_import_hook_sources(), import_all_materials(), stage(), USDStageReader(), and valid().

The documentation for this class was generated from the following files:

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ USDStageReader()

◆ ~USDStageReader()

Member Function Documentation

◆ call_material_import_hooks()

◆ clear_readers()

◆ collect_readers()

◆ create_proto_collections()

◆ create_reader()

◆ create_reader_if_allowed()

◆ dome_light_readers()

◆ fake_users_for_unused_materials()

◆ find_material_import_hook_sources()

◆ import_all_materials()

◆ params()

◆ process_armature_modifiers()

◆ readers()

◆ reports()

◆ settings()

◆ sort_readers()

◆ stage()

◆ valid()

Member Data Documentation

◆ dome_light_readers_

◆ instancer_proto_readers_

◆ material_paths_

◆ params_

◆ proto_readers_

◆ readers_

◆ settings_

◆ stage_