Navigation
API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/FAnimationRuntime
Description
Get the translational retargeting mode for a given bone on the target skeleton when sampling a given source animation. If bUseSourceRetargetModes is set to true, and SourceSkeletonBoneIndex is INDEX_NONE, then the target bone and target skeleton are used instead. If bUseSourceRetargetModes is set to false, the SourceSkeleton and SourceSkeletonBoneIndex values are ignored and we get the retarget mode directly from the target skeleton using the target bone index.
| Name | GetBoneTranslationRetargetingMode |
| Type | function |
| Header File | /Engine/Source/Runtime/Engine/Public/AnimationRuntime.h |
| Include Path | #include "AnimationRuntime.h" |
| Source | /Engine/Source/Runtime/Engine/Private/Animation/AnimationRuntime.cpp |
static EBoneTranslationRetargetingMode::Type GetBoneTranslationRetargetingMode
(
const bool bUseSourceRetargetModes,
const int32 SourceSkeletonBoneIndex,
const int32 TargetSkeletonBoneIndex,
const USkeleton * SourceSkeleton,
const USkeleton * TargetSkeleton,
const bool bDisableRetargeting
)
The retargeting mode for the specific bone.
Parameters
| Name | Remarks |
|---|---|
| bUseSourceRetargetModes | Set to true when you wish to extract the retarget mode from the source skeleton instead of the target skeleton. |
| SourceSkeletonBoneIndex | The skeleton bone index of the bone on the source skeleton to get the retarget mode from. |
| TargetSkeletonBoneIndex | The target bone index of the bone on the target skeleton to get the retarget mode from. |
| SourceSkeleton | A pointer to the skeleton of the source (the animation's skeleton for example). |
| TargetSkeleton | A pointer to the target skeleton, which is the skeleton to apply transforms to. |
| bDisableRetargeting | Is translational retargeting disabled? |