Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > AnimGraphRuntime > BoneControllers > FAnimNode_HandIKRetargeting

Light Theme

Dark Theme

FAnimNode_HandIKRetargeting

Node to handle re-targeting of Hand IK bone chain.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FAnimNode_Base

FAnimNode_SkeletalControlBase

FAnimNode_HandIKRetargeting

References

Module	AnimGraphRuntime
Header	/Engine/Source/Runtime/AnimGraphRuntime/Public/BoneControllers/AnimNode_HandIKRetargeting.h
Include	#include "BoneControllers/AnimNode_HandIKRetargeting.h"

Syntax

struct FAnimNode_HandIKRetargeting : public FAnimNode_SkeletalControlBase

Remarks

Node to handle re-targeting of Hand IK bone chain. It looks at position in Mesh Space of Left and Right IK bones, and moves Left and Right IK bones to those. based on HandFKWeight. (0 = favor left hand, 1 = favor right hand, 0.5 = equal weight). This is used so characters of different proportions can handle the same props.

Variables

	Name	Description
float	HandFKWeight	Which hand to favor. 0.5 is equal weight for both, 1 = right hand, 0 = left hand.
TArray< FBoneRe...	IKBonesToMove	IK Bones to move.
FBoneReference	LeftHandFK	Bone for Left Hand FK
FBoneReference	LeftHandIK	Bone for Left Hand IK
FBoneReference	RightHandFK	Bone for Right Hand FK
FBoneReference	RightHandIK	Bone for Right Hand IK

Constructors

	Name	Description
	FAnimNode_HandIKRetargeting()

Overridden from FAnimNode_SkeletalControlBase

		Name	Description
	void	EvaluateSkeletalControl_AnyThread ( FComponentSpacePoseContext& Output, TArray< FBoneTransform >& OutBoneT... )	Evaluate the new component-space transforms for the affected bones.
	bool	IsValidToEvaluate ( const USkeleton* Skeleton, const FBoneContainer& RequiredBone... )	Return true if it is valid to Evaluate

Overridden from FAnimNode_Base

		Name	Description
	void	GatherDebugData ( FNodeDebugData& DebugData )	Called to gather on-screen debug data. This is called on the game thread.