Navigation
API > API/Plugins > API/Plugins/IKRig
| Name | FAnimNode_RetargetPoseFromMesh |
| Type | struct |
| Header File | /Engine/Plugins/Animation/IKRig/Source/IKRig/Public/AnimNodes/AnimNode_RetargetPoseFromMesh.h |
| Include Path | #include "AnimNodes/AnimNode_RetargetPoseFromMesh.h" |
Syntax
USTRUCT (BlueprintInternalUseOnly)
struct FAnimNode_RetargetPoseFromMesh : public FAnimNode_Base
Inheritance Hierarchy
- FAnimNode_Base → FAnimNode_RetargetPoseFromMesh
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bSuppressWarnings | bool | Toggle whether to print warnings about missing or incorrectly configured retarget configurations. | AnimNodes/AnimNode_RetargetPoseFromMesh.h |
|
| CustomRetargetProfile | FRetargetProfile | Connect a custom retarget profile to modify the retargeter's settings at runtime. | AnimNodes/AnimNode_RetargetPoseFromMesh.h |
|
| IKRetargeterAsset | TObjectPtr< UIKRetargeter > | Retarget asset to use. Must define a Source and Target IK Rig compatible with the SourceMeshComponent and current anim instance. | AnimNodes/AnimNode_RetargetPoseFromMesh.h |
|
| LODThreshold | int32 | Max LOD that this node is allowed to run. | AnimNodes/AnimNode_RetargetPoseFromMesh.h |
|
| LODThresholdForIK | int32 | Max LOD that IK is allowed to run. | AnimNodes/AnimNode_RetargetPoseFromMesh.h |
|
| RetargetFrom | ERetargetSourceMode | Specify where to get the source pose to retarget from. Can be from the anim graph, or a different skeletal mesh component. | AnimNodes/AnimNode_RetargetPoseFromMesh.h |
|
| Source | FPoseLink | Input pose to be modified by the retargeter when using "Source Pose Pin" mode as the Input Pose Mode. | AnimNodes/AnimNode_RetargetPoseFromMesh.h |
|
| SourceMeshComponent | TWeakObjectPtr< USkeletalMeshComponent > | The Skeletal Mesh Component to retarget animation from. Assumed to be animated and tick BEFORE this anim instance. | AnimNodes/AnimNode_RetargetPoseFromMesh.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AverageExecutionTime | double | AnimNodes/AnimNode_RetargetPoseFromMesh.h | ||
| bSearchedForParentComponent | bool | Used to determine when to look for a parent component (prevents constantly searching component hierarchy) | AnimNodes/AnimNode_RetargetPoseFromMesh.h | |
| CompactToTargetBoneIndexMap | TArray< TPair< int32, int32 > > | Mapping from required compact bone indices to target mesh bones expected by the retargeter | AnimNodes/AnimNode_RetargetPoseFromMesh.h | |
| DeltaTime | float | The delta time this tick | AnimNodes/AnimNode_RetargetPoseFromMesh.h | |
| InputLocalTransforms | TArray< FTransform > | Reusable buffer when retargeting a pose from the anim graph pose pin | AnimNodes/AnimNode_RetargetPoseFromMesh.h | |
| PoseToRetargetFromComponentSpace | TArray< FTransform > | Cached transforms, copied on the game thread | AnimNodes/AnimNode_RetargetPoseFromMesh.h | |
| Processor | FIKRetargetProcessor | The runtime processor used to run the retarget and generate new poses | AnimNodes/AnimNode_RetargetPoseFromMesh.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool EnsureProcessorIsInitialized
(
const USkeletalMeshComponent* TargetMeshComponent |
Returns true if processor is setup and ready to go, false otherwise | AnimNodes/AnimNode_RetargetPoseFromMesh.h | |
double GetAverageExecutionTime() |
AnimNodes/AnimNode_RetargetPoseFromMesh.h | ||
FIKRetargetProcessor * GetRetargetProcessor() |
Access to the runtime processor | AnimNodes/AnimNode_RetargetPoseFromMesh.h | |
void PostSerialize
(
const FArchive& Ar |
AnimNodes/AnimNode_RetargetPoseFromMesh.h | ||
bool Serialize
(
FArchive& Ar |
Load deprecated properties | AnimNodes/AnimNode_RetargetPoseFromMesh.h |
Overridden from FAnimNode_Base
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CacheBones_AnyThread
(
const FAnimationCacheBonesContext& Context |
AnimNodes/AnimNode_RetargetPoseFromMesh.h | ||
virtual void Evaluate_AnyThread
(
FPoseContext& Output |
AnimNodes/AnimNode_RetargetPoseFromMesh.h | ||
virtual int32 GetLODThreshold() |
AnimNodes/AnimNode_RetargetPoseFromMesh.h | ||
virtual bool HasPreUpdate() |
AnimNodes/AnimNode_RetargetPoseFromMesh.h | ||
virtual void Initialize_AnyThread
(
const FAnimationInitializeContext& Context |
AnimNodes/AnimNode_RetargetPoseFromMesh.h | ||
virtual void PreUpdate
(
const UAnimInstance* InAnimInstance |
AnimNodes/AnimNode_RetargetPoseFromMesh.h | ||
virtual void Update_AnyThread
(
const FAnimationUpdateContext& Context |
AnimNodes/AnimNode_RetargetPoseFromMesh.h |
Deprecated Variables
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bUseAttachedParent_DEPRECATED | bool | AnimNodes/AnimNode_RetargetPoseFromMesh.h |