unreal.IKRetargetBatchOperation

class unreal.IKRetargetBatchOperation(outer: Object | None = None, name: Name | str = 'None')

Bases: Object

Encapsulate ability to batch duplicate and retarget a set of animation assets

C++ Source:

  • Plugin: IKRig

  • Module: IKRigEditor

  • File: IKRetargetBatchOperation.h

classmethod duplicate_and_retarget(assets_to_retarget, source_mesh, target_mesh, ik_retarget_asset, search='', replace='', prefix='', suffix='', target_path='', use_source_path=False, include_referenced_assets=True, overwrite_existing_files=False) → Array[AssetData]

deprecated: Use RunBatchRetarget instead. It uses a struct for better future-proofing and cleaner Blueprint graphs. deprecated: This function is deprecated. Please use RunBatchRetarget which takes a FIKRetargetBatchOperationInputs struct.

Parameters:
Return type:

Array[AssetData]

classmethod run_batch_retarget(inputs) → Array[AssetData]

Convenience function to run a batch animation retarget from Blueprint / Python. This function will duplicate a list of AssetsToRetarget and use the supplied IK Retargeter to retarget the animation from the source to the target using the settings in the provided IK Retargeter asset.

Parameters:

inputs (IKRetargetBatchOperationInputs) – a struct with all the inputs required to run a batch process

Returns:

a list of new animation files created

Return type:

Array[AssetData]