#include <usd_reader_prim.hh>

Inherited by blender::io::usd::USDXformReader.

Public Member Functions
	USDPrimReader (const pxr::UsdPrim &prim, const USDImportParams &import_params, const ImportSettings &settings)

virtual	~USDPrimReader ()

const pxr::UsdPrim &	prim () const

virtual bool	valid () const

virtual void	create_object (Main *bmain, double motionSampleTime)=0

virtual void	read_object_data (Main *, double)

Object *	object () const

void	object (Object *ob)

USDPrimReader *	parent () const

void	parent (USDPrimReader *parent)

ReportList *	reports () const

int	refcount () const

void	incref ()

void	decref ()

const std::string &	name () const

const std::string &	prim_path () const

void	set_is_in_instancer_proto (bool flag)

bool	is_in_instancer_proto () const

bool	is_in_proto () const

Protected Member Functions
void	set_props (bool merge_with_parent=false, pxr::UsdTimeCode motionSampleTime=pxr::UsdTimeCode::Default())

Protected Attributes
std::string	name_

std::string	prim_path_

Object *	object_

pxr::UsdPrim	prim_

const USDImportParams &	import_params_

USDPrimReader *	parent_reader_

const ImportSettings *	settings_

int	refcount_

bool	is_in_instancer_proto_

Detailed Description

Definition at line 87 of file usd_reader_prim.hh.

Constructor & Destructor Documentation

◆ USDPrimReader()

blender::io::usd::USDPrimReader::USDPrimReader	(	const pxr::UsdPrim &	prim,
		const USDImportParams &	import_params,
		const ImportSettings &	settings )

Definition at line 55 of file usd_reader_prim.cc.

◆ ~USDPrimReader()

blender::io::usd::USDPrimReader::~USDPrimReader ( )

virtualdefault

Member Function Documentation

◆ create_object()

virtual void blender::io::usd::USDPrimReader::create_object	(	Main *	bmain,
		double	motionSampleTime )

pure virtual

Implemented in blender::io::usd::USDCameraReader, blender::io::usd::USDCurvesReader, blender::io::usd::USDInstanceReader, blender::io::usd::USDLightReader, blender::io::usd::USDMeshReader, blender::io::usd::USDNurbsReader, blender::io::usd::USDPointInstancerReader, blender::io::usd::USDPointsReader, blender::io::usd::USDShapeReader, blender::io::usd::USDSkeletonReader, blender::io::usd::USDVolumeReader, and blender::io::usd::USDXformReader.

◆ decref()

void blender::io::usd::USDPrimReader::decref ( )

Definition at line 102 of file usd_reader_prim.cc.

References BLI_assert, and refcount_.

Referenced by blender::io::usd::decref(), and blender::io::usd::USD_CacheReader_free().

◆ incref()

void blender::io::usd::USDPrimReader::incref ( )

Definition at line 97 of file usd_reader_prim.cc.

References refcount_.

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

◆ is_in_instancer_proto()

bool blender::io::usd::USDPrimReader::is_in_instancer_proto ( ) const

inline

Definition at line 158 of file usd_reader_prim.hh.

References is_in_instancer_proto_.

◆ is_in_proto()

bool blender::io::usd::USDPrimReader::is_in_proto ( ) const

Definition at line 108 of file usd_reader_prim.cc.

References is_in_instancer_proto_, and prim_.

Referenced by blender::io::usd::USDXformReader::is_root_xform_prim().

◆ name()

const std::string & blender::io::usd::USDPrimReader::name ( ) const

inline

Definition at line 144 of file usd_reader_prim.hh.

References name_.

◆ object() [1/2]

Object * blender::io::usd::USDPrimReader::object ( ) const

Definition at line 77 of file usd_reader_prim.cc.

References object_.

Referenced by blender::io::usd::CacheReader_open_usd_object(), blender::io::usd::import_startjob(), blender::io::usd::USDStageReader::process_armature_modifiers(), and blender::io::usd::USD_get_transform().

◆ object() [2/2]

void blender::io::usd::USDPrimReader::object ( Object * ob )

Definition at line 82 of file usd_reader_prim.cc.

References object_.

◆ parent() [1/2]

USDPrimReader * blender::io::usd::USDPrimReader::parent ( ) const

inline

Definition at line 116 of file usd_reader_prim.hh.

References parent_reader_.

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

◆ parent() [2/2]

void blender::io::usd::USDPrimReader::parent ( USDPrimReader * parent )

inline

Definition at line 120 of file usd_reader_prim.hh.

References parent(), and parent_reader_.

◆ prim()

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

Definition at line 72 of file usd_reader_prim.cc.

References prim_.

Referenced by blender::io::usd::USDStageReader::create_proto_collections(), blender::io::usd::get_usd_reader(), and blender::io::usd::merge_with_parent().

◆ prim_path()

const std::string & blender::io::usd::USDPrimReader::prim_path ( ) const

inline

Definition at line 148 of file usd_reader_prim.hh.

References prim_path_.

Referenced by blender::io::usd::USDXformReader::read_object_data(), and blender::io::usd::set_instance_collection().

◆ read_object_data()

virtual void blender::io::usd::USDPrimReader::read_object_data	(	Main *	,
		double	)

inlinevirtual

Reimplemented in blender::io::usd::USDCameraReader, blender::io::usd::USDCurvesReader, blender::io::usd::USDLightReader, blender::io::usd::USDMeshReader, blender::io::usd::USDNurbsReader, blender::io::usd::USDPointInstancerReader, blender::io::usd::USDPointsReader, blender::io::usd::USDShapeReader, blender::io::usd::USDSkeletonReader, blender::io::usd::USDVolumeReader, and blender::io::usd::USDXformReader.

Definition at line 111 of file usd_reader_prim.hh.

◆ refcount()

int blender::io::usd::USDPrimReader::refcount ( ) const

Definition at line 92 of file usd_reader_prim.cc.

References refcount_.

Referenced by blender::io::usd::decref(), and blender::io::usd::USD_CacheReader_free().

◆ reports()

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

inline

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

Definition at line 126 of file usd_reader_prim.hh.

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

Referenced by blender::io::usd::USDShapeReader::is_time_varying(), blender::io::usd::USDMeshReader::read_object_data(), and blender::io::usd::USDSkeletonReader::read_object_data().

◆ set_is_in_instancer_proto()

void blender::io::usd::USDPrimReader::set_is_in_instancer_proto ( bool flag )

inline

Definition at line 153 of file usd_reader_prim.hh.

References flag, and is_in_instancer_proto_.

◆ set_props()

void blender::io::usd::USDPrimReader::set_props	(	bool	merge_with_parent = false,
		pxr::UsdTimeCode	motionSampleTime = pxr::UsdTimeCode::Default() )

protected

Convert custom attributes on the encapsulated USD prim (or on its parent) to custom properties on the generated object and/or data. This function assumes create_object() and read_object_data() have been called.

If the generated object has instantiated data, it's assumed that the data represents the USD prim, and the prim properties will be set on the data ID. If the object data is null (which would be the case when a USD Xform is converted to an Empty object), then the prim properties will be set on the object ID. Finally, a true value for the 'merge_with_parent' argument indicates that the object represents a USD Xform and its child prim that were merged on import, and the properties of the prim's parent will be set on the object ID.

Parameters

merge_with_parent	If true, set the properties of the prim's parent on the object ID
motionSampleTime	The time code for sampling the USD attributes.

Definition at line 21 of file usd_reader_prim.cc.

References blender::io::usd::USDImportParams::attr_import_mode, Object::data, Object::id, import_params_, blender::io::usd::merge_with_parent(), object_, prim_, blender::io::usd::set_id_props_from_prim(), and blender::io::usd::USD_ATTR_IMPORT_NONE.

Referenced by blender::io::usd::USDXformReader::read_object_data().

◆ valid()

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

virtual

Reimplemented in blender::io::usd::USDCurvesReader, blender::io::usd::USDInstanceReader, blender::io::usd::USDMeshReader, blender::io::usd::USDNurbsReader, blender::io::usd::USDPointInstancerReader, blender::io::usd::USDPointsReader, blender::io::usd::USDSkeletonReader, and blender::io::usd::USDVolumeReader.

Definition at line 87 of file usd_reader_prim.cc.

References prim_.

Referenced by blender::io::usd::USDSkeletonReader::valid().

Member Data Documentation

◆ import_params_

const USDImportParams& blender::io::usd::USDPrimReader::import_params_

protected

Definition at line 94 of file usd_reader_prim.hh.

Referenced by blender::io::usd::USDGeomReader::add_cache_modifier(), blender::io::usd::USDLightReader::read_object_data(), blender::io::usd::USDMeshReader::read_object_data(), blender::io::usd::USDPointsReader::read_object_data(), blender::io::usd::USDShapeReader::read_object_data(), blender::io::usd::USDXformReader::read_object_data(), reports(), and set_props().

◆ is_in_instancer_proto_

bool blender::io::usd::USDPrimReader::is_in_instancer_proto_

protected

Definition at line 98 of file usd_reader_prim.hh.

Referenced by is_in_instancer_proto(), is_in_proto(), and set_is_in_instancer_proto().

◆ name_

std::string blender::io::usd::USDPrimReader::name_

protected

Definition at line 90 of file usd_reader_prim.hh.

◆ object_

Object* blender::io::usd::USDPrimReader::object_

protected

Definition at line 92 of file usd_reader_prim.hh.

◆ parent_reader_

USDPrimReader* blender::io::usd::USDPrimReader::parent_reader_

protected

Definition at line 95 of file usd_reader_prim.hh.

Referenced by parent(), and parent().

◆ prim_

pxr::UsdPrim blender::io::usd::USDPrimReader::prim_

protected

Definition at line 93 of file usd_reader_prim.hh.

◆ prim_path_

std::string blender::io::usd::USDPrimReader::prim_path_

protected

Definition at line 91 of file usd_reader_prim.hh.

Referenced by prim_path(), and blender::io::usd::USDXformReader::read_object_data().

◆ refcount_

int blender::io::usd::USDPrimReader::refcount_

protected

Definition at line 97 of file usd_reader_prim.hh.

Referenced by decref(), incref(), and refcount().

◆ settings_

const ImportSettings* blender::io::usd::USDPrimReader::settings_

protected

Definition at line 96 of file usd_reader_prim.hh.

Referenced by blender::io::usd::USDGeomReader::add_cache_modifier(), blender::io::usd::USDXformReader::read_matrix(), blender::io::usd::USDCameraReader::read_object_data(), and blender::io::usd::USDXformReader::read_object_data().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ USDPrimReader()

◆ ~USDPrimReader()

Member Function Documentation

◆ create_object()

◆ decref()

◆ incref()

◆ is_in_instancer_proto()

◆ is_in_proto()

◆ name()

◆ object() [1/2]

◆ object() [2/2]

◆ parent() [1/2]

◆ parent() [2/2]

◆ prim()

◆ prim_path()

◆ read_object_data()

◆ refcount()

◆ reports()

◆ set_is_in_instancer_proto()

◆ set_props()

◆ valid()

Member Data Documentation

◆ import_params_

◆ is_in_instancer_proto_

◆ name_

◆ object_

◆ parent_reader_

◆ prim_

◆ prim_path_

◆ refcount_

◆ settings_