Navigation
API > API/Plugins > API/Plugins/IKRig
Description
Synchronizes a custom chain settings array with the chains in an IK Rig asset.
Convenience function for retarget ops that need to keep an array of custom chain settings in sync with the chains defined in an IK Rig asset.
To use this function, your type T must:
Implement:
- FName GetName()
- void SetName(FName InChainName)
Provide a constructor that accepts the chain name.
This function will early-return if no valid chains are found. It does NOT clear the array, allowing users to reassign a different rig and preserve compatible settings.
| Name | IKRetargetOpUtils::SynchronizeChainSettingsWithIKRig |
| Type | function |
| Header File | /Engine/Plugins/Animation/IKRig/Source/IKRig/Public/Retargeter/IKRetargetOpUtils.h |
| Include Path | #include "Retargeter/IKRetargetOpUtils.h" |
namespace IKRetargetOpUtils
{
template<typename T>
void IKRetargetOpUtils::SynchronizeChainSettingsWithIKRig
(
TArray < T > & InOutChainSettings,
const FIKRetargetOpBase * InRetargetOp,
const bool bSkipUnmappedChains,
const bool bSkipNonIKChains
)
}
Parameters
| Name | Remarks |
|---|---|
| T | Custom struct type representing chain settings. |
| InOutChainSettings | Array of chain settings to synchronize. |
| InRetargetOp | Retarget operation providing access to the IK Rig. |
| bSkipUnmappedChains | If true, unmapped chains are ignored. |
| bSkipNonIKChains | If true, chains without IK goals are ignored. |