Navigation
API > API/Plugins > API/Plugins/IKRigEditor > API/Plugins/IKRigEditor/UIKRetargetBatchOperation
Description
Convenience function to run a batch animation retarget from Blueprint / Python. This function will duplicate a list of assets 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.
Return: list of new animation files created.
| Name | DuplicateAndRetarget |
| Type | function |
| Header File | /Engine/Plugins/Animation/IKRig/Source/IKRigEditor/Public/RetargetEditor/IKRetargetBatchOperation.h |
| Include Path | #include "RetargetEditor/IKRetargetBatchOperation.h" |
| Source | /Engine/Plugins/Animation/IKRig/Source/IKRigEditor/Private/RetargetEditor/IKRetargetBatchOperation.cpp |
UFUNCTION (BlueprintCallable, Category=IKBatchRetarget)
static TArray < FAssetData > DuplicateAndRetarget
(
const TArray < FAssetData > & AssetsToRetarget,
USkeletalMesh * SourceMesh,
USkeletalMesh * TargetMesh,
UIKRetargeter * IKRetargetAsset,
const FString & Search,
const FString & Replace,
const FString & Prefix,
const FString & Suffix,
const bool bIncludeReferencedAssets,
const bool bOverwriteExistingFiles
)
Parameters
| Name | Remarks |
|---|---|
| AssetsToRetarget | A list of animation assets to retarget (sequences, blendspaces or montages) |
| SourceMesh | The skeletal mesh with desired proportions to playback the assets to retarget |
| TargetMesh | The skeletal mesh to retarget the animation onto. |
| IKRetargetAsset | The IK Retargeter asset with IK Rigs appropriate for the source and target skeletal mesh |
| Search | A string to search for in the file name (replaced with "Replace" string) |
| Replace | A string to replace with in the file name |
| Suffix | A string to add at the end of the new file name |
| Prefix | A string to add to the start of the new file name |
| bIncludeReferencedAssets | Whether to retarget animation assets referenced by the AssetsToRetarget |
| bOverwriteExistingFiles | Whether to overwrite any existing output files with the same name, or create new files with a unique name |