#include <usd_writer_abstract.hh>

Inherits blender::io::AbstractHierarchyWriter.

Inherited by blender::io::usd::USDArmatureWriter, blender::io::usd::USDCameraWriter, blender::io::usd::USDCurvesWriter, blender::io::usd::USDGenericMeshWriter, blender::io::usd::USDHairWriter, blender::io::usd::USDLightWriter, blender::io::usd::USDPointsWriter, blender::io::usd::USDTransformWriter, and blender::io::usd::USDVolumeWriter.

Public Member Functions
	USDAbstractWriter (const USDExporterContext &usd_export_context)

virtual void	write (HierarchyContext &context) override

virtual bool	is_supported (const HierarchyContext *context) const

const pxr::SdfPath &	usd_path () const

ReportList *	reports () const

Public Member Functions inherited from blender::io::AbstractHierarchyWriter
virtual	~AbstractHierarchyWriter ()=default

Protected Member Functions
virtual void	do_write (HierarchyContext &context)=0

std::string	get_export_file_path () const

pxr::UsdTimeCode	get_export_time_code () const

pxr::SdfPath	get_material_library_path () const

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 timecode, const pxr::UsdGeomImageable &usd_geometry)

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

virtual void	author_extent (const pxr::UsdTimeCode timecode, pxr::UsdGeomBoundable &prim)

Protected Member Functions inherited from blender::io::AbstractHierarchyWriter
virtual bool	check_is_animated (const HierarchyContext &context) const

Protected Attributes
const USDExporterContext	usd_export_context_

pxr::UsdUtilsSparseValueWriter	usd_value_writer_

bool	frame_has_been_written_

bool	is_animated_

Additional Inherited Members
Static Protected Member Functions inherited from blender::io::AbstractHierarchyWriter
static bool	check_has_physics (const HierarchyContext &context)

static bool	check_has_deforming_physics (const HierarchyContext &context)

Detailed Description

Definition at line 29 of file usd_writer_abstract.hh.

Constructor & Destructor Documentation

◆ USDAbstractWriter()

blender::io::usd::USDAbstractWriter::USDAbstractWriter ( const USDExporterContext & usd_export_context )

Definition at line 150 of file usd_writer_abstract.cc.

Member Function Documentation

◆ author_extent()

void blender::io::usd::USDAbstractWriter::author_extent	(	const pxr::UsdTimeCode	timecode,
		pxr::UsdGeomBoundable &	prim )

protectedvirtual

Compute the bounds for a boundable prim, and author the result as the extent attribute.

Although this method works for any boundable prim, it is preferred to use Blender's own cached bounds when possible.

This method does not author the extentsHint attribute, which is also important to provide. Whereas the extent attribute can only be authored on prims inheriting from UsdGeomBoundable, an extentsHint can be provided on any prim, including scopes. This extentsHint should be authored on every prim in a hierarchy being exported.

Note that this hint is only useful when importing or inspecting layers, and should not be taken into account when computing extents during export.

TODO: also provide method for authoring extentsHint on every prim in a hierarchy.

Definition at line 408 of file usd_writer_abstract.cc.

References BKE_reportf(), reports(), and RPT_WARNING.

Referenced by blender::io::usd::USDHairWriter::do_write().

◆ do_write()

virtual void blender::io::usd::USDAbstractWriter::do_write ( HierarchyContext & context )

protectedpure virtual

Implemented in blender::io::usd::USDArmatureWriter, blender::io::usd::USDCameraWriter, blender::io::usd::USDCurvesWriter, blender::io::usd::USDGenericMeshWriter, blender::io::usd::USDHairWriter, blender::io::usd::USDLightWriter, blender::io::usd::USDMeshWriter, blender::io::usd::USDPointsWriter, blender::io::usd::USDTransformWriter, and blender::io::usd::USDVolumeWriter.

Referenced by write().

◆ ensure_usd_material()

pxr::UsdShadeMaterial blender::io::usd::USDAbstractWriter::ensure_usd_material	(	const HierarchyContext &	context,
		Material *	material ) const

protected

Definition at line 211 of file usd_writer_abstract.cc.

References blender::io::usd::USDExportParams::allow_unicode, blender::io::usd::create_usd_material(), blender::io::usd::USDExporterContext::export_params, get_export_time_code(), get_material_library_path(), get_mesh_active_uvlayer_name(), blender::io::usd::make_safe_name(), reports(), blender::io::usd::USDExporterContext::stage, stage, usd_export_context_, usd_path(), and write_id_properties().

◆ get_export_file_path()

std::string blender::io::usd::USDAbstractWriter::get_export_file_path ( ) const

protected

Definition at line 160 of file usd_writer_abstract.cc.

References blender::io::usd::USDExporterContext::export_file_path, and usd_export_context_.

◆ get_export_time_code()

pxr::UsdTimeCode blender::io::usd::USDAbstractWriter::get_export_time_code ( ) const

protected

Definition at line 165 of file usd_writer_abstract.cc.

References BLI_assert, blender::io::usd::USDExporterContext::get_time_code, is_animated_, and usd_export_context_.

◆ get_material_library_path()

pxr::SdfPath blender::io::usd::USDAbstractWriter::get_material_library_path ( ) const

protected

Definition at line 198 of file usd_writer_abstract.cc.

References blender::io::usd::USDExporterContext::export_params, blender::io::usd::USDExportParams::root_prim_path, and usd_export_context_.

Referenced by ensure_usd_material().

◆ is_supported()

bool blender::io::usd::USDAbstractWriter::is_supported ( const HierarchyContext * context ) const

virtual

Returns true if the data to be written is actually supported. This would, for example, allow a hypothetical camera writer accept a perspective camera but reject an orthogonal one.

Returning false from a transform writer will prevent the object and all its descendants from being exported. Returning false from a data writer (object data, hair, or particles) will only prevent that data from being written (and thus cause the object to be exported as an Empty).

Reimplemented in blender::io::usd::USDCameraWriter, blender::io::usd::USDGenericMeshWriter, blender::io::usd::USDLightWriter, and blender::io::usd::USDMetaballWriter.

Definition at line 155 of file usd_writer_abstract.cc.

Referenced by blender::io::usd::USDHierarchyIterator::create_data_writer().

◆ mark_as_instance()

bool blender::io::usd::USDAbstractWriter::mark_as_instance	(	const HierarchyContext &	context,
		const pxr::UsdPrim &	prim )

protectedvirtual

Turn prim into an instance referencing context.original_export_path. Return true when the instancing was successful, false otherwise.

Reference the original data instead of writing a copy.

Definition at line 252 of file usd_writer_abstract.cc.

References BLI_assert, BLI_assert_msg, CLOG_ERROR, CLOG_WARN, blender::io::usd::USDExporterContext::export_params, LOG, blender::io::usd::USDExportParams::root_prim_path, blender::io::usd::USDExporterContext::stage, and usd_export_context_.

◆ reports()

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

inline

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

Definition at line 56 of file usd_writer_abstract.hh.

References blender::io::usd::USDExporterContext::export_params, wmJobWorkerStatus::reports, usd_export_context_, and blender::io::usd::USDExportParams::worker_status.

Referenced by author_extent(), blender::io::usd::USDVolumeWriter::do_write(), and ensure_usd_material().

◆ usd_path()

const pxr::SdfPath & blender::io::usd::USDAbstractWriter::usd_path ( ) const

Definition at line 193 of file usd_writer_abstract.cc.

References usd_export_context_, and blender::io::usd::USDExporterContext::usd_path.

Referenced by blender::io::usd::USDHierarchyIterator::create_data_writer(), blender::io::usd::USDLightWriter::do_write(), blender::io::usd::USDPointsWriter::do_write(), and ensure_usd_material().

◆ write()

void blender::io::usd::USDAbstractWriter::write ( HierarchyContext & context )

overridevirtual

Implements blender::io::AbstractHierarchyWriter.

Definition at line 177 of file usd_writer_abstract.cc.

References blender::io::AbstractHierarchyWriter::check_is_animated(), do_write(), blender::io::usd::USDExportParams::export_animation, blender::io::usd::USDExporterContext::export_params, frame_has_been_written_, is_animated_, and usd_export_context_.

◆ write_id_properties()

void blender::io::usd::USDAbstractWriter::write_id_properties	(	const pxr::UsdPrim &	prim,
		const ID &	id,
		pxr::UsdTimeCode	timecode = pxr::UsdTimeCode::Default() ) const

protected

Definition at line 289 of file usd_writer_abstract.cc.

References blender::io::usd::USDExportParams::author_blender_name, usdtokens::blender_ns(), blender::io::usd::USDExportParams::export_custom_properties, blender::io::usd::USDExporterContext::export_params, GS, ID_OB, usd_export_context_, and write_user_properties().

Referenced by blender::io::usd::USDCameraWriter::do_write(), blender::io::usd::USDGenericMeshWriter::do_write(), blender::io::usd::USDHairWriter::do_write(), blender::io::usd::USDLightWriter::do_write(), blender::io::usd::USDTransformWriter::do_write(), and ensure_usd_material().

◆ write_user_properties()

void blender::io::usd::USDAbstractWriter::write_user_properties	(	const pxr::UsdPrim &	prim,
		IDProperty *	properties,
		pxr::UsdTimeCode	timecode = pxr::UsdTimeCode::Default() ) const

protected

◆ write_visibility()

void blender::io::usd::USDAbstractWriter::write_visibility	(	const HierarchyContext &	context,
		const pxr::UsdTimeCode	timecode,
		const pxr::UsdGeomImageable &	usd_geometry )

protected

Definition at line 238 of file usd_writer_abstract.cc.

References blender::io::usd::USDExportParams::evaluation_mode, blender::io::usd::USDExporterContext::export_params, usd_export_context_, and usd_value_writer_.

Member Data Documentation

◆ frame_has_been_written_

bool blender::io::usd::USDAbstractWriter::frame_has_been_written_

protected

Definition at line 34 of file usd_writer_abstract.hh.

Referenced by blender::io::usd::USDArmatureWriter::do_write(), blender::io::usd::USDMeshWriter::do_write(), and write().

◆ is_animated_

bool blender::io::usd::USDAbstractWriter::is_animated_

protected

Definition at line 35 of file usd_writer_abstract.hh.

Referenced by blender::io::usd::USDTransformWriter::do_write(), get_export_time_code(), and write().

◆ usd_export_context_

const USDExporterContext blender::io::usd::USDAbstractWriter::usd_export_context_

protected

Definition at line 31 of file usd_writer_abstract.hh.

◆ usd_value_writer_

pxr::UsdUtilsSparseValueWriter blender::io::usd::USDAbstractWriter::usd_value_writer_

protected

Definition at line 32 of file usd_writer_abstract.hh.

Referenced by blender::io::usd::USDHairWriter::do_write(), blender::io::usd::USDPointsWriter::do_write(), blender::io::usd::USDTransformWriter::set_xform_ops(), and write_visibility().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ USDAbstractWriter()

Member Function Documentation

◆ author_extent()

◆ do_write()

◆ ensure_usd_material()

◆ get_export_file_path()

◆ get_export_time_code()

◆ get_material_library_path()

◆ is_supported()

◆ mark_as_instance()

◆ reports()

◆ usd_path()

◆ write()

◆ write_id_properties()

◆ write_user_properties()

◆ write_visibility()

Member Data Documentation

◆ frame_has_been_written_

◆ is_animated_

◆ usd_export_context_

◆ usd_value_writer_